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.

Sign up for GitHub

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

Jump to bottom

Add Logging Library SDK Prototype Specification #150

Merged
merged 5 commits into from
Mar 19, 2021
Merged

Add Logging Library SDK Prototype Specification #150

merged 5 commits into from
Mar 19, 2021
+260 −0

Commits on Mar 16, 2021

  1. Add Logging Library SDK Prototype Specification 

    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.
    @tigrannajaryan
    tigrannajaryan committed Mar 16, 2021
    Configuration menu
    Copy the full SHA
    1a7a8e6 View commit details
    Browse the repository at this point in the history

  2. Add "Status", rename OTEP file

    @tigrannajaryan
    tigrannajaryan committed Mar 16, 2021
    Configuration menu
    Copy the full SHA
    0bf96ed View commit details
    Browse the repository at this point in the history

  3. Fix section heading

    @tigrannajaryan
    tigrannajaryan committed Mar 16, 2021
    Configuration menu
    Copy the full SHA
    1b7f528 View commit details
    Browse the repository at this point in the history

  4. Address PR comments

    @tigrannajaryan
    tigrannajaryan committed Mar 16, 2021
    Configuration menu
    Copy the full SHA
    3fb8255 View commit details
    Browse the repository at this point in the history

  5. Add a link to Baggage usage example

    @tigrannajaryan
    tigrannajaryan committed Mar 16, 2021
    Configuration menu
    Copy the full SHA
    7b25bdb View commit details
    Browse the repository at this point in the history