monitoring

Documentation

Overview

Interface definitions

Index

• Constants
• func NewBlueprint() webiface.BlueprintInterface
• type Blueprint
  • func (bp *Blueprint) Routes(router *mux.Router)
• type Middleware
  • func (mdw Middleware) APICount() mux.MiddlewareFunc
  • func (mdw Middleware) APITime() mux.MiddlewareFunc
• type MiddlewareInterface
  • func NewMiddleware(monitor MonitorInterface, service string) MiddlewareInterface
• type MonitorInterface

Constants

const (
	// IDPathRegex regexp used to swap the {id*} parameters in the path with simply id
	// supports alphabetic characters and underscores, no dashes
	IDPathRegex string = "{[a-zA-Z_]*}"
)

Functions

func NewBlueprint

func NewBlueprint() webiface.BlueprintInterface

NewBlueprint returns a new initialized Blueprint object.

Types

type Blueprint

type Blueprint struct{}

func (*Blueprint) Routes

func (bp *Blueprint) Routes(router *mux.Router)

Routes exposes the /api/v1/metrics endpoint for prometheus to scrape

type Middleware

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

Middleware is the monitoring middleware object implementing Prometheus monitoring

func (Middleware) APICount

func (mdw Middleware) APICount() mux.MiddlewareFunc

APICount increments a http_api_count metric on Prometheus

func (Middleware) APITime

func (mdw Middleware) APITime() mux.MiddlewareFunc

APITime sets a http_api_time metric on Prometheus

type MiddlewareInterface

type MiddlewareInterface interface {
	APICount() mux.MiddlewareFunc
	APITime() mux.MiddlewareFunc
}

MiddlewareInterface

func NewMiddleware

func NewMiddleware(monitor MonitorInterface, service string) MiddlewareInterface

NewMiddleware returns a Middleware based on the type of monitor

type MonitorInterface

type MonitorInterface interface {
	GetService() string
	GetMetric(metric string) *prometheus.GaugeVec
	Incr(metric string, opts map[string]string)
}

MonitorInterface interface