package otel

import "go.opentelemetry.io/otel"

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.

Index ¶

• func GetTextMapPropagator() propagation.TextMapPropagator
• func GetTracerProvider() trace.TracerProvider
• func Handle(err error)
• func SetErrorHandler(h ErrorHandler)
• func SetTextMapPropagator(propagator propagation.TextMapPropagator)
• func SetTracerProvider(tp trace.TracerProvider)
• func Tracer(name string, opts ...trace.TracerOption) trace.Tracer
• func Version() string
• type ErrorHandler
• func GetErrorHandler() ErrorHandler
• type ErrorHandlerFunc
• func (f ErrorHandlerFunc) Handle(err error)

Functions ¶

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

Types ¶

type ErrorHandler ¶

type ErrorHandler interface {

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

ErrorHandler handles irremediable events.

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 ¶

type ErrorHandlerFunc func(error)

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

func (ErrorHandlerFunc) Handle ¶

func (f ErrorHandlerFunc) Handle(err error)

Handle handles the irremediable error by calling the ErrorHandlerFunc itself.

Source Files ¶

doc.go error_handler.go handler.go propagation.go trace.go version.go

Directories ¶