telemetry

Documentation

Index

• Constants
• Variables
• func DebugMode() bool
• func IsEnabled(t trace.Tracer) bool
• func ResourceServiceName(rsn primitives.ServiceName, envVars envVarLookup) string
• func SpanExportersFromEnv(envVars envVarLookup) (map[SpanExporterType]otelsdktrace.SpanExporter, error)
• type ClientStatsHandler
  • func NewClientStatsHandler(tp trace.TracerProvider, tmp propagation.TextMapPropagator) ClientStatsHandler
• type ExportConfig
  • func (ec *ExportConfig) MetricExporters() ([]metric.Exporter, error)
  • func (ec *ExportConfig) SpanExporters() (map[SpanExporterType]otelsdktrace.SpanExporter, error)
  • func (ec *ExportConfig) UnmarshalYAML(n *yaml.Node) error
• type ServerStatsHandler
  • func NewServerStatsHandler(tp trace.TracerProvider, tmp propagation.TextMapPropagator, logger log.Logger) ServerStatsHandler
• type SpanExporterType

Constants

const (
	OtelServiceNameEnvKey                = "OTEL_SERVICE_NAME"
	OtelTracesExporterTypesEnvKey        = "OTEL_TRACES_EXPORTER"
	OtelTracesOtlpExporterType           = SpanExporterType("otlp")
	OtelExporterOtlpTracesProtocolEnvKey = "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL"
	OtelExporterOtlpTracesGrcpProtocol   = "grpc"
)

const (
	ComponentPersistence     = "persistence"
	ComponentQueueArchival   = "queue.archival"
	ComponentQueueMemory     = "queue.memory"
	ComponentQueueOutbound   = "queue.outbound"
	ComponentQueueTimer      = "queue.timer"
	ComponentQueueTransfer   = "queue.transfer"
	ComponentQueueVisibility = "queue.visibility"
	ComponentUpdateRegistry  = "update.registry"

	WorkflowIDKey    = "temporalWorkflowID"
	WorkflowRunIDKey = "temporalRunID"
)

Variables

var (
	NoopTracerProvider = otelnoop.NewTracerProvider()
	NoopTracer         = NoopTracerProvider.Tracer("")
)

Functions

func DebugMode

func DebugMode() bool

func IsEnabled

func IsEnabled(t trace.Tracer) bool

func ResourceServiceName

func ResourceServiceName(
	rsn primitives.ServiceName,
	envVars envVarLookup,
) string

ResourceServiceName returns the OpenTelemetry tracing service name for a Temporal service.

func SpanExportersFromEnv

func SpanExportersFromEnv(
	envVars envVarLookup,
) (map[SpanExporterType]otelsdktrace.SpanExporter, error)

SpanExportersFromEnv creates OTEL span exporters from environment variables.

Types

type ClientStatsHandler

type ClientStatsHandler stats.Handler

ClientStatsHandler gives a named type to the grpc.UnaryClientInterceptor implementation provided by otelgrpc.

func NewClientStatsHandler

func NewClientStatsHandler(
	tp trace.TracerProvider,
	tmp propagation.TextMapPropagator,
) ClientStatsHandler

NewClientStatsHandler creates a new gRPC stats handler that tracks each request with an encapsulating span using the provided TracerProvider and TextMapPropagator.

NOTE: If the TracerProvider is `noop.TracerProvider`, it returns `nil`.

type ExportConfig

type ExportConfig struct {
	// contains filtered or unexported fields
}

ExportConfig represents YAML structured configuration for a set of OTEL trace/span/log exporters.

func (*ExportConfig) MetricExporters

func (ec *ExportConfig) MetricExporters() ([]metric.Exporter, error)

func (*ExportConfig) SpanExporters

func (ec *ExportConfig) SpanExporters() (map[SpanExporterType]otelsdktrace.SpanExporter, error)

func (*ExportConfig) UnmarshalYAML

func (ec *ExportConfig) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML loads the state of an ExportConfig from parsed YAML

type ServerStatsHandler

type ServerStatsHandler stats.Handler

ServerStatsHandler gives a named type to the stats.Handler implementation provided by otelgrpc.

func NewServerStatsHandler

func NewServerStatsHandler(
	tp trace.TracerProvider,
	tmp propagation.TextMapPropagator,
	logger log.Logger,
) ServerStatsHandler

NewServerStatsHandler creates a new gRPC stats handler that tracks each request with an encapsulating span using the provided TracerProvider and TextMapPropagator.

NOTE: If the TracerProvider is `noop.TracerProvider`, it returns `nil`.

type SpanExporterType

type SpanExporterType string