o11y

Documentation

Overview

Package o11y is the primary entrypoint for wiring up a standard configuration of the o11y observability system.

Index

• func DevInit()
• func Setup(ctx context.Context, o Config) (context.Context, func(context.Context), error)
• type Config

Functions

func DevInit

func DevInit()

DevInit is some crazy hackery to handle the fact that the beeline lib uses a singleton shared client that we cant simply guard with sync once, since we are not coordinating the calls to close. Instead we route the setup through here where we can create the provider once and coordinate the closes. Other Approaches: 1. We could protect beeline init (from the races) and then not close beeline in dev mode or sync once the close call but that would still mean doing something like this interceptor.

2. A stand alone development stack launcher of some sort. This would probably be the most correct in terms of running like production, but it adds some complexity to developer testing.

3. Instead of this mess we would have to implement beeline ourselves in a way that has a single client. we could do that and attempt to upstream the PR, but this is a fair amount of effort.

This small wrapper is only in the code init flow, and once seen and understood can be forgotten, so it was considered OK to keep for now.

If the coordinator is nil (for example if DevInit is not called as per production) then we immediately defer to the real setup

func Setup

func Setup(ctx context.Context, o Config) (context.Context, func(context.Context), error)

Setup is the primary entrypoint to initialise the o11y system both in development and production.

To support projects with monobinaries, DevInit can be called first.

Types

type Config

type Config struct {
	Statsd            string
	RollbarToken      secret.String
	RollbarEnv        string
	RollbarServerRoot string
	HoneycombEnabled  bool
	HoneycombDataset  string
	HoneycombKey      secret.String
	SampleTraces      bool
	SampleKeyFunc     func(map[string]interface{}) string
	SampleRates       map[string]int
	Format            string
	Version           string
	Service           string
	StatsNamespace    string

	// Optional
	Mode                    string
	Debug                   bool
	RollbarDisabled         bool
	StatsdTelemetryDisabled bool
}