Package: go.opentelemetry.io/otel/api/global

package global Import Path go.opentelemetry.io/otel/api/global (on go.dev) Dependency Relation imports 9 packages, and imported by one package

Involved Source Files handler.go metric.go propagation.go trace.go

Package-Level Type Names (only one, which is unexported)

/* sort exporteds by: alphabet | popularity */

/* one unexported ... *//* one unexported: */

type loggingErrorHandler (struct) loggingErrorHandler logs all errors to STDERR. Fields (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */ delegate atomic.Value l *log.Logger Methods (total 2, in which 1 are exported) (*T) Handle(err error) Handle implements otel.ErrorHandler. /* one unexported ... *//* one unexported: */ (*T) setDelegate(d otel.ErrorHandler) setDelegate sets the ErrorHandler delegate if one is not already set. Implements (at least one exported) *T : go.opentelemetry.io/otel.ErrorHandler As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var globalErrorHandler *loggingErrorHandler

Package-Level Functions (total 11, all are exported)

func ErrorHandler() otel.ErrorHandler ErrorHandler returns the global ErrorHandler instance. If no ErrorHandler instance has been set (`SetErrorHandler`), the default ErrorHandler which logs errors to STDERR is returned.

func Handle(err error) Handle is a convience function for ErrorHandler().Handle(err)

func Meter(instrumentationName string, opts ...metric.MeterOption) metric.Meter Meter creates an implementation of the Meter interface from the global Provider. The instrumentationName must be the name of the library providing instrumentation. This name may be the same as the instrumented code only if that code provides built-in instrumentation. If the instrumentationName is empty, then a implementation defined default name will be used instead. This is short for MeterProvider().Meter(name)

func MeterProvider() metric.Provider MeterProvider returns the registered global meter provider. If none is registered then a default meter provider is returned that forwards the Meter interface to the first registered Meter. Use the meter provider to create a named meter. E.g. meter := global.MeterProvider().Meter("example.com/foo") or meter := global.Meter("example.com/foo")

func Propagators() propagation.Propagators Propagators returns the registered global propagators instance. If none is registered then an instance of propagators.NoopPropagators is returned.

func SetErrorHandler(h otel.ErrorHandler) SetErrorHandler sets the global ErrorHandler to be h.

func SetMeterProvider(mp metric.Provider) SetMeterProvider registers `mp` as the global meter provider.

func SetPropagators(p propagation.Propagators) SetPropagators registers `p` as the global propagators instance.

func SetTraceProvider(tp trace.Provider) SetTraceProvider registers `tp` as the global trace provider.

func TraceProvider() trace.Provider TraceProvider returns the registered global trace provider. If none is registered then an instance of trace.NoopProvider is returned. Use the trace provider to create a named tracer. E.g. tracer := global.TraceProvider().Tracer("example.com/foo") or tracer := global.Tracer("example.com/foo")

func Tracer(name string) trace.Tracer Tracer creates a named tracer that implements Tracer interface. If the name is an empty string then provider uses default name. This is short for TraceProvider().Tracer(name)

Package-Level Variables (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */

var delegateErrorHandlerOnce sync.Once delegateErrorHandlerOnce ensures that a user provided ErrorHandler is only ever registered once.

var globalErrorHandler *loggingErrorHandler globalErrorHandler provides an ErrorHandler that can be used throughout an OpenTelemetry instrumented project. When a user specified ErrorHandler is registered (`SetErrorHandler`) all calls to `Handle` and will be delegated to the registered ErrorHandler.