go/opentelemetry-go
go/opentelemetry-go
1
0
Fork 0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-01-30 04:40:41 +02:00
Code Issues Releases Activity

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

Browse Source 
Fixes https://github.com/open-telemetry/opentelemetry-go/issues/5681
This commit is contained in:
David Ashpole 2024-09-25 05:58:35 -04:00 committed by GitHub
parent d284a86fa5
commit 84677a6554
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
log/doc.go
View File

@ -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
@ -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"