metrics

Documentation

Index

• type Metrics
  • func NewMetrics(serviceID string) *Metrics
  • func (m *Metrics) Collectors() []prometheus.Collector
  • func (m *Metrics) RecordAPICall(opType string, opID string, err error)

Types

type Metrics

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

Metrics contains the set of Prometheus metric objects used to store counter and histograms for a variety of data points

func NewMetrics

func NewMetrics(serviceID string) *Metrics

NewMetrics returns a pointer to a Metrics struct that can be used to collect and expose various Prometheus metrics

func (*Metrics) Collectors

func (m *Metrics) Collectors() []prometheus.Collector

Collectors simply provides an iterator over the `prometheus.Collector` interface pointers of the underlying metrics. This allows a `prometheus.Registerer` (like controller-runtime's metrics.Registry) to register the metrics.

func (*Metrics) RecordAPICall

func (m *Metrics) RecordAPICall(

	opType string,

	opID string,

	err error,
)

RecordAPICall increments appropriate metrics tracking the count and duration of a supplied outbound AWS API call