README
¶
OpenTelemetry-Go
The Go OpenTelemetry implementation.
Getting Started
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.
Project Status
Project boards and milestones can be found at the respective links. We try to keep these accurate and should be the best place to go for answers on project status.
Contributing
See the contributing documentation.
Documentation
¶
Overview ¶
Package otel contains OpenTelemetry Go packages.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorHandler ¶ added in v0.11.0
type ErrorHandler interface {
// Handle handles any error deemed irremediable by an OpenTelemetry
// component.
Handle(error)
}
ErrorHandler handles irremediable events.
type Propagators ¶
type Propagators = propagation.Propagators
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
apitest
Package apitest provides utilities for testing.
|
Package apitest provides utilities for testing. |
|
baggage
Package baggage provides types and utilities for baggage features.
|
Package baggage provides types and utilities for baggage features. |
|
global
Package global provides global providers, propagators and more.
|
Package global provides global providers, propagators and more. |
|
metric
Package metric provides support for reporting measurements using instruments.
|
Package metric provides support for reporting measurements using instruments. |
|
metric/metrictest
Package metrictest contains utilities for testing metrics.
|
Package metrictest contains utilities for testing metrics. |
|
propagation
Package propagation provides support for propagating context over HTTP.
|
Package propagation provides support for propagating context over HTTP. |
|
trace
Package trace provides tracing support.
|
Package trace provides tracing support. |
|
trace/tracetest
Package tracetest provides testing utilities for tracing.
|
Package tracetest provides testing utilities for tracing. |
|
bridge
|
|
|
opencensus
Module
|
|
|
opencensus/examples/bridge
Module
|
|
|
opencensus/opencensusmetric
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
|
|
|
dice
Module
|
|
|
fib
Module
|
|
|
grpc
Module
|
|
|
http
Module
|
|
|
http-stackdriver
Module
|
|
|
jaeger
Module
|
|
|
namedtracer
Module
|
|
|
opencensus
Module
|
|
|
otel-collector
Module
|
|
|
passthrough
Module
|
|
|
prom-collector
Module
|
|
|
prometheus
Module
|
|
|
view
Module
|
|
|
zipkin
Module
|
|
|
exporter
|
|
|
metric/prometheus
Module
|
|
|
trace/jaeger
Module
|
|
|
trace/stackdriver
Module
|
|
|
exporters
|
|
|
jaeger
Module
|
|
|
metric/prometheus
Module
|
|
|
otlp
Module
|
|
|
otlp/internal/retry
Module
|
|
|
otlp/otlplog/otlploghttp
Module
|
|
|
otlp/otlpmetric
Module
|
|
|
otlp/otlptrace
Module
|
|
|
otlp/otlptrace/otlptracegrpc
Module
|
|
|
otlp/otlptrace/otlptracehttp
Module
|
|
|
prometheus
Module
|
|
|
stdout
Module
|
|
|
stdout/stdoutlog
Module
|
|
|
stdout/stdoutmetric
Module
|
|
|
stdout/stdouttrace
Module
|
|
|
trace/jaeger
Module
|
|
|
trace/stackdriver
Module
|
|
|
trace/zipkin
Module
|
|
|
zipkin
Module
|
|
|
trace/noop
Package noop provides noop tracing implementations for tracer and span.
|
Package noop provides noop tracing implementations for tracer and span. |
|
metric
Module
|
|
|
tools
Module
|
|
|
Package label provides key and value labels.
|
Package label provides key and value labels. |
|
log
module
|
|
|
metric
module
|
|
|
oteltest
module
|
|
|
Package propagators contains OpenTelemetry context propagators.
|
Package propagators contains OpenTelemetry context propagators. |
|
schema
module
|
|
|
sdk
module
|
|
|
export/metric
Module
|
|
|
log
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. |