autoexport

Documentation

Overview

Package autoexport provides OpenTelemetry exporter factory functions with defaults and environment variable support as defined by the OpenTelemetry specification.

Index

• func IsNoneMetricReader(e metric.Reader) bool
• func IsNoneSpanExporter(e trace.SpanExporter) bool
• func NewMetricReader(ctx context.Context, opts ...MetricOption) (metric.Reader, error)
• func NewSpanExporter(ctx context.Context, opts ...SpanOption) (trace.SpanExporter, error)
• func RegisterMetricReader(name string, factory func(context.Context) (metric.Reader, error))
• func RegisterSpanExporter(name string, factory func(context.Context) (trace.SpanExporter, error))
• type MetricOption
  • func WithFallbackMetricReader(metricReaderFactory func(ctx context.Context) (metric.Reader, error)) MetricOption
• type Option
• type SpanOption
  • func WithFallbackSpanExporter(spanExporterFactory func(ctx context.Context) (trace.SpanExporter, error)) SpanOption

Functions

func IsNoneMetricReader

func IsNoneMetricReader(e metric.Reader) bool

IsNoneMetricReader returns true for the exporter returned by NewMetricReader when OTEL_METRICS_EXPORTER environment variable is set to "none".

func IsNoneSpanExporter

func IsNoneSpanExporter(e trace.SpanExporter) bool

IsNoneSpanExporter returns true for the exporter returned by NewSpanExporter when OTEL_TRACES_EXPORTER environment variable is set to "none".

func NewMetricReader

func NewMetricReader(ctx context.Context, opts ...MetricOption) (metric.Reader, error)

NewMetricReader returns a configured go.opentelemetry.io/otel/sdk/metric.Reader defined using the environment variables described below.

OTEL_METRICS_EXPORTER defines the metrics exporter; supported values:

• "none" - "no operation" exporter
• "otlp" (default) - OTLP exporter; see go.opentelemetry.io/otel/exporters/otlp/otlpmetric
• "prometheus" - Prometheus exporter + HTTP server; see go.opentelemetry.io/otel/exporters/prometheus
• "console" - Standard output exporter; see go.opentelemetry.io/otel/exporters/stdout/stdoutmetric

OTEL_EXPORTER_OTLP_PROTOCOL defines OTLP exporter's transport protocol; supported values:

• "grpc" - protobuf-encoded data using gRPC wire format over HTTP/2 connection; see: go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc
• "http/protobuf" (default) - protobuf-encoded data over HTTP connection; see: go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp

OTEL_EXPORTER_PROMETHEUS_HOST (defaulting to "localhost") and OTEL_EXPORTER_PROMETHEUS_PORT (defaulting to 9464) define the host and port for the Prometheus exporter's HTTP server.

An error is returned if an environment value is set to an unhandled value.

Use RegisterMetricReader to handle more values of OTEL_METRICS_EXPORTER.

Use WithFallbackMetricReader option to change the returned exporter when OTEL_METRICS_EXPORTER is unset or empty.

Use IsNoneMetricReader to check if the retured exporter is a "no operation" exporter.

func NewSpanExporter

func NewSpanExporter(ctx context.Context, opts ...SpanOption) (trace.SpanExporter, error)

NewSpanExporter returns a configured go.opentelemetry.io/otel/sdk/trace.SpanExporter defined using the environment variables described below.

OTEL_TRACES_EXPORTER defines the traces exporter; supported values:

• "none" - "no operation" exporter
• "otlp" (default) - OTLP exporter; see go.opentelemetry.io/otel/exporters/otlp/otlptrace
• "console" - Standard output exporter; see go.opentelemetry.io/otel/exporters/stdout/stdouttrace

OTEL_EXPORTER_OTLP_PROTOCOL defines OTLP exporter's transport protocol; supported values:

• "grpc" - protobuf-encoded data using gRPC wire format over HTTP/2 connection; see: go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc
• "http/protobuf" (default) - protobuf-encoded data over HTTP connection; see: go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp

An error is returned if an environment value is set to an unhandled value.

Use RegisterSpanExporter to handle more values of OTEL_TRACES_EXPORTER.

Use WithFallbackSpanExporter option to change the returned exporter when OTEL_TRACES_EXPORTER is unset or empty.

Use IsNoneSpanExporter to check if the retured exporter is a "no operation" exporter.

func RegisterMetricReader

func RegisterMetricReader(name string, factory func(context.Context) (metric.Reader, error))

RegisterMetricReader sets the MetricReader factory to be used when the OTEL_METRICS_EXPORTERS environment variable contains the exporter name. This will panic if name has already been registered.

func RegisterSpanExporter

func RegisterSpanExporter(name string, factory func(context.Context) (trace.SpanExporter, error))

RegisterSpanExporter sets the SpanExporter factory to be used when the OTEL_TRACES_EXPORTERS environment variable contains the exporter name. This will panic if name has already been registered.

Types

type MetricOption

type MetricOption = option[metric.Reader]

MetricOption applies an autoexport configuration option.

func WithFallbackMetricReader

func WithFallbackMetricReader(metricReaderFactory func(ctx context.Context) (metric.Reader, error)) MetricOption

WithFallbackMetricReader sets the fallback exporter to use when no exporter is configured through the OTEL_METRICS_EXPORTER environment variable.

type Option

type Option = SpanOption

Option applies an autoexport configuration option.

Deprecated: Use SpanOption.

type SpanOption

type SpanOption = option[trace.SpanExporter]

SpanOption applies an autoexport configuration option.

func WithFallbackSpanExporter

func WithFallbackSpanExporter(spanExporterFactory func(ctx context.Context) (trace.SpanExporter, error)) SpanOption

WithFallbackSpanExporter sets the fallback exporter to use when no exporter is configured through the OTEL_TRACES_EXPORTER environment variable.