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

clarify that users should not directly use the log bridge API #5837

Merged
merged 4 commits into from
Sep 25, 2024
Merged

clarify that users should not directly use the log bridge API #5837

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
21a0d2c
clarify that users should not durectly use the log bridge API
dashpole Sep 23, 2024
33db2a2
Update log/doc.go
dashpole Sep 24, 2024
ca9296e
gofumpt
dashpole Sep 24, 2024
1063bff
Merge branch 'main' into logging_disclaimer
pellared Sep 25, 2024
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
8 changes: 6 additions & 2 deletions log/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
/*
Package log provides the OpenTelemetry Logs Bridge API.

This package is intended to be a bridge between existing logging libraries and
OpenTelemetry. It is not designed to be a logging API itself.
This package is intended to be used by bridges between existing logging
libraries and OpenTelemetry. Users should not directly use this package as a
logging library. Instead, install one of the bridges listed in the
[registry], and use the associated logging library.

[registry]: https://opentelemetry.io/ecosystem/registry/?language=go&component=log-bridge

# API Implementations

Expand Down
Loading