| 1 |
// Copyright The OpenTelemetry Authors |
| 2 |
// SPDX-License-Identifier: Apache-2.0 |
| 3 |
|
| 4 |
// Package noop provides an implementation of the [OpenTelemetry Logs Bridge |
| 5 |
// API] that produces no telemetry and minimizes used computation resources. |
| 6 |
// |
| 7 |
// Using this package to implement the [OpenTelemetry Logs API] will |
| 8 |
// effectively disable OpenTelemetry. |
| 9 |
// |
| 10 |
// This implementation can be embedded in other implementations of the |
| 11 |
// [OpenTelemetry Logs API]. Doing so will mean the implementation |
| 12 |
// defaults to no operation for methods it does not implement. |
| 13 |
// |
| 14 |
// [OpenTelemetry Logs API]: https://pkg.go.dev/go.opentelemetry.io/otel/log |
| 15 |
package noop // import "go.opentelemetry.io/otel/log/noop" |
| 16 |
|
| 17 |
import ( |
| 18 |
"context" |
| 19 |
|
| 20 |
"go.opentelemetry.io/otel/log" |
| 21 |
"go.opentelemetry.io/otel/log/embedded" |
| 22 |
) |
| 23 |
|
| 24 |
var ( |
| 25 |
// Compile-time check this implements the OpenTelemetry API. |
| 26 |
_ log.LoggerProvider = LoggerProvider{} |
| 27 |
_ log.Logger = Logger{} |
| 28 |
) |
| 29 |
|
| 30 |
// LoggerProvider is an OpenTelemetry No-Op LoggerProvider. |
| 31 |
type LoggerProvider struct{ embedded.LoggerProvider } |
| 32 |
|
| 33 |
// NewLoggerProvider returns a LoggerProvider that does not record any telemetry. |
| 34 |
func NewLoggerProvider() LoggerProvider { |
| 35 |
return LoggerProvider{} |
| 36 |
} |
| 37 |
|
| 38 |
// Logger returns an OpenTelemetry Logger that does not record any telemetry. |
| 39 |
func (LoggerProvider) Logger(string, ...log.LoggerOption) log.Logger { |
| 40 |
return Logger{} |
| 41 |
} |
| 42 |
|
| 43 |
// Logger is an OpenTelemetry No-Op Logger. |
| 44 |
type Logger struct{ embedded.Logger } |
| 45 |
|
| 46 |
// Emit does nothing. |
| 47 |
func (Logger) Emit(context.Context, log.Record) {} |
| 48 |
|
| 49 |
// Enabled returns false. No log records are ever emitted. |
| 50 |
func (Logger) Enabled(context.Context, log.EnabledParameters) bool { return false } |