Skip to content

[editorial] Update Logs API preface #4382

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

Merged
merged 2 commits into from
Jan 22, 2025
Merged

[editorial] Update Logs API preface #4382

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ee1c2e
Update api.md
pellared Jan 22, 2025
cb80572
Update api.md
pellared Jan 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions specification/logs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,13 @@ aliases: [bridge-api]

</details>

<b>Note: this document defines a log *backend* API. The API is not intended
to be called by application developers directly. It is provided for logging
library authors to build
The Logs API is provided for logging library authors to build
[log appenders](./supplementary-guidelines.md#how-to-create-a-log4j-log-appender),
which use this API to bridge between existing logging libraries and the
OpenTelemetry log data model.</b>
OpenTelemetry log data model.

The Logs API can also be directly called by instrumentation libraries
as well as instrumented libraries or applications.
Comment on lines -31 to +37
Copy link
Member

@trask trask Jan 22, 2025

Choose a reason for hiding this comment

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

this is essentially promoting "user-facing Logs API" to stable?

Copy link
Member Author

@pellared pellared Jan 23, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I thought my previous PR already did promote this to stable.

If anyone finds it unwanted I created: #4383

Feel free to "undraft" the PR.


The Logs API consist of these main components:

Expand Down
Loading