README

OpenTelemetry-Go

CI PkgGoDev Go Report Card Gitter

The Go OpenTelemetry implementation.

Project Status

Warning: this project is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

Our progress towards a GA release candidate is tracked in this project board. This release candidate will follow semantic versioning and will be released with a major version greater than zero.

Progress and status specific to this repository is tracked in our local project boards and milestones.

Project versioning information and stability guarantees can be found in the versioning documentation.

Getting Started

You can find a getting started guide on opentelemetry.io.

OpenTelemetry's goal is to provide a single set of APIs to capture distributed traces and metrics from your application and send them to an observability platform. This project allows you to do just that for applications written in Go. There are two steps to this process: instrument your application, and configure an exporter.

Instrumentation

To start capturing distributed traces and metric events from your application it first needs to be instrumented. The easiest way to do this is by using an instrumentation library for your code. Be sure to check out the officially supported instrumentation libraries.

If you need to extend the telemetry an instrumentation library provides or want to build your own instrumentation for your application directly you will need to use the go.opentelemetry.io/otel/api package. The included examples are a good way to see some practical uses of this process.

Export

Now that your application is instrumented to collect telemetry, it needs an export pipeline to send that telemetry to an observability platform.

You can find officially supported exporters here and in the companion contrib repository. Additionally, there are many vendor specific or 3rd party exporters for OpenTelemetry. These exporters are broken down by trace and metric support.

Contributing

See the contributing documentation.

Expand ▾ Collapse ▴

Documentation

Overview

    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 pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

    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

    Constants

    This section is empty.

    Variables

    This section is empty.

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

                  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.

                        Directories

                        Path Synopsis
                        Package baggage provides functionality for storing and retrieving baggage items in Go context.
                        Package baggage provides functionality for storing and retrieving baggage items in Go context.
                        bridge
                        opencensus Module
                        opentracing Module
                        Package codes defines the canonical error codes used by OpenTelemetry.
                        Package codes defines the canonical error codes used by OpenTelemetry.
                        example
                        basic Module
                        grpc Module
                        http Module
                        jaeger Module
                        namedtracer Module
                        opencensus Module
                        prometheus Module
                        zipkin Module
                        exporter
                        trace/jaeger Module
                        exporters
                        otlp Module
                        stdout Module
                        trace/jaeger Module
                        trace/zipkin Module
                        baggage
                        Package baggage provides types and functions to manage W3C Baggage.
                        Package baggage provides types and functions to manage W3C Baggage.
                        trace/noop
                        Package noop provides noop tracing implementations for tracer and span.
                        Package noop provides noop tracing implementations for tracer and span.
                        tools Module
                        Package label provides key and value labels.
                        Package label provides key and value labels.
                        metric module
                        oteltest module
                        Package propagation contains OpenTelemetry context propagators.
                        Package propagation contains OpenTelemetry context propagators.
                        sdk module
                        export/metric Module
                        metric Module
                        Package semconv implements OpenTelemetry semantic conventions.
                        Package semconv implements OpenTelemetry semantic conventions.
                        trace module
                        Package unit provides units.
                        Package unit provides units.