observability

Documentation

Index

• Constants
• func FlushSpanBuffer(ctx context.Context) error
• func Shutdown(ctx context.Context) error
• func Start(serviceName string) error

Constants

const OtelLogsEnvVar = "KUBEARCHIVE_OTLP_SEND_LOGS"

const OtelMetricsInterval = "KUBEARCHIVE_METRICS_INTERVAL"

const OtelStartEnvVar = "KUBEARCHIVE_OTEL_MODE"

the name of the environment variable that will determine if instrumentation needs to be started

Functions

func FlushSpanBuffer

func FlushSpanBuffer(ctx context.Context) error

FlushSpanBuffer exports all completed spans that have not been exported for all SpanProcessors registered with the global TracerProvider. If the provided context has a timeout or a deadline, it will be respected.

func Shutdown

func Shutdown(ctx context.Context) error

Shutdown shuts down the TracerProvider, any SpanProcessors that have been registered, and exporters associated with the SpanProcessors. This should only be called after all spans have been ended. After this function is called, spans cannot be created, ended or modified.

func Start

func Start(serviceName string) error

Start creates a Span Processor and exporter, registers them with a TracerProvider, and sets the default TracerProvider and SetTextMapPropagator