Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Audit Compliance: Logs Bridge API Artifact Naming #5681

Closed
MrAlias opened this issue Aug 7, 2024 · 2 comments · Fixed by #5837
Closed

Audit Compliance: Logs Bridge API Artifact Naming #5681

MrAlias opened this issue Aug 7, 2024 · 2 comments · Fixed by #5837
Assignees
Labels
area:logs Part of OpenTelemetry logs pkg:API Related to an API package
Milestone

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Aug 7, 2024

  1. Review the Artifact Naming section of the Logs Bridge API specification for all normative statements
  2. Audit the logs bridge API package for compliance with the specified normative statements.
  3. Identify existing issues or create new issues to track any work needed to make the logs bridge API package compliant with the specification.
@MrAlias MrAlias converted this from a draft issue Aug 7, 2024
@MrAlias MrAlias added area:logs Part of OpenTelemetry logs pkg:API Related to an API package labels Aug 7, 2024
@dashpole dashpole self-assigned this Sep 5, 2024
@dashpole
Copy link
Contributor

There are two normative statements in the artifact naming section:

  • The Logs Bridge API ... SHOULD include documentation that discourages direct use.
  • [The] Log Bridge API artifact, package, and class names MUST NOT include the terms "bridge", "appender", or any other qualifier that would prevent evolution into a user facing API.

@dashpole
Copy link
Contributor

dashpole commented Sep 23, 2024

The Logs Bridge API ... SHOULD include documentation that discourages direct use.

Our current statement is "It is not designed to be a logging API itself.", which I think could be a bit unclear for users. As an uninitiated users, i'm not sure what it would mean for a package providing logging-related interfaces to not be an API...

Log Bridge API artifact, package, and class names MUST NOT include the terms "bridge", "appender", or any other qualifier that would prevent evolution into a user facing API.

Our implementation is compliant with this requirement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:logs Part of OpenTelemetry logs pkg:API Related to an API package
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants