otel

package module
Version: v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 20, 2021 License: Apache-2.0 Imports: 7 Imported by: 462

README

OpenTelemetry-Go

CI codecov.io PkgGoDev Go Report Card Slack

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 Project
Traces Stable N/A
Metrics Alpha N/A
Logs Frozen [1] N/A
  • [1]: The Logs signal development is halted for this project while we develop both Traces and Metrics. No Logs Pull Requests are currently being accepted.

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.

Compatibility

This project is tested on the following systems.

OS Go Version Architecture
Ubuntu 1.16 amd64
Ubuntu 1.15 amd64
Ubuntu 1.16 386
Ubuntu 1.15 386
MacOS 1.16 amd64
MacOS 1.15 amd64
Windows 1.16 amd64
Windows 1.15 amd64
Windows 1.16 386
Windows 1.15 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.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.

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

Exporter Metrics Traces
Jaeger
OTLP
Prometheus
stdout
Zipkin

Additionally, OpenTelemetry community supported exporters can be found in the contrib repository.

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/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 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 ErrorHandler().Handle(err)

func SetErrorHandler added in v0.14.0

func SetErrorHandler(h ErrorHandler)

SetErrorHandler sets the global ErrorHandler to h.

The first time this is called all ErrorHandler previously returned from GetErrorHandler will send errors to h instead of the default logging ErrorHandler. Subsequent calls will set the global ErrorHandler, but not delegate errors to h.

func SetTextMapPropagator added in v0.14.0

func SetTextMapPropagator(propagator propagation.TextMapPropagator)

SetTextMapPropagator sets propagator as the global TextMapPropagator.

func SetTracerProvider added in v0.14.0

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 added in v0.14.0

func Version() string

Version is the current release version of OpenTelemetry in use.

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.

func GetErrorHandler added in v0.14.0

func GetErrorHandler() ErrorHandler

GetErrorHandler returns the global ErrorHandler instance.

The default ErrorHandler instance returned will log all errors to STDERR until an override ErrorHandler is set with SetErrorHandler. All ErrorHandler returned prior to this will automatically forward errors to the set instance instead of logging.

Subsequent calls to SetErrorHandler after the first will not forward errors to the new ErrorHandler for prior returned instances.

type ErrorHandlerFunc added in v1.0.0

type ErrorHandlerFunc func(error)

ErrorHandlerFunc is a convenience adapter to allow the use of a function as an ErrorHandler.

func (ErrorHandlerFunc) Handle added in v1.0.0

func (f ErrorHandlerFunc) Handle(err error)

Handle handles the irremediable error by calling the ErrorHandlerFunc itself.

Directories

Path Synopsis
Package attribute provides key and value attributes.
Package attribute provides key and value attributes.
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
fib Module
grpc Module
http Module
jaeger Module
namedtracer Module
opencensus Module
passthrough Module
prometheus Module
zipkin Module
exporter
trace/jaeger Module
exporters
jaeger Module
otlp Module
prometheus Module
stdout Module
trace/jaeger Module
trace/zipkin Module
zipkin Module
metric module
oteltest module
Package propagation contains OpenTelemetry context propagators.
Package propagation contains OpenTelemetry context propagators.
sdk module
export/metric Module
metric Module
semconv
v1.4.0
Package semconv implements OpenTelemetry semantic conventions.
Package semconv implements OpenTelemetry semantic conventions.
trace module
baggage
Package baggage provides base types and functionality to store and retrieve baggage in Go context.
Package baggage provides base types and functionality to store and retrieve baggage in Go context.
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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL