otelutil

package

v0.32.13 Latest Latest Go to latest Published: Jun 16, 2025 License: Unlicense Imports: 17 Imported by: 0

Details

Package otelutil contains common utilities for working with OpenTelemetry.

View Source

const (
	ExporterProtoGRPC         = "grpc"
	ExporterProtoHTTPProtobuf = "http/protobuf"
	ExporterProtoStdout       = "stdout"
)

Supported OpenTelemetry exporter protocols that are expected to be present in the environment under EnvExporterProto.

View Source

const EnvExporterProto = "OTEL_EXPORTER_OTLP_PROTOCOL"

EnvExporterProto is the name of the environment variable holding the OpenTelemetry exporter protocol.

This section is empty.

func EndSpan(span trace.Span, err error)

EndSpan is a deferred helper that records the error sets the status of the span before ending it.

func Init(ctx context.Context, c *Config) (svc service.Interface, err error)

Init initializes the global OpenTelemetry infrastructure. svc is the service that should be shut down on exit. c must be valid.

TODO(a.garipov): See if there are ways to not use globals.

func StartSpanf(
	parent context.Context,
	tracer trace.Tracer,
	spanNameFmt string,
	args ...any,
) (ctx context.Context, span trace.Span)

StartSpanf is a helper for formatted span names.

type Config struct {
	// ServiceName is the name to use for exporting traces.  It must not be
	// empty.
	ServiceName string
}

Config is the configuration structure for the OpenTelemetry infrastructure.

func (c *Config) Validate() (err error)

Validate implements the validate.Interface for *Config. c may be nil.