mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-28 21:09:17 +02:00
da047e70ef
* Add the Enabled method to the Logger * Add a changelog entry * Rename enabled.go to min_sev.go * Remove MinSeverityProcessor * Document lack of interaction between OnEmit and Enabled * Update sdk/log/processor.go --------- Co-authored-by: Robert Pająk <pellared@hotmail.com>
51 lines
1.6 KiB
Go
51 lines
1.6 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package noop provides an implementation of the [OpenTelemetry Logs Bridge
|
|
// API] that produces no telemetry and minimizes used computation resources.
|
|
//
|
|
// Using this package to implement the [OpenTelemetry Logs Bridge API] will
|
|
// effectively disable OpenTelemetry.
|
|
//
|
|
// This implementation can be embedded in other implementations of the
|
|
// [OpenTelemetry Logs Bridge API]. Doing so will mean the implementation
|
|
// defaults to no operation for methods it does not implement.
|
|
//
|
|
// [OpenTelemetry Logs Bridge API]: https://pkg.go.dev/go.opentelemetry.io/otel/log
|
|
package noop // import "go.opentelemetry.io/otel/log/noop"
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/log"
|
|
"go.opentelemetry.io/otel/log/embedded"
|
|
)
|
|
|
|
var (
|
|
// Compile-time check this implements the OpenTelemetry API.
|
|
_ log.LoggerProvider = LoggerProvider{}
|
|
_ log.Logger = Logger{}
|
|
)
|
|
|
|
// LoggerProvider is an OpenTelemetry No-Op LoggerProvider.
|
|
type LoggerProvider struct{ embedded.LoggerProvider }
|
|
|
|
// NewLoggerProvider returns a LoggerProvider that does not record any telemetry.
|
|
func NewLoggerProvider() LoggerProvider {
|
|
return LoggerProvider{}
|
|
}
|
|
|
|
// Logger returns an OpenTelemetry Logger that does not record any telemetry.
|
|
func (LoggerProvider) Logger(string, ...log.LoggerOption) log.Logger {
|
|
return Logger{}
|
|
}
|
|
|
|
// Logger is an OpenTelemetry No-Op Logger.
|
|
type Logger struct{ embedded.Logger }
|
|
|
|
// Emit does nothing.
|
|
func (Logger) Emit(context.Context, log.Record) {}
|
|
|
|
// Enabled returns false. No log records are ever emitted.
|
|
func (Logger) Enabled(context.Context, log.Record) bool { return false }
|