mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-28 21:09:17 +02:00
110 lines
3.2 KiB
Go
110 lines
3.2 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package log // import "go.opentelemetry.io/otel/log"
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/log/embedded"
|
|
)
|
|
|
|
// Logger emits log records.
|
|
//
|
|
// 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 Logger 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.Logger
|
|
|
|
// Emit emits a log record.
|
|
//
|
|
// The record may be held by the implementation. Callers should not mutate
|
|
// the record after passed.
|
|
//
|
|
// Implementations of this method need to be safe for a user to call
|
|
// concurrently.
|
|
Emit(ctx context.Context, record Record)
|
|
}
|
|
|
|
// LoggerOption applies configuration options to a [Logger].
|
|
type LoggerOption interface {
|
|
// applyLogger is used to set a LoggerOption value of a LoggerConfig.
|
|
applyLogger(LoggerConfig) LoggerConfig
|
|
}
|
|
|
|
// LoggerConfig contains options for a [Logger].
|
|
type LoggerConfig struct {
|
|
// Ensure forward compatibility by explicitly making this not comparable.
|
|
noCmp [0]func() //nolint: unused // This is indeed used.
|
|
|
|
version string
|
|
schemaURL string
|
|
attrs attribute.Set
|
|
}
|
|
|
|
// NewLoggerConfig returns a new [LoggerConfig] with all the options applied.
|
|
func NewLoggerConfig(options ...LoggerOption) LoggerConfig {
|
|
var c LoggerConfig
|
|
for _, opt := range options {
|
|
c = opt.applyLogger(c)
|
|
}
|
|
return c
|
|
}
|
|
|
|
// InstrumentationVersion returns the version of the library providing
|
|
// instrumentation.
|
|
func (cfg LoggerConfig) InstrumentationVersion() string {
|
|
return cfg.version
|
|
}
|
|
|
|
// InstrumentationAttributes returns the attributes associated with the library
|
|
// providing instrumentation.
|
|
func (cfg LoggerConfig) InstrumentationAttributes() attribute.Set {
|
|
return cfg.attrs
|
|
}
|
|
|
|
// SchemaURL returns the schema URL of the library providing instrumentation.
|
|
func (cfg LoggerConfig) SchemaURL() string {
|
|
return cfg.schemaURL
|
|
}
|
|
|
|
type loggerOptionFunc func(LoggerConfig) LoggerConfig
|
|
|
|
func (fn loggerOptionFunc) applyLogger(cfg LoggerConfig) LoggerConfig {
|
|
return fn(cfg)
|
|
}
|
|
|
|
// WithInstrumentationVersion returns a [LoggerOption] that sets the
|
|
// instrumentation version of a [Logger].
|
|
func WithInstrumentationVersion(version string) LoggerOption {
|
|
return loggerOptionFunc(func(config LoggerConfig) LoggerConfig {
|
|
config.version = version
|
|
return config
|
|
})
|
|
}
|
|
|
|
// WithInstrumentationAttributes returns a [LoggerOption] that sets the
|
|
// instrumentation attributes of a [Logger].
|
|
//
|
|
// The passed attributes will be de-duplicated.
|
|
func WithInstrumentationAttributes(attr ...attribute.KeyValue) LoggerOption {
|
|
return loggerOptionFunc(func(config LoggerConfig) LoggerConfig {
|
|
config.attrs = attribute.NewSet(attr...)
|
|
return config
|
|
})
|
|
}
|
|
|
|
// WithSchemaURL returns a [LoggerOption] that sets the schema URL for a
|
|
// [Logger].
|
|
func WithSchemaURL(schemaURL string) LoggerOption {
|
|
return loggerOptionFunc(func(config LoggerConfig) LoggerConfig {
|
|
config.schemaURL = schemaURL
|
|
return config
|
|
})
|
|
}
|