Events and logs api by scheler · Pull Request #2676 · open-telemetry/opentelemetry-specification

scheler · 2022-07-19T09:55:12Z

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

Co-authored-by: Sam <[email protected]>

Co-authored-by: Tigran Najaryan <[email protected]>

tigrannajaryan · 2022-08-25T14:56:37Z

@zenmoto @kumoroku @djaglowski please review.

…y-specification into events-and-logs-api

tigrannajaryan · 2022-08-30T14:39:22Z

@scheler please resolve comments if the conversations are done.

tigrannajaryan · 2022-08-30T14:39:43Z

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

scheler · 2022-08-30T18:12:18Z

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

jmacd

LGTM!

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)

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.

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)

Resolves open-telemetry#2752. This aligns log SDK and API concepts which have diverged after the merged of open-telemetry#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.

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)

Resolves open-telemetry#2752. This aligns log SDK and API concepts which have diverged after the merged of open-telemetry#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.

scheler added 8 commits June 24, 2022 05:10

Events and Logs API spec

44819cc

API spec for events and logs

27f96ea

Semantic conventions for events

e97b6ff

Deleting file

00cf1f2

Adding experimental status

90fd819

Adding event semantinc convention yaml

89942b1

Updating events-and-logs-api.png

6cc131d

Merge branch 'main' into events-and-logs-api

a54d1f9

scheler requested review from a team July 19, 2022 09:55

github-actions Bot assigned bogdandrutu Jul 19, 2022

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

plantfansam reviewed Jul 19, 2022

View reviewed changes

Comment thread specification/logs/api.md Outdated

Comment thread specification/logs/api.md Outdated

jsuereth reviewed Jul 19, 2022

View reviewed changes

Comment thread semantic_conventions/logs/events.yaml

Comment thread specification/logs/api.md Outdated

scheler and others added 2 commits July 19, 2022 10:32

Update specification/logs/api.md

f8e2424

Co-authored-by: Sam <[email protected]>

Update specification/logs/api.md

4df048e

Co-authored-by: Sam <[email protected]>

scheler mentioned this pull request Jul 20, 2022

Review Events and Log API spec PR signalfx/splunk-otel-android#318

Closed

vmarchaud mentioned this pull request Jul 23, 2022

Allow exporting logs using OTLP exporter open-telemetry/opentelemetry-js#3061

Closed

reyang reviewed Jul 25, 2022

View reviewed changes

Comment thread specification/logs/api.md Outdated

joaopgrassi reviewed Jul 25, 2022

View reviewed changes

Comment thread specification/logs/api.md Outdated

Comment thread specification/logs/api.md

Comment thread specification/logs/api.md Outdated

Comment thread specification/logs/semantic_conventions/events.md Outdated

Comment thread specification/logs/semantic_conventions/events.md Outdated

martinkuba mentioned this pull request Jul 26, 2022

Logs/events API open-telemetry/opentelemetry-js#3117

Merged

5 tasks

tigrannajaryan reviewed Jul 27, 2022

View reviewed changes

martinkuba mentioned this pull request Jul 27, 2022

Semantic conventions for browser navigation/resource events martinkuba/opentelemetry-specification#1

Closed

Update specification/logs/semantic_conventions/events.md

47609ef

Co-authored-by: Tigran Najaryan <[email protected]>

scheler requested a review from a team July 29, 2022 02:22

Update specification/logs/api.md

ad9a705

Co-authored-by: Tigran Najaryan <[email protected]>

jack-berg mentioned this pull request Aug 25, 2022

Consistency of components naming in logs SDK #2752

Closed

djaglowski approved these changes Aug 29, 2022

View reviewed changes

scheler added 2 commits August 29, 2022 08:37

Merge branch 'main' into events-and-logs-api

e711284

Merge branch 'events-and-logs-api' of github.com:scheler/opentelemetr…

46e3570

…y-specification into events-and-logs-api

zenmoto approved these changes Aug 30, 2022

View reviewed changes

Comment thread semantic_conventions/logs/events.yaml Outdated

scheler and others added 2 commits August 29, 2022 18:11

Merge branch 'open-telemetry:main' into events-and-logs-api

7fb6616

Fix typo with events

cc59dad

Merge branch 'main' into events-and-logs-api

fc4d7a3

kumoroku approved these changes Aug 31, 2022

View reviewed changes

tigrannajaryan merged commit 66edf9e into open-telemetry:main Aug 31, 2022

jack-berg mentioned this pull request Sep 1, 2022

Align log sdk naming with api #2768

Merged

jmacd reviewed Sep 1, 2022

View reviewed changes

lalitb mentioned this pull request Sep 6, 2022

Compile errors appear when i import api/opentelemetry/logs/logger.h open-telemetry/opentelemetry-cpp#1590

Closed

This was referenced Sep 7, 2022

Update log component naming to reflect changes to the spec open-telemetry/opentelemetry-python#2926

Closed

Update log component naming to reflect changes to the spec open-telemetry/opentelemetry-dotnet#3637

Closed

dmitryax mentioned this pull request Sep 26, 2022

New component: k8sobjectsreceiver open-telemetry/opentelemetry-collector-contrib#14185

Closed

2 tasks

jack-berg mentioned this pull request Oct 18, 2022

Global accessor for LogEmitterProvider #2332

Closed

fuaiyi mentioned this pull request Dec 21, 2022

feat(api-logs): split out event api open-telemetry/opentelemetry-js#3501

Closed

4 tasks

jack-berg mentioned this pull request Apr 13, 2023

Consider removing include_trace_context from "Get a Logger" API #3394

Closed

Conversation

scheler commented Jul 19, 2022 • edited by tigrannajaryan Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tigrannajaryan commented Aug 25, 2022

Uh oh!

Uh oh!

tigrannajaryan commented Aug 30, 2022

Uh oh!

tigrannajaryan commented Aug 30, 2022

Uh oh!

scheler commented Aug 30, 2022

Uh oh!

jmacd left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

19 participants

scheler commented Jul 19, 2022 •

edited by tigrannajaryan

Loading