observe

Documentation

Overview

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

Example usage:

	func newObserver(c *cli.Context) (*observe.Observer, error) {
	    log, err := cmd.NewLogger(c)
	    if err != nil {
	    	return nil, err
	    }

	    stats, err := cmd.NewStatter(c, log)
	    if err != nil {
	    	return nil, err
	    }

	    prof, err := cmd.NewProfiler(c, "my-service", log)
	    if err != nil {
	    	return nil, err
	    }
	    profStop := func() {}
	    if prof != nil {
	    	profStop = func() { _ = prof.Stop() }
	    }

	    tracer, err := cmd.NewTracer(c, log,
	    	semconv.ServiceNameKey.String("my-service"),
	    	semconv.ServiceVersionKey.String("1.0.0"),
	    )
	    if err != nil {
	    	return nil, err
	    }
	    tracerCancel := func() { _ = tracer.Shutdown(context.Background()) }

	    return observe.New(log, stats, tracer, tracerCancel, profStop), nil
    }

Index

• type Observer
  • func New(log *logger.Logger, stats *statter.Statter, traceProv trace.TracerProvider, ...) *Observer
  • func NewFake() *Observer
  • func NewFromCLI(cliCtx *cli.Context, svc string, opts *Options) (*Observer, error)
  • func (o *Observer) Close()
  • func (o *Observer) Tracer(name string, opts ...trace.TracerOption) trace.Tracer
• type Options

Examples

• New
• NewFromCLI

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(log *logger.Logger, stats *statter.Statter, traceProv trace.TracerProvider, closeFns ...func()) *Observer

New returns an observer with the given observability primitives.

Example

var c *cli.Context // Get this from your action

log, err := cmd.NewLogger(c)
if err != nil {
	// Handle error.
	return
}

stats, err := cmd.NewStatter(c, log)
if err != nil {
	// Handle error.
	return
}

prof, err := cmd.NewProfiler(c, "my-service", log)
if err != nil {
	return
}
profStop := func() {}
if prof != nil {
	profStop = func() { _ = prof.Stop() }
}

tracer, err := cmd.NewTracer(c, log,
	semconv.ServiceNameKey.String("my-service"),
	semconv.ServiceVersionKey.String("1.0.0"),
)
if err != nil {
	// Handle error.
	return
}
tracerCancel := func() { _ = tracer.Shutdown(context.Background()) }

obsrv := observe.New(log, stats, tracer, tracerCancel, profStop)

_ = obsrv

func NewFake

func NewFake() *Observer

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

func NewFromCLI

func NewFromCLI(cliCtx *cli.Context, svc string, opts *Options) (*Observer, error)

NewFromCLI returns an observer with the given observability primitives.

Example

var c *cli.Context // Get this from your action.

obsrv, err := observe.NewFromCLI(c, "my-service", &observe.Options{
	LogTimestamps: true,
	StatsRuntime:  true,
	TracingAttrs: []attribute.KeyValue{
		semconv.ServiceVersionKey.String("1.0.0"),
	},
})
if err != nil {
	// Handle error.
	return
}

_ = obsrv

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

	StatsRuntime bool
	StatsTags    []statter.Tag

	TracingAttrs []attribute.KeyValue
}

Options optionally configures an observer.