tele

Documentation

Index

• func StartSpanWithLogger(ctx context.Context, spanName string, opts ...Option) (context.Context, logr.Logger, func())
• func Tracer() trace.Tracer
• type Config
• type CorrID
  • func CorrIDFromCtx(ctx context.Context) (CorrID, bool)
• type CorrIDKey
• type Option
  • func KVP(key, value string) Option

Functions

func StartSpanWithLogger

func StartSpanWithLogger(
	ctx context.Context,
	spanName string,
	opts ...Option,
) (context.Context, logr.Logger, func())

StartSpanWithLogger starts a new span with the global tracer returned from Tracer(), then returns a new logger implementation that composes both the logger from the given ctx and a logger that logs to the newly created span.

Callers should make sure to call the function in the 3rd return value to ensure that the span is ended properly. In many cases, that can be done with a defer:

ctx, lggr, done := StartSpanWithLogger(ctx, "my-span")
defer done()

func Tracer

func Tracer() trace.Tracer

Tracer returns an OpenTelemetry Tracer implementation to be used to create spans. If you need access to the raw globally-registered tracer, use this function.

Most people should not use this function directly, however. Instead, consider using StartSpanWithLogger, which uses this tracer to start a new span, configures logging, and more.

Example usage:

ctx, span := tele.Tracer().Start(ctx, "myFunction")
defer span.End()
// use the span and context here

Types

type Config

type Config struct {
	KVPs map[string]string
}

Config holds optional, arbitrary configuration information to be added to logs and telemetry data. Instances of Config get passed to StartSpanWithLogger via the KVP function.

type CorrID

type CorrID string

CorrID is a correlation ID that the cluster API provider sends with all API requests to Azure. Do not create one of these manually. Instead, use the CtxWithCorrelationID function to create one of these within a context.Context.

func CorrIDFromCtx

func CorrIDFromCtx(ctx context.Context) (CorrID, bool)

CorrIDFromCtx attempts to fetch a correlation ID from the given context.Context. If none exists, returns an empty CorrID and false. Otherwise returns the CorrID value and true.

type CorrIDKey

type CorrIDKey string

CorrIDKey is the type of the key used to store correlation IDs in context.Contexts.

const CorrIDKeyVal CorrIDKey = "x-ms-correlation-request-id"

CorrIDKeyVal is the key used to store the correlation ID in context.Contexts, HTTP headers, and other similar locations.

type Option

type Option func(*Config)

Option is the modifier function used to configure StartSpanWithLogger. Generally speaking, you should not create your own option function. Instead, use built-in functions (like KVP) that create them.

func KVP

func KVP(key, value string) Option

KVP returns a new Option function that adds a the given key-value pair.