observe

Documentation

Overview

Package observe implements a type that combines statter, logger and tracer.

Example usage:

obsrv, err := observe.New(ctx, cliCmd, &observe.Options{})
if err != nil {
	// Handle error.
	return
}

Index

• type Observer
  • func New(ctx context.Context, cliCmd *cli.Command, svc string, opts *Options) (*Observer, error)
  • func NewFake() *Observer
  • func (o *Observer) Close()
  • func (o *Observer) Tracer(name string, opts ...trace.TracerOption) trace.Tracer
• type Options

Examples

• New

Types

type Observer

type Observer struct {
	Log       *logger.Logger
	Stats     *statter.Statter
	TraceProv trace.TracerProvider
	// contains filtered or unexported fields
}

Observer contains observability primitives.

func New

func New(ctx context.Context, cliCmd *cli.Command, svc string, opts *Options) (*Observer, error)

New returns an observer with the given observability primitives.

Example

var (
	ctx    context.Context
	cliCmd *cli.Command // Get this from your action
)

obsrv, err := observe.New(ctx, cliCmd, "my-service", &observe.Options{})
if err != nil {
	// Handle error.
	return
}

_ = obsrv

func NewFake

func NewFake() *Observer

NewFake returns a fake observer that reports nothing. This is useful for tests.

func (*Observer) Close

func (o *Observer) Close()

Close closes the observability primitives.

func (*Observer) Tracer

func (o *Observer) Tracer(name string, opts ...trace.TracerOption) trace.Tracer

Tracer returns a tracer with the given name and options. If no trace provider has been set, this function will panic.

type Options

type Options struct {
	LogTimeFormat string
	LogTimestamps bool
	LogCtx        []logger.Field
	LogWriter     io.Writer

	StatsRuntime bool
	StatsTags    []statter.Tag

	TracingAttrs []attribute.KeyValue
}

Options optionally configures an observer.