telemetry

Documentation

Index

• func Enable(ctx context.Context) (context.Context, context.CancelFunc)
• func EnableWith(ctx context.Context, opts *Options) (context.Context, context.CancelFunc)
• type Options
  • func ExtractOptions(ctx context.Context) *Options

Functions

func Enable

func Enable(ctx context.Context) (context.Context, context.CancelFunc)

Enable will attach default telemetry information to the ctx so telemetry will be reported during the project lifecycle.

func EnableWith

func EnableWith(ctx context.Context, opts *Options) (context.Context, context.CancelFunc)

EnableWith will attach custom telemetry information to the ctx.

Types

type Options

type Options struct {
	Endpoint    string
	Application string
}

Options specify telemetry client options.

func ExtractOptions

func ExtractOptions(ctx context.Context) *Options

ExtractOptions returns a bool whether the context has telemetry enabled and the options set.