| 1 |
// Copyright The OpenTelemetry Authors |
| 2 |
// SPDX-License-Identifier: Apache-2.0 |
| 3 |
|
| 4 |
/* |
| 5 |
Package global provides access to a global implementation of the OpenTelemetry |
| 6 |
Logs API. |
| 7 |
|
| 8 |
This package is experimental. It will be deprecated and removed when the [log] |
| 9 |
package becomes stable. Its functionality will be migrated to |
| 10 |
go.opentelemetry.io/otel. |
| 11 |
*/ |
| 12 |
package global // import "go.opentelemetry.io/otel/log/global" |
| 13 |
|
| 14 |
import ( |
| 15 |
"go.opentelemetry.io/otel/log" |
| 16 |
"go.opentelemetry.io/otel/log/internal/global" |
| 17 |
) |
| 18 |
|
| 19 |
// Logger returns a [log.Logger] configured with the provided name and options |
| 20 |
// from the globally configured [log.LoggerProvider]. |
| 21 |
// |
| 22 |
// If this is called before a global LoggerProvider is configured, the returned |
| 23 |
// Logger will be a No-Op implementation of a Logger. When a global |
| 24 |
// LoggerProvider is registered for the first time, the returned Logger is |
| 25 |
// updated in-place to report to this new LoggerProvider. There is no need to |
| 26 |
// call this function again for an updated instance. |
| 27 |
// |
| 28 |
// This is a convenience function. It is equivalent to: |
| 29 |
// |
| 30 |
// GetLoggerProvider().Logger(name, options...) |
| 31 |
func Logger(name string, options ...log.LoggerOption) log.Logger { |
| 32 |
return GetLoggerProvider().Logger(name, options...) |
| 33 |
} |
| 34 |
|
| 35 |
// GetLoggerProvider returns the globally configured [log.LoggerProvider]. |
| 36 |
// |
| 37 |
// If a global LoggerProvider has not been configured with [SetLoggerProvider], |
| 38 |
// the returned Logger will be a No-Op implementation of a LoggerProvider. When |
| 39 |
// a global LoggerProvider is registered for the first time, the returned |
| 40 |
// LoggerProvider and all of its created Loggers are updated in-place. There is |
| 41 |
// no need to call this function again for an updated instance. |
| 42 |
func GetLoggerProvider() log.LoggerProvider { |
| 43 |
return global.GetLoggerProvider() |
| 44 |
} |
| 45 |
|
| 46 |
// SetLoggerProvider configures provider as the global [log.LoggerProvider]. |
| 47 |
func SetLoggerProvider(provider log.LoggerProvider) { |
| 48 |
global.SetLoggerProvider(provider) |
| 49 |
} |