telemetry

Documentation

Index

• Variables
• func BytesMeasure(pkg string, meterName string, description string) metric.Int64Counter
• func CounterView(pkg string, meterName string, description string) []sdkmetric.View
• func DimensionlessMeasure(pkg string, meterName string, description string) metric.Int64Counter
• func ErrorCode(err error) string
• func LatencyMeasure(pkg string) metric.Float64Histogram
• func Views(pkg string) []sdkmetric.View
• type Manager
  • func NewManager(ctx context.Context, cfg config.ConfigurationTelemetry, opts ...Option) Manager
• type Option
  • func WithDisableTracing() Option
  • func WithMetricsReader(reader sdkmetrics.Reader) Option
  • func WithPropagationTextMap(carrier propagation.TextMapPropagator) Option
  • func WithServiceEnvironment(env string) Option
  • func WithServiceName(name string) Option
  • func WithServiceVersion(version string) Option
  • func WithTraceExporter(exporter sdktrace.SpanExporter) Option
  • func WithTraceLogsExporter(exporter sdklogs.Exporter) Option
  • func WithTraceSampler(sampler sdktrace.Sampler) Option
• type Tracer
  • func NewTracer(name string, options ...trace.TracerOption) Tracer

Variables

var (
	AttrMethodKey  = attribute.Key("frame_method")
	AttrPackageKey = attribute.Key("frame_package")
	AttrStatusKey  = attribute.Key("frame_status")
	AttrErrorKey   = attribute.Key("frame_error")
)

Common attribute keys used across the frame.

Functions

func BytesMeasure

func BytesMeasure(pkg string, meterName string, description string) metric.Int64Counter

BytesMeasure creates a counter for bytes measurements.

func CounterView

func CounterView(pkg string, meterName string, description string) []sdkmetric.View

CounterView returns summation views that add up individual measurements the counter takes.

func DimensionlessMeasure

func DimensionlessMeasure(pkg string, meterName string, description string) metric.Int64Counter

DimensionlessMeasure creates a simple counter specifically for dimensionless measurements.

func ErrorCode

func ErrorCode(err error) string

func LatencyMeasure

func LatencyMeasure(pkg string) metric.Float64Histogram

LatencyMeasure returns the measure for method call latency used by Go CDK APIs.

func Views

func Views(pkg string) []sdkmetric.View

Types

type Manager

type Manager interface {
	Init(ctx context.Context) error
	Disabled() bool
	LogHandler() slog.Handler
}

func NewManager

func NewManager(ctx context.Context, cfg config.ConfigurationTelemetry, opts ...Option) Manager

NewManager creates a new telemetry setup manager.

type Option

type Option func(ctx context.Context, m *manager)

func WithDisableTracing

func WithDisableTracing() Option

WithDisableTracing disable tracing for the service.

func WithMetricsReader

func WithMetricsReader(reader sdkmetrics.Reader) Option

WithMetricsReader specifies the metrics reader for the service.

func WithPropagationTextMap

func WithPropagationTextMap(carrier propagation.TextMapPropagator) Option

WithPropagationTextMap specifies the trace baggage carrier exporter to use.

func WithServiceEnvironment

func WithServiceEnvironment(env string) Option

WithServiceEnvironment sets the service environment for resource tagging.

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the service name for resource tagging.

func WithServiceVersion

func WithServiceVersion(version string) Option

WithServiceVersion sets the service version for resource tagging.

func WithTraceExporter

func WithTraceExporter(exporter sdktrace.SpanExporter) Option

WithTraceExporter specifies the trace exporter to use.

func WithTraceLogsExporter

func WithTraceLogsExporter(exporter sdklogs.Exporter) Option

WithTraceLogsExporter specifies the trace logs exporter for the service.

func WithTraceSampler

func WithTraceSampler(sampler sdktrace.Sampler) Option

WithTraceSampler specifies the trace sampler to use.

type Tracer

type Tracer interface {
	Start(ctx context.Context, methodName string, options ...trace.SpanStartOption) (context.Context, trace.Span)
	End(ctx context.Context, span trace.Span, err error, options ...trace.SpanEndOption)
}

func NewTracer

func NewTracer(name string, options ...trace.TracerOption) Tracer

NewTracer creates a new tracer for a package.