Skip to content

Commit

Permalink
clarify that users should not directly use the log bridge API (#5837)
Browse files Browse the repository at this point in the history
Fixes #5681
  • Loading branch information
dashpole authored Sep 25, 2024
1 parent d284a86 commit 84677a6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions log/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
/*
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.
# API Implementations
Expand Down Expand Up @@ -68,5 +70,7 @@ It is strongly recommended that authors only embed
go.opentelemetry.io/otel/log/noop if they choose this default behavior. That
implementation is the only one OpenTelemetry authors can guarantee will fully
implement all the API interfaces when a user updates their API.
[registry]: https://opentelemetry.io/ecosystem/registry/?language=go&component=log-bridge
*/
package log // import "go.opentelemetry.io/otel/log"

0 comments on commit 84677a6

Please sign in to comment.