metrics

Documentation

Overview

Package metrics provides a set of metrics for the VPN tunnel.

Index

• Variables
• type Metrics
  • func (m *Metrics) Describe(ch chan<- *prometheus.Desc)
  • func (m *Metrics) MetricsErrorHandler(err error, ch chan<- prometheus.Metric)

Variables

var (
	// PeerReceivedBytes is the metric that counts the number of bytes received from a given peer.
	PeerReceivedBytes *prometheus.Desc
	// PeerTransmittedBytes is the metric that counts the number of bytes transmitted to a given peer.
	PeerTransmittedBytes *prometheus.Desc
	// PeerLatency is the metric that exposes the latency towards a given peer.
	PeerLatency *prometheus.Desc
	// PeerIsConnected is the metric that outputs the connection status.
	PeerIsConnected *prometheus.Desc
	// MetricsLabels is the labels that are used for the metrics.
	MetricsLabels []string
)

Types

type Metrics

type Metrics struct{}

Metrics is a struct that implements the prometheus.Collector interface's Describe method and other utilities.

func (*Metrics) Describe

func (m *Metrics) Describe(ch chan<- *prometheus.Desc)

Describe implements prometheus.Collector.

func (*Metrics) MetricsErrorHandler

func (m *Metrics) MetricsErrorHandler(err error, ch chan<- prometheus.Metric)

MetricsErrorHandler is a function that handles metrics errors.