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

Define a specification for the OpenTelemetry Logging API and SDK #1258

Closed
alolita opened this issue Nov 23, 2020 · 3 comments
Closed

Define a specification for the OpenTelemetry Logging API and SDK #1258

alolita opened this issue Nov 23, 2020 · 3 comments
Labels
release:after-ga Not required before GA release, and not going to work on before GA spec:logs Related to the specification/logs directory

Comments

@alolita
Copy link
Member

alolita commented Nov 23, 2020

What are you trying to achieve?

Currently there is no logging specification for the API and SDK, similar to specification of the traces API and traces SDK. This means that a large component of the logging functionality is being based off what is specified for traces, which can introduce problems for logs.

What did you expect to see?

The logging specification should state the required classes, the methods present for each class, and lay out the logic of the sampler. It should include the classes and the methods of LoggerProvider, Logger, Log Processor and Log Exporter interface. There could be a duplication with the implementation logic between with the Logs and Traces specification, such as LoggerProvider having the duplicate logic to the TracerProvider, the LogProcessor having similar logic to the SpanProcessor and Log Exporter having similar logic to the SpanExporter, for both the API and SDK.

Having a well-defined logging specification will allow future additions to the logging API and SDK have a place to reside. Having these documents would help language libraries provide a consistent implementation of logging that satisfies the OpenTelemetry requirements.

Additional context (Add any other context about the problem here. If you followed an existing documentation, please share the link to it.)

Currently, the main sources of reference in the specification for logs is limited to a logging overview and Log Data Model definition.

cc: @xukaren @MarkSeufert

@alolita alolita added the spec:logs Related to the specification/logs directory label Nov 23, 2020
@carlosalberto carlosalberto added the release:after-ga Not required before GA release, and not going to work on before GA label Nov 24, 2020
@tigrannajaryan
Copy link
Member

This is at least partially a duplicate of #894

@tigrannajaryan
Copy link
Member

OTEP 0150 for Logging SDK spec submitted: open-telemetry/oteps#150

@tigrannajaryan
Copy link
Member

OTEP 0150 is approved and merged and is considered to be the specification for now.

Further refinements and formal merging of the OTEP to the spec documents will be done after prototype implementations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:after-ga Not required before GA release, and not going to work on before GA spec:logs Related to the specification/logs directory
Projects
None yet
Development

No branches or pull requests

3 participants