Skip to content

Commit

Permalink
Document Logger name and version recommendations (#5613)
Browse files Browse the repository at this point in the history
Part of #5412

---------

Co-authored-by: Robert Pająk <pellared@hotmail.com>
  • Loading branch information
MrAlias and pellared authored Jul 12, 2024
1 parent 5881fe7 commit 776ceb7
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions log/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,19 @@ type LoggerProvider interface {

// Logger returns a new [Logger] with the provided name and configuration.
//
// The name needs to uniquely identify the source of logged code. It is
// recommended that name is the Go package name of the library using a log
// bridge (note: this is not the name of the bridge package). Most
// commonly, this means a bridge will need to accept this value from its
// users.
//
// If name is empty, implementations need to provide a default name.
//
// The version of the packages using a bridge can be critical information
// to include when logging. The bridge should accept this version
// information and use the [WithInstrumentationVersion] option to configure
// the Logger appropriately.
//
// Implementations of this method need to be safe for a user to call
// concurrently.
Logger(name string, options ...LoggerOption) Logger
Expand Down

0 comments on commit 776ceb7

Please sign in to comment.