monitoring

Documentation

Overview

Package monitoring contains helpers for application monitoring. Currently configured to use sentry.

Index

• Variables
• func New() (io.Closer, error)
• func WithError(err error) error
• type Monitor
  • func (m *Monitor) Close() error

Variables

var Flags = flag.Flags{
	&flag.Boolean{
		Name:        "monitoring-disabled",
		Usage:       "Disables application monitoring",
		EnvVar:      "MONITORING_DISABLED",
		Destination: &config.disabled,
	},
	&flag.String{
		Name:        "monitoring-environment",
		Usage:       "Environment to use when writing to application monitoring",
		EnvVar:      "MONITORING_ENVIRONMENT",
		Destination: &config.environment,
		Value:       "development",
	},
	&flag.String{
		Name:        "monitoring-dsn",
		Usage:       "DSN to use for sending reports to sentry",
		EnvVar:      "MONITORING_DSN",
		Destination: &config.dsn,
	},
}

Flags contains all command-line flags that can be used to configure monitoring.

Functions

func New

func New() (io.Closer, error)

New creates a new instance of the Monitor type and sets up the connection to the monitoring provider.

func WithError

func WithError(err error) error

WithError reports an error to the provider.

Types

type Monitor

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

The Monitor type is responsible for maintaining the lifetime of the connection to the application monitoring provider. It implements io.Closer and should be closed on application exit.

func (*Monitor) Close

func (m *Monitor) Close() error

Close the connection to the monitoring provider.