...
▽

Package otel

import "go.opentelemetry.io/otel"
Overview
Index
Examples
Subdirectories

Overview ▾

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/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 propagation, see go.opentelemetry.io/otel/propagation and go.opentelemetry.io/otel/baggage.

func GetMeterProvider 

func GetMeterProvider() metric.MeterProvider

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.

func GetTextMapPropagator 

func GetTextMapPropagator() propagation.TextMapPropagator

GetTextMapPropagator returns the global TextMapPropagator. If none has been set, a No-Op TextMapPropagator is returned.

func GetTracerProvider 

func GetTracerProvider() trace.TracerProvider

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")

func Handle 

func Handle(err error)

Handle is a convenience function for ErrorHandler().Handle(err).

func Meter 

func Meter(name string, opts ...metric.MeterOption) metric.Meter

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).

func SetErrorHandler 

func SetErrorHandler(h ErrorHandler)

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.

func SetLogger 

func SetLogger(logger logr.Logger)

SetLogger configures the logger used internally to opentelemetry.

▾ Example

Code:

logger := stdr.New(log.New(os.Stdout, "", log.LstdFlags|log.Lshortfile))
otel.SetLogger(logger)

func SetMeterProvider 

func SetMeterProvider(mp metric.MeterProvider)

SetMeterProvider registers mp as the global MeterProvider.

func SetTextMapPropagator 

func SetTextMapPropagator(propagator propagation.TextMapPropagator)

SetTextMapPropagator sets propagator as the global TextMapPropagator.

func SetTracerProvider 

func SetTracerProvider(tp trace.TracerProvider)

SetTracerProvider registers `tp` as the global trace provider.

func Tracer 

func Tracer(name string, opts ...trace.TracerOption) 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 GetTracerProvider().Tracer(name, opts...)

func Version 

func Version() string

Version is the current release version of OpenTelemetry in use.

type ErrorHandler

ErrorHandler handles irremediable events. 

type ErrorHandler interface {

    // Handle handles any error deemed irremediable by an OpenTelemetry
    // component.
    Handle(error)
}

func GetErrorHandler 

func GetErrorHandler() ErrorHandler

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.

type ErrorHandlerFunc

ErrorHandlerFunc is a convenience adapter to allow the use of a function as an ErrorHandler. 

type ErrorHandlerFunc func(error)

func (ErrorHandlerFunc) Handle 

func (f ErrorHandlerFunc) Handle(err error)

Handle handles the irremediable error by calling the ErrorHandlerFunc itself.

Subdirectories

Name Synopsis
..
attribute Package attribute provides key and value attributes.
baggage Package baggage provides functionality for storing and retrieving baggage items in Go context.
codes Package codes defines the canonical error codes used by OpenTelemetry.
exporters
otlp
otlptrace Package otlptrace contains abstractions for OTLP span exporters.
otlptracegrpc Package otlptracegrpc provides an OTLP span exporter using gRPC.
metric Package metric provides the OpenTelemetry API used to measure metrics about source code operation.
embedded Package embedded provides interfaces embedded within the [OpenTelemetry metric API].
noop Package noop provides an implementation of the OpenTelemetry metric API that produces no telemetry and minimizes used computation resources.
propagation Package propagation contains OpenTelemetry context propagators.
sdk
instrumentation Package instrumentation provides types to represent the code libraries that provide OpenTelemetry instrumentation.
resource Package resource provides detecting and representing resources.
trace Package trace contains support for OpenTelemetry distributed tracing.
tracetest Package tracetest is a testing helper package for the SDK.
semconv
v1.10.0 Package semconv implements OpenTelemetry semantic conventions.
v1.11.0 Package semconv implements OpenTelemetry semantic conventions.
v1.12.0 Package semconv implements OpenTelemetry semantic conventions.
v1.13.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.14.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.15.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.16.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.17.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.18.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.19.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.20.0 Package semconv implements OpenTelemetry semantic conventions.
httpconv Package httpconv provides OpenTelemetry HTTP semantic conventions for tracing telemetry.
netconv Package netconv provides OpenTelemetry network semantic conventions for tracing telemetry.
v1.21.0 Package semconv implements OpenTelemetry semantic conventions.
v1.4.0 Package semconv implements OpenTelemetry semantic conventions.
v1.5.0 Package semconv implements OpenTelemetry semantic conventions.
v1.6.1 Package semconv implements OpenTelemetry semantic conventions.
v1.7.0 Package semconv implements OpenTelemetry semantic conventions.
v1.8.0 Package semconv implements OpenTelemetry semantic conventions.
v1.9.0 Package semconv implements OpenTelemetry semantic conventions.
trace Package trace provides an implementation of the tracing part of the OpenTelemetry API.
embedded Package embedded provides interfaces embedded within the [OpenTelemetry trace API].
noop Package noop provides an implementation of the OpenTelemetry trace API that produces no telemetry and minimizes used computation resources.