README
¶
OpenTelemetry-Go
OpenTelemetry-Go is the Go implementation of OpenTelemetry. It provides a set of APIs to directly measure performance and behavior of your software and send this data to observability platforms.
Project Status
| Signal | Status |
|---|---|
| Traces | Stable |
| Metrics | Stable |
| Logs | Stable |
Progress and status specific to this repository is tracked in our project boards and milestones.
Project versioning information and stability guarantees can be found in the versioning documentation.
Compatibility
OpenTelemetry-Go ensures compatibility with the current supported versions of the Go 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 will stop ensuring compatibility with these versions in the following manner:
- A minor release of opentelemetry-go will be made to add support for the new supported release of Go.
- The following minor release of opentelemetry-go will remove compatibility testing for the oldest (now archived upstream) version of Go. This, and future, releases of opentelemetry-go may include features only supported by the currently supported versions of Go.
Currently, this project supports the following environments.
| OS | Go Version | Architecture |
|---|---|---|
| Ubuntu | 1.27 | amd64 |
| Ubuntu | 1.26 | amd64 |
| Ubuntu | 1.27 | 386 |
| Ubuntu | 1.26 | 386 |
| Ubuntu | 1.27 | arm64 |
| Ubuntu | 1.26 | arm64 |
| macOS | 1.27 | amd64 |
| macOS | 1.26 | amd64 |
| macOS | 1.27 | arm64 |
| macOS | 1.26 | arm64 |
| Windows | 1.27 | amd64 |
| Windows | 1.26 | amd64 |
| Windows | 1.27 | 386 |
| Windows | 1.26 | 386 |
While this project should work for other systems, no compatibility guarantees are made for those systems currently.
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 otel package. The 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.
All officially supported exporters for the OpenTelemetry project are contained in the exporters directory.
| Exporter | Logs | Metrics | Traces |
|---|---|---|---|
| OTLP | ✓ | ✓ | ✓ |
| Prometheus | ✓ | ||
| stdout | ✓ | ✓ | ✓ |
| Zipkin | ✓ |
Contributing
See the contributing documentation.
Documentation
¶
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/languages/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 logs, see go.opentelemetry.io/otel/log.
To read more about propagation, see go.opentelemetry.io/otel/propagation and go.opentelemetry.io/otel/baggage.
Index ¶
- func GetLoggerProvider() log.LoggerProvider
- func GetMeterProvider() metric.MeterProvider
- func GetTextMapPropagator() propagation.TextMapPropagator
- func GetTracerProvider() trace.TracerProvider
- func Handle(err error)
- func Logger(name string, options ...log.LoggerOption) log.Logger
- func Meter(name string, opts ...metric.MeterOption) metric.Meter
- func SetErrorHandler(h ErrorHandler)
- func SetLogger(logger logr.Logger)
- func SetLoggerProvider(provider log.LoggerProvider)
- func SetMeterProvider(mp metric.MeterProvider)
- func SetTextMapPropagator(propagator propagation.TextMapPropagator)
- func SetTracerProvider(tp trace.TracerProvider)
- func Tracer(name string, opts ...trace.TracerOption) trace.Tracer
- func Version() string
- type ErrorHandler
- type ErrorHandlerFunc
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetLoggerProvider ¶
func GetLoggerProvider() log.LoggerProvider
GetLoggerProvider returns the globally configured log.LoggerProvider.
If a global LoggerProvider has not been configured with SetLoggerProvider, the returned LoggerProvider will be a No-Op implementation. When a global LoggerProvider is registered for the first time, the returned LoggerProvider and all Loggers it has created are updated in place. There is no need to call this function again for an updated instance.
func GetMeterProvider ¶ added in v0.14.0
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 ¶ added in v0.14.0
func GetTextMapPropagator() propagation.TextMapPropagator
GetTextMapPropagator returns the global TextMapPropagator. If none has been set, a No-Op TextMapPropagator is returned.
func GetTracerProvider ¶ added in v0.14.0
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 ¶ added in v0.14.0
func Handle(err error)
Handle is a convenience function for GetErrorHandler().Handle(err).
func Logger ¶
func Logger(name string, options ...log.LoggerOption) log.Logger
Logger returns a log.Logger configured with the provided name and options from the globally configured log.LoggerProvider.
If this is called before a global LoggerProvider is configured, the returned Logger will be a No-Op implementation of a Logger. When a global LoggerProvider is registered for the first time, the returned Logger is updated in place to report to this new LoggerProvider. There is no need to call this function again for an updated instance.
This is a convenience function. It is equivalent to:
GetLoggerProvider().Logger(name, options...)