app

Documentation

Overview

Package app implements OTEL, prometheus, graceful shutdown and other common application features for go-faster projects.

Index

• func Resource(ctx context.Context) (*resource.Resource, error)
• func Run(f func(ctx context.Context, lg *zap.Logger, m *Metrics) error, op ...Option)
• type Metrics
  • func (m *Metrics) MeterProvider() metric.MeterProvider
  • func (m *Metrics) String() string
  • func (m *Metrics) TextMapPropagator() propagation.TextMapPropagator
  • func (m *Metrics) TracerProvider() trace.TracerProvider
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithMeterOptions(opts ...autometer.Option) Option
  • func WithResource(fn func(ctx context.Context) (*resource.Resource, error)) Option
  • func WithTracerOptions(opts ...autotracer.Option) Option
  • func WithZapConfig(cfg zap.Config) Option
  • func WithZapOptions(opts ...zap.Option) Option

Functions

func Resource

func Resource(ctx context.Context) (*resource.Resource, error)

Resource returns new resource for application.

Combines following detectors: - ProcessRuntimeDescription - ProcessRuntimeVersion - ProcessRuntimeName And merges it with default resource.

func Run

func Run(f func(ctx context.Context, lg *zap.Logger, m *Metrics) error, op ...Option)

Run f until interrupt.

If errors.Is(err, ctx.Err()) is valid for returned error, shutdown is considered graceful. Context is cancelled on SIGINT. After watchdogTimeout application is forcefully terminated with exitCodeWatchdog.

Types

type Metrics

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

Metrics implement common basic metrics and infrastructure to it.

func (*Metrics) MeterProvider

func (m *Metrics) MeterProvider() metric.MeterProvider

func (*Metrics) String

func (m *Metrics) String() string

func (*Metrics) TextMapPropagator

func (m *Metrics) TextMapPropagator() propagation.TextMapPropagator

func (*Metrics) TracerProvider

func (m *Metrics) TracerProvider() trace.TracerProvider

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is a functional option for the application.

func WithContext

func WithContext(ctx context.Context) Option

WithContext sets the base context for the application. Background context is used by default.

func WithMeterOptions

func WithMeterOptions(opts ...autometer.Option) Option

WithMeterOptions sets the default autometer options for the application.

func WithResource

func WithResource(fn func(ctx context.Context) (*resource.Resource, error)) Option

WithResource sets the function that will be called to retrieve telemetry resource for application.

Defaults to Resource function.

func WithTracerOptions

func WithTracerOptions(opts ...autotracer.Option) Option

WithTracerOptions sets the default autotracer options for the application.

func WithZapConfig

func WithZapConfig(cfg zap.Config) Option

WithZapConfig sets the default zap config for the application.

func WithZapOptions

func WithZapOptions(opts ...zap.Option) Option

WithZapOptions sets additional zap logger options for the application.