otel – go.opentelemetry.io/otel Index | Files | Directories

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.

This package is currently in a Release Candidate phase. Backwards incompatible changes may be introduced prior to v1.0.0, but we believe the current API is ready to stabilize.

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

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 := global.GetTracerProvider().Tracer("example.com/foo")

or

tracer := global.Tracer("example.com/foo")

func Handle

func Handle(err error)

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

func SetErrorHandler

func SetErrorHandler(h ErrorHandler)

SetErrorHandler sets the global ErrorHandler to be 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. If no ErrorHandler instance has been set (`SetErrorHandler`), the default ErrorHandler which logs errors to STDERR is returned.

Source Files

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

Directories

PathSynopsis
attributepackage attribute provides key and value attributes.
baggagePackage baggage provides functionality for storing and retrieving baggage items in Go context.
codesPackage codes defines the canonical error codes used by OpenTelemetry.
internal
propagationPackage propagation contains OpenTelemetry context propagators.
semconv
semconv/v1.4.0Package semconv implements OpenTelemetry semantic conventions.
Version
v1.0.0-RC2
Published
Jul 26, 2021
Platform
linux/amd64
Imports
7 packages
Last checked
3 minutes ago

Tools for package owners.