healthendpoint

Documentation

Index

• func NewDatabaseStatusCollector(namespace, subSystem string, dbName string, dbStatus db.DatabaseStatus) prometheus.Collector
• func NewServer(logger lager.Logger, port int, gatherer prometheus.Gatherer) (ifrit.Runner, error)
• func NewServerWithBasicAuth(logger lager.Logger, port int, gatherer prometheus.Gatherer, username string, ...) (ifrit.Runner, error)
• func RegisterCollectors(registrar prometheus.Registerer, col []prometheus.Collector, ...)
• type CounterCollector
  • func NewCounterCollector() CounterCollector
• type HTTPStatusCollectMiddleware
  • func NewHTTPStatusCollectMiddleware(httpStatusCollector HTTPStatusCollector) *HTTPStatusCollectMiddleware
  • func (h *HTTPStatusCollectMiddleware) Collect(next http.Handler) http.Handler
• type HTTPStatusCollector
  • func NewHTTPStatusCollector(namespace, subSystem string) HTTPStatusCollector

Functions

func NewDatabaseStatusCollector

func NewDatabaseStatusCollector(namespace, subSystem string, dbName string, dbStatus db.DatabaseStatus) prometheus.Collector

func NewServer

func NewServer(logger lager.Logger, port int, gatherer prometheus.Gatherer) (ifrit.Runner, error)

func NewServerWithBasicAuth

func NewServerWithBasicAuth(logger lager.Logger, port int, gatherer prometheus.Gatherer, username string, password string, usernameHash string, passwordHash string) (ifrit.Runner, error)

open the healthcheck port with basic authentication. Make sure that username and password is not empty

func RegisterCollectors

func RegisterCollectors(registrar prometheus.Registerer, col []prometheus.Collector, includeDefault bool, logger lager.Logger)

Types

type CounterCollector

type CounterCollector interface {
	prometheus.Collector
	AddCounters(counterOps ...prometheus.CounterOpts)
	Add(counterOps prometheus.CounterOpts, count int64)
}

func NewCounterCollector

func NewCounterCollector() CounterCollector

type HTTPStatusCollectMiddleware

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

func NewHTTPStatusCollectMiddleware

func NewHTTPStatusCollectMiddleware(httpStatusCollector HTTPStatusCollector) *HTTPStatusCollectMiddleware

func (*HTTPStatusCollectMiddleware) Collect

func (h *HTTPStatusCollectMiddleware) Collect(next http.Handler) http.Handler

type HTTPStatusCollector

type HTTPStatusCollector interface {
	prometheus.Collector
	IncConcurrentHTTPRequest()
	DecConcurrentHTTPRequest()
}

func NewHTTPStatusCollector

func NewHTTPStatusCollector(namespace, subSystem string) HTTPStatusCollector