monitoring

Documentation

Index

• type Config
• type ICustomMetrics
• type MonitorServer
  • func NewMonitorServer() (*MonitorServer, error)
  • func (s *MonitorServer) Shutdown()
  • func (s *MonitorServer) Start()

Types

type Config

type Config struct {
	RestHost        string
	RestPort        int
	ShutdownTimeout int
}

Config -

type ICustomMetrics

type ICustomMetrics interface {
	AddCounter(namespace, subsystem, name, help, internalKey string)
	AddGauge(namespace, subsystem, name, help, internalKey string)
	AddSummary(
		namespace, subsystem, name, help, internalKey string,
		maxAge time.Duration, constLabels prometheus.Labels,
		objectives map[float64]float64, ageBuckets, bufCap uint32)
	AddHistogram(
		namespace, subsystem, name, help, internalKey string,
		constLabels prometheus.Labels, buckets []float64)
	IncreaseCounter(counter string)
	SetGauge(gauge string, value float64)
	ObserveSummary(summary string, observation float64)
	ObserveHistogram(histogram string, observation float64)
}

type MonitorServer

type MonitorServer struct {
	Config        *Config
	Router        *mux.Router
	HTTPServer    *http.Server
	CustomMetrics ICustomMetrics
}

MonitorServer -

func NewMonitorServer

func NewMonitorServer() (*MonitorServer, error)

NewMonitorServer - Create new Monitoring REST server

func (*MonitorServer) Shutdown

func (s *MonitorServer) Shutdown()

Shutdown - Shutdown Monitoring REST server

func (*MonitorServer) Start

func (s *MonitorServer) Start()

Start - Start Monitoring REST server