metrics

Documentation

Overview

Package metrics holds the implementation for exposing adapter metrics to prometheus

Index

• Constants
• func RegisterPrometheusCollector()
• type AdapterCollector
  • func (collector *AdapterCollector) Collect(ch chan<- prometheus.Metric)
  • func (collector *AdapterCollector) Describe(ch chan<- *prometheus.Desc)

Constants

const (
	// PrometheusMetricType prometheus metric type
	PrometheusMetricType = "prometheus"
)

Functions

func RegisterPrometheusCollector

func RegisterPrometheusCollector()

RegisterPrometheusCollector registers the Prometheus collector for metrics.

Types

type AdapterCollector

type AdapterCollector struct {
	commonmetrics.Collector
	// contains filtered or unexported fields
}

AdapterCollector contains the descriptions of the custom metrics exposed by the adapter. It also uses the metrics defined in common-go-libs

func (*AdapterCollector) Collect

func (collector *AdapterCollector) Collect(ch chan<- prometheus.Metric)

Collect collects all the relevant Prometheus metrics.

func (*AdapterCollector) Describe

func (collector *AdapterCollector) Describe(ch chan<- *prometheus.Desc)

Describe sends all the descriptors of the metrics collected by this Collector to the provided channel.