-
Notifications
You must be signed in to change notification settings - Fork 164
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
Add Logging Library SDK Prototype Specification #150
Add Logging Library SDK Prototype Specification #150
Conversation
1689ceb
to
db61dc9
Compare
db61dc9
to
d071f71
Compare
@pmm-sumo for some reason I cannot add you as a reviewer, please review. |
Note: I am out tomorrow, won't be able to respond to comments until the day after. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For a prototype phase these specifications are good
@open-telemetry/python-approvers I think there was some recent log-related work done in Python library. Please review this proposal. |
@open-telemetry/cpp-approvers I believe we have a Log prototype in C++ library. Please review this proposal and see if it fits what you wanted to do in C++. |
This is a draft proposal for OpenTelemetry Logging Library SDK specification. The purpose of his proposal is to lay out the initial understanding of what Logging Library SDKs will look like. We would like to create prototypes based on this proposal in a few languages. The learnings from prototypes will then allow us to refine this proposal and eventually make the proposed approach part of the OpenTelemetry specification. The approach proposed in this OTEP is not intended to be merged into the OpenTelemetry specification after the OTEP itself is approved. We want to have successful prototypes first. This OTEP is first and foremost a specification and guidelines on how to create the prototypes. The specification defines how the OpenTelemetry Logging Library SDK exposes its functionality to authors of extensions to language-specific 3rd party logging libraries and to end users that want to produce logs in [OpenTelemetry manner](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/overview.md). The specification defines SDK elements that to some extent mirror the OpenTelemetry [Trace SDK](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace). This ensures uniformity and consistency of the OpenTelemetry specification and of the implementations across traces and logs. For additional clarity the definitions in this document refer to the Trace analogs where appropriate. The descriptions of interfaces and methods in this document are intentionally very brief. Detailed and precise descriptions will be borrowed from Trace specification when this OTEP is submitted as a Log specification PR. I kept the descriptions as short as possible in this document to make reviewing it easy and fast.
7a28243
to
3fb8255
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a good starting point to me.
961f265
to
7b25bdb
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM in general. Good start for initial prototyping.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Has the necessary number of approvals. No new comments for 3 days. All comments resolved. Merging. If anyone sees this PR after merging and has thoughts please do speak: we want to know your opinion and can adjust the OTEP and our prototyping approach. |
This is a draft proposal for OpenTelemetry Logging Library SDK specification.
The purpose of his proposal is to lay out the initial understanding of
what Logging Library SDKs will look like.
We would like to create prototypes based on this proposal in a few languages.
The learnings from prototypes will then allow us to refine this proposal and
eventually make the proposed approach part of the OpenTelemetry specification.
The approach proposed in this OTEP is not intended to be merged into the
OpenTelemetry specification after the OTEP itself is approved. We want to have
successful prototypes first. This OTEP is first and foremost a specification and
guidelines on how to create the prototypes.
The specification defines how the OpenTelemetry Logging Library SDK exposes its
functionality to authors of extensions to language-specific 3rd party logging
libraries and to end users that want to produce logs in
OpenTelemetry manner.
The specification defines SDK elements that to some extent mirror the
OpenTelemetry
Trace SDK.
This ensures uniformity and consistency of the OpenTelemetry specification and
of the implementations across traces and logs. For additional clarity the
definitions in this document refer to the Trace analogs where appropriate.
The descriptions of interfaces and methods in this document are intentionally
very brief. Detailed and precise descriptions will be borrowed from Trace
specification when this OTEP is submitted as a Log specification PR. I kept the
descriptions as short as possible in this document to make reviewing it easy and
fast.