Skip to content

Commit 84677a6

Browse files
authored
clarify that users should not directly use the log bridge API (#5837)
Fixes #5681
1 parent d284a86 commit 84677a6

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

log/doc.go

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
/*
55
Package log provides the OpenTelemetry Logs Bridge API.
66
7-
This package is intended to be a bridge between existing logging libraries and
8-
OpenTelemetry. It is not designed to be a logging API itself.
7+
This package is intended to be used by bridges between existing logging
8+
libraries and OpenTelemetry. Users should not directly use this package as a
9+
logging library. Instead, install one of the bridges listed in the
10+
[registry], and use the associated logging library.
911
1012
# API Implementations
1113
@@ -68,5 +70,7 @@ It is strongly recommended that authors only embed
6870
go.opentelemetry.io/otel/log/noop if they choose this default behavior. That
6971
implementation is the only one OpenTelemetry authors can guarantee will fully
7072
implement all the API interfaces when a user updates their API.
73+
74+
[registry]: https://opentelemetry.io/ecosystem/registry/?language=go&component=log-bridge
7175
*/
7276
package log // import "go.opentelemetry.io/otel/log"

0 commit comments

Comments
 (0)