mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-26 21:05:00 +02:00
38 lines
1.5 KiB
Go
38 lines
1.5 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package log // import "go.opentelemetry.io/otel/log"
|
|
|
|
import "go.opentelemetry.io/otel/log/embedded"
|
|
|
|
// LoggerProvider provides access to [Logger].
|
|
//
|
|
// Warning: Methods may be added to this interface in minor releases. See
|
|
// package documentation on API implementation for information on how to set
|
|
// default behavior for unimplemented methods.
|
|
type LoggerProvider interface {
|
|
// Users of the interface can ignore this. This embedded type is only used
|
|
// by implementations of this interface. See the "API Implementations"
|
|
// section of the package documentation for more information.
|
|
embedded.LoggerProvider
|
|
|
|
// 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
|
|
}
|