Repository files navigation

OpenTelemetry-Go is theGo implementation ofOpenTelemetry.It provides a set of APIs to directly measure performance and behavior of your software and send this data to observability platforms.

Progress and status specific to this repository is tracked in ourproject boardsandmilestones.

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

OpenTelemetry-Go ensures compatibility with the current supported versions oftheGo language:

Each major Go release is supported until there are two newer major releases.For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.

For versions of Go that are no longer supported upstream, opentelemetry-go willstop ensuring compatibility with these versions in the following manner:

• A minor release of opentelemetry-go will be made to add support for the newsupported release of Go.
• The following minor release of opentelemetry-go will remove compatibilitytesting for the oldest (now archived upstream) version of Go. This, andfuture, releases of opentelemetry-go may include features only supported bythe currently supported versions of Go.

Currently, this project supports the following environments.

While this project should work for other systems, no compatibility guaranteesare made for those systems currently.

You can find a getting started guide onopentelemetry.io.

OpenTelemetry's goal is to provide a single set of APIs to capture distributedtraces and metrics from your application and send them to an observabilityplatform. This project allows you to do just that for applications written inGo. There are two steps to this process: instrument your application, andconfigure an exporter.

To start capturing distributed traces and metric events from your applicationit first needs to be instrumented. The easiest way to do this is by using aninstrumentation library for your code. Be sure to check outthe officiallysupported instrumentationlibraries.

If you need to extend the telemetry an instrumentation library provides or wantto build your own instrumentation for your application directly you will needto use theGo otelpackage. Theexamplesare a good way to see some practical uses of this process.

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

All officially supported exporters for the OpenTelemetry project are contained in theexporters directory.

See thecontributing documentation.