metrics

Documentation

Overview

Package metrics creates and registers metrics objects with Prometheus and sets the Prometheus HTTP handler for /metrics

Index

• Variables
• func RegisterMetricsAndInstallHandler(m *http.ServeMux)

Variables

var (

	// BrokerServiceClassCount exposes the number of Service Classes registered
	// per broker.
	BrokerServiceClassCount = prometheus.NewGaugeVec(
		prometheus.GaugeOpts{
			Namespace: catalogNamespace,
			Name:      "broker_service_class_count",
			Help:      "Number of services classes by Broker.",
		},
		[]string{"broker"},
	)

	// BrokerServicePlanCount exposes the number of Service Plans registered
	// per broker.
	BrokerServicePlanCount = prometheus.NewGaugeVec(
		prometheus.GaugeOpts{
			Namespace: catalogNamespace,
			Name:      "broker_service_plan_count",
			Help:      "Number of services classes by Broker.",
		},
		[]string{"broker"},
	)

	// OSBRequestCount exposes the number of HTTP requests made to Open Service
	// Brokers.  The metric is broken out by broker name and response status
	// group (1xx/2xx/3xx/4xx/5xx or 'client-error')
	OSBRequestCount = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Namespace: catalogNamespace,
			Name:      "osb_request_count",
			Help:      "Cumulative number of HTTP requests from the OSB Client to the specified Service Broker grouped by broker name, broker method, and response status.",
		},
		[]string{"broker", "method", "status"},
	)
)

Functions

func RegisterMetricsAndInstallHandler

func RegisterMetricsAndInstallHandler(m *http.ServeMux)

RegisterMetricsAndInstallHandler registers the Service Catalog metrics objects with Prometheus and installs the Prometheus http handler at the default context.