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

Events and logs api #2676

Merged
merged 35 commits into from
Aug 31, 2022
Merged

Conversation

scheler
Copy link
Contributor

@scheler scheler commented Jul 19, 2022

Changes

This PR is a follow up to the OTEP Events and Logs API. It describes the specification for an Events and Logs API and also defines semantic conventions for attributes to be used for Events that are represented using Log Records.

For non-trivial changes, follow the change proposal
process
and link to the related issue(s)
and/or OTEP(s), update the
CHANGELOG.md, and also be sure to update
spec-compliance-matrix.md if necessary.

Related OTEP(s) #

Events and Logs API

@scheler scheler requested review from a team as code owners July 19, 2022 09:55
@arminru arminru added enhancement New feature or request area:api Cross language API specification issue spec:logs Related to the specification/logs directory area:semantic-conventions Related to semantic conventions labels Jul 19, 2022
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
semantic_conventions/logs/events.yaml Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
scheler and others added 2 commits July 19, 2022 10:32
Co-authored-by: Sam <370182+plantfansam@users.noreply.github.com>
Co-authored-by: Sam <370182+plantfansam@users.noreply.github.com>
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/semantic_conventions/events.md Outdated Show resolved Hide resolved
specification/logs/semantic_conventions/events.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
specification/logs/api.md Outdated Show resolved Hide resolved
semantic_conventions/logs/events.yaml Show resolved Hide resolved
specification/logs/semantic_conventions/events.md Outdated Show resolved Hide resolved
specification/logs/semantic_conventions/events.md Outdated Show resolved Hide resolved
Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
@scheler scheler requested a review from a team as a code owner July 29, 2022 02:22
Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
Co-authored-by: Tigran Najaryan <4194920+tigrannajaryan@users.noreply.github.com>
@tigrannajaryan
Copy link
Member

@zenmoto @kumoroku @djaglowski please review.

semantic_conventions/logs/events.yaml Outdated Show resolved Hide resolved
@tigrannajaryan
Copy link
Member

@scheler please resolve comments if the conversations are done.

@tigrannajaryan
Copy link
Member

@open-telemetry/specs-approvers we have the necessary number of approvals. Last call to review before merging.

@scheler
Copy link
Contributor Author

scheler commented Aug 30, 2022

@tigrannajaryan I've resolved all conversations except one on your question about generating events.md file automatically, can you take a look - #2676 (comment)?

@tigrannajaryan tigrannajaryan merged commit 66edf9e into open-telemetry:main Aug 31, 2022
Copy link
Contributor

@jmacd jmacd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

MSNev pushed a commit to MSNev/opentelemetry-specification that referenced this pull request Sep 6, 2022
This PR is a follow up to the OTEP [Events and Logs API](https://github.com/open-telemetry/oteps/blob/main/text/0202-events-and-logs-api.md). It describes the specification for an Events and Logs API and also defines semantic conventions for attributes to be used for Events that are represented using Log Records.

For non-trivial changes, follow the [change proposal
process](../CONTRIBUTING.md#proposing-a-change) and link to the related issue(s)
and/or [OTEP(s)](https://github.com/open-telemetry/oteps), update the
[`CHANGELOG.md`](../CHANGELOG.md), and also be sure to update
[`spec-compliance-matrix.md`](../spec-compliance-matrix.md) if necessary.


Related [OTEP(s)](https://github.com/open-telemetry/oteps) #

[Events and Logs API](https://github.com/open-telemetry/oteps/blob/main/text/0202-events-and-logs-api.md)
tigrannajaryan pushed a commit that referenced this pull request Sep 13, 2022
Resolves #2752.

This aligns log SDK and API concepts which have diverged after the merged of #2676. This PR brings alignment to the log API and SDK, and in brings the log signal into alignment with tracing and metrics where there is conceptual overlap. There shouldn't be any new concepts introduced here.

- Rename `../logs/logging-library-sdk.md` to `../logs/sdk.md`
- Remove wording from SDK that implies that an API doesn't exist, like [this](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L60-L62).
- Move [How to Create Log4j Style Appender](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L219) to `api.md` since it describes an API use case.
- Move [Implicit / Explicit Context Injection](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/logging-library-sdk.md#L270-L288) sections to `api.md` since they describe API level considerations.
- Rename Logger [create](https://github.com/open-telemetry/opentelemetry-specification/blame/main/specification/logs/api.md#L133) method to be emit, to align with SDK concept of `LogRecordProcessor#onEmit(..)`.
- Rename `LogProcessor`, `LogExporter` to `LogRecordProcessor`, `LogRecordExporter`. 
- Fill in various SDK level TODOs related to shutdown and flushing. The language from these was taken directly from the metrics / tracing SDK - no new concepts were introduced.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Cross language API specification issue area:semantic-conventions Related to semantic conventions enhancement New feature or request spec:logs Related to the specification/logs directory
Development

Successfully merging this pull request may close these issues.

None yet