cloudotel

Documentation

Overview

Package cloudotel provides primitives for OpenTelemetry.

Index

• func NewErrorLogger(logger *zap.Logger, level zapcore.Level, message string) otel.ErrorHandler
• func NewResource(ctx context.Context) (*resource.Resource, error)
• func RegisterErrorHandler(ctx context.Context)
• func StartMetricExporter(ctx context.Context, exporterConfig MetricExporterConfig, ...) (func(), error)
• func StartTraceExporter(ctx context.Context, exporterConfig TraceExporterConfig, ...) (func(), error)
• type MetricExporterConfig
• type TraceExporterConfig

Functions

func NewErrorLogger

func NewErrorLogger(logger *zap.Logger, level zapcore.Level, message string) otel.ErrorHandler

NewErrorLogger returns a new otel.ErrorHandler that logs errors using the provided logger, level and message.

func NewResource

func NewResource(ctx context.Context) (*resource.Resource, error)

NewResource creates and detects attributes for a new OpenTelemetry resource.

func RegisterErrorHandler

func RegisterErrorHandler(ctx context.Context)

RegisterErrorHandler registers a global OpenTelemetry error handler.

func StartMetricExporter

func StartMetricExporter(
	ctx context.Context,
	exporterConfig MetricExporterConfig,
	resource *resource.Resource,
) (func(), error)

StartMetricExporter starts the OpenTelemetry Cloud Monitoring exporter.

func StartTraceExporter

func StartTraceExporter(
	ctx context.Context,
	exporterConfig TraceExporterConfig,
	resource *resource.Resource,
) (func(), error)

StartTraceExporter starts the OpenTelemetry Cloud Trace exporter.

Types

type MetricExporterConfig

type MetricExporterConfig struct {
	Enabled                bool          `onGCE:"false"`
	Interval               time.Duration `default:"60s"`
	RuntimeInstrumentation bool          `onGCE:"true"`
	HostInstrumentation    bool          `onGCE:"true"`
	OpenCensusProducer     bool          `default:"false"`
}

MetricExporterConfig configures the metrics exporter.

type TraceExporterConfig

type TraceExporterConfig struct {
	Enabled           bool          `onGCE:"true"`
	Timeout           time.Duration `default:"10s"`
	SampleProbability float64       `default:"0.01"`
}

TraceExporterConfig configures the trace exporter.