prometheus

Documentation

Index

• Constants
• Variables
• func PublishHandlerMetrics(next ziggurat.Handler) ziggurat.Handler
• func Register()
• func StartMonitoringServer(ctx context.Context, opts ...ServerOpts) error
• type ServerOpts
  • func WithAddr(addr string) ServerOpts

Constants

const (
	// RouteLabel - Key for route label
	RouteLabel = "route"
)

Variables

var HandlerDurationHistogram = prometheus.NewHistogramVec(
	prometheus.HistogramOpts{
		Namespace: namespace,
		Subsystem: handlerSubsystem,
		Name:      "duration_seconds",
		Help:      "time spent processing events, partitioned by route",
	},
	[]string{"route"},
)

HandlerDurationHistogram - Prometheus histogram for handler duration

var HandlerEventsCounter = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Namespace: namespace,
		Subsystem: handlerSubsystem,
		Name:      "events_total",
		Help:      "Events passed on to the handler, partitioned by route",
	},
	[]string{RouteLabel},
)

HandlerEventsCounter - Prometheus counter for handled events

var HandlerFailuresCounter = prometheus.NewCounterVec(
	prometheus.CounterOpts{
		Namespace: namespace,
		Subsystem: handlerSubsystem,
		Name:      "failures_total",
		Help:      "Event handler failures, partitioned by route",
	},
	[]string{RouteLabel},
)

HandlerFailuresCounter - Prometheus counter for handler failures

Functions

func PublishHandlerMetrics

func PublishHandlerMetrics(next ziggurat.Handler) ziggurat.Handler

PublishHandlerMetrics - middleware to update registered handler metrics

func Register

func Register()

Register - Registers the Prometheus metrics

func StartMonitoringServer

func StartMonitoringServer(ctx context.Context, opts ...ServerOpts) error

StartMonitoringServer - starts a monitoring server for prometheus

Types

type ServerOpts

type ServerOpts func(*http.Server)

func WithAddr

func WithAddr(addr string) ServerOpts