telemetry

Documentation

Index

• func EndWithStatus(span trace.Span, err error)
• type Telemetry
  • func New(ctx context.Context, cfg *config.Config) (tele Telemetry, err error)
  • func (te *Telemetry) Close() error

Functions

func EndWithStatus

func EndWithStatus(span trace.Span, err error)

EndWithStatus ends the span with the status of the error if not nil otherwise it will set the status to OK.

This function should be used for ending spans, not for starting spans or spans that will have children, to avoid duplicate error recordings.

Do not defer this function directly since err might be nil at the start of defer call. Instead it should be wrapped in a function to capture the error correctly.

Example:

var err error
ctx, span := tracer.Start(ctx, "my-operation")
defer func() { telemetry.EndWithStatus(span, err) }()

Types

type Telemetry

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

func New

func New(ctx context.Context, cfg *config.Config) (tele Telemetry, err error)

func (*Telemetry) Close

func (te *Telemetry) Close() error