package otel
Import Path
go.opentelemetry.io/otel (on go.dev)
Dependency Relation
imports 5 packages, and imported by 5 packages
Involved Source Files
Package otel provides global access to the OpenTelemetry API. The subpackages of
the otel package provide an implementation of the OpenTelemetry API.
The provided API is used to instrument code and measure data about that code's
performance and operation. The measured data, by default, is not processed or
transmitted anywhere. An implementation of the OpenTelemetry SDK, like the
default SDK implementation (go.opentelemetry.io/otel/sdk), and associated
exporters are used to process and transport this data.
To read the getting started guide, see https://opentelemetry.io/docs/languages/go/getting-started/.
To read more about tracing, see go.opentelemetry.io/otel/trace.
To read more about metrics, see go.opentelemetry.io/otel/metric.
To read more about logs, see go.opentelemetry.io/otel/log.
To read more about propagation, see go.opentelemetry.io/otel/propagation and
go.opentelemetry.io/otel/baggage.
error_handler.go
handler.go
internal_logging.go
metric.go
propagation.go
trace.go
version.go
Package-Level Type Names (total 2)
ErrorHandler handles irremediable events.
Handle handles any error deemed irremediable by an OpenTelemetry
component.
ErrorHandlerFunc
*go.opentelemetry.io/otel/internal/global.ErrDelegator
go.opentelemetry.io/otel/internal/global.ErrorHandler (interface)
ErrorHandler : go.opentelemetry.io/otel/internal/global.ErrorHandler
func GetErrorHandler() ErrorHandler
func SetErrorHandler(h ErrorHandler)
ErrorHandlerFunc is a convenience adapter to allow the use of a function
as an ErrorHandler.
Handle handles the irremediable error by calling the ErrorHandlerFunc itself.
ErrorHandlerFunc : ErrorHandler
ErrorHandlerFunc : go.opentelemetry.io/otel/internal/global.ErrorHandler
Package-Level Functions (total 13)
GetErrorHandler returns the global ErrorHandler instance.
The default ErrorHandler instance returned will log all errors to STDERR
until an override ErrorHandler is set with SetErrorHandler. All
ErrorHandler returned prior to this will automatically forward errors to
the set instance instead of logging.
Subsequent calls to SetErrorHandler after the first will not forward errors
to the new ErrorHandler for prior returned instances.
GetMeterProvider returns the registered global meter provider.
If no global GetMeterProvider has been registered, a No-op GetMeterProvider
implementation is returned. When a global GetMeterProvider is registered for
the first time, the returned GetMeterProvider, and all the Meters it has
created or will create, are recreated automatically from the new
GetMeterProvider.
GetTextMapPropagator returns the global TextMapPropagator. If none has been
set, a No-Op TextMapPropagator is returned.
GetTracerProvider returns the registered global trace provider.
If none is registered then an instance of NoopTracerProvider is returned.
Use the trace provider to create a named tracer. E.g.
tracer := otel.GetTracerProvider().Tracer("example.com/foo")
or
tracer := otel.Tracer("example.com/foo")
Handle is a convenience function for GetErrorHandler().Handle(err).
Meter returns a Meter from the global MeterProvider. The name 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 name is empty, then a implementation defined default name will be
used instead.
If this is called before a global MeterProvider is registered the returned
Meter will be a No-op implementation of a Meter. When a global MeterProvider
is registered for the first time, the returned Meter, and all the
instruments it has created or will create, are recreated automatically from
the new MeterProvider.
This is short for GetMeterProvider().Meter(name).
SetErrorHandler sets the global ErrorHandler to h.
The first time this is called all ErrorHandler previously returned from
GetErrorHandler will send errors to h instead of the default logging
ErrorHandler. Subsequent calls will set the global ErrorHandler, but not
delegate errors to h.
SetLogger configures the logger used internally to opentelemetry.
SetMeterProvider registers mp as the global MeterProvider.
SetTextMapPropagator sets propagator as the global TextMapPropagator.
SetTracerProvider registers `tp` as the global trace provider.
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 GetTracerProvider().Tracer(name, opts...)
Version is the current release version of OpenTelemetry in use.
![]() |
The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds. |