metrics

Documentation

Overview

Package metrics provides Prometheus metrics for Contour.

Index

• Constants
• func Handler(registry *prometheus.Registry) http.Handler
• type Meta
• type Metrics
  • func NewMetrics(registry *prometheus.Registry) *Metrics
  • func (m *Metrics) SetDAGLastRebuilt(ts time.Time)
  • func (m *Metrics) SetHTTPProxyMetric(metrics RouteMetric)
  • func (m *Metrics) Zero()
• type RouteMetric

Constants

const (
	BuildInfoGauge = "contour_build_info"

	HTTPProxyTotalGauge     = "contour_httpproxy_total"
	HTTPProxyRootTotalGauge = "contour_httpproxy_root_total"
	HTTPProxyInvalidGauge   = "contour_httpproxy_invalid_total"
	HTTPProxyValidGauge     = "contour_httpproxy_valid_total"
	HTTPProxyOrphanedGauge  = "contour_httpproxy_orphaned_total"

	DAGRebuildGauge = "contour_dagrebuild_timestamp"
)

Functions

func Handler

func Handler(registry *prometheus.Registry) http.Handler

Handler returns a http Handler for a metrics endpoint.

Types

type Meta

type Meta struct {
	VHost, Namespace string
}

Meta holds the vhost and namespace of a metric object

type Metrics

type Metrics struct {
	CacheHandlerOnUpdateSummary prometheus.Summary
	EventHandlerOperations      *prometheus.CounterVec
	// contains filtered or unexported fields
}

Metrics provide Prometheus metrics for the app

func NewMetrics

func NewMetrics(registry *prometheus.Registry) *Metrics

NewMetrics creates a new set of metrics and registers them with the supplied registry.

NOTE: when adding new metrics, update Zero() and run `./hack/generate-metrics-doc.go` using `make generate-metrics-docs` to regenerate the metrics documentation.

func (*Metrics) SetDAGLastRebuilt

func (m *Metrics) SetDAGLastRebuilt(ts time.Time)

SetDAGLastRebuilt records the last time the DAG was rebuilt.

func (*Metrics) SetHTTPProxyMetric

func (m *Metrics) SetHTTPProxyMetric(metrics RouteMetric)

SetHTTPProxyMetric sets metric values for a set of HTTPProxies

func (*Metrics) Zero

func (m *Metrics) Zero()

Zero sets zero values for all the registered metrics. This is needed for generating metrics documentation. The prometheus.Registry() won't emit the metric metadata until the metric has been set.

type RouteMetric

type RouteMetric struct {
	Total    map[Meta]int
	Valid    map[Meta]int
	Invalid  map[Meta]int
	Orphaned map[Meta]int
	Root     map[Meta]int
}

RouteMetric stores various metrics for HTTPProxy objects