metrics

Documentation

Index

• func DeleteMetricsForPod(pod *corev1.Pod)
• func EnableMetrics(address string)
• func GetPodQueue() workqueue.DelayingInterface
• func GetRegistry() *prometheus.Registry
• func ListMetricsWithPod() []*prometheus.MetricVec
• func NewCounterVecWithPod(opts prometheus.CounterOpts, labels []string) *prometheus.CounterVec
• func NewGaugeVecWithPod(opts prometheus.GaugeOpts, labels []string) *prometheus.GaugeVec
• func NewHistogramVecWithPod(opts prometheus.HistogramOpts, labels []string) *prometheus.HistogramVec
• func RegisterPodDeleteHandler()
• func StartPodDeleteHandler()
• type BPFMetric
  • func NewBPFCounter(desc *prometheus.Desc) BPFMetric
  • func NewBPFGauge(desc *prometheus.Desc) BPFMetric
• type FilteredLabels
• type GranularCounter
  • func MustNewGranularCounter[L FilteredLabels](opts prometheus.CounterOpts, extraLabels []string) *GranularCounter[L]
  • func NewGranularCounter[L FilteredLabels](opts prometheus.CounterOpts, extraLabels []string) (*GranularCounter[L], error)
  • func (m *GranularCounter[L]) Collect(ch chan<- prometheus.Metric)
  • func (m *GranularCounter[L]) Describe(ch chan<- *prometheus.Desc)
  • func (m *GranularCounter[L]) WithLabelValues(commonLvs *L, extraLvs ...string) prometheus.Counter
• type GranularGauge
  • func MustNewGranularGauge[L FilteredLabels](opts prometheus.GaugeOpts, extraLabels []string) *GranularGauge[L]
  • func NewGranularGauge[L FilteredLabels](opts prometheus.GaugeOpts, extraLabels []string) (*GranularGauge[L], error)
  • func (m *GranularGauge[L]) Collect(ch chan<- prometheus.Metric)
  • func (m *GranularGauge[L]) Describe(ch chan<- *prometheus.Desc)
  • func (m *GranularGauge[L]) WithLabelValues(commonLvs *L, extraLvs ...string) prometheus.Gauge
• type GranularHistogram
  • func MustNewGranularHistogram[L FilteredLabels](opts prometheus.HistogramOpts, extraLabels []string) *GranularHistogram[L]
  • func NewGranularHistogram[L FilteredLabels](opts prometheus.HistogramOpts, extraLabels []string) (*GranularHistogram[L], error)
  • func (m *GranularHistogram[L]) Collect(ch chan<- prometheus.Metric)
  • func (m *GranularHistogram[L]) Describe(ch chan<- *prometheus.Desc)
  • func (m *GranularHistogram[L]) WithLabelValues(commonLvs *L, extraLvs ...string) prometheus.Observer
• type LabelFilter
  • func (f LabelFilter) WithEnabledLabels(enabledLabels []string) LabelFilter
• type ProcessLabels
  • func NewProcessLabels(namespace, workload, pod, binary string) *ProcessLabels
  • func (l ProcessLabels) Keys() []string
  • func (l ProcessLabels) Values() []string

Functions

func DeleteMetricsForPod

func DeleteMetricsForPod(pod *corev1.Pod)

func EnableMetrics

func EnableMetrics(address string)

func GetPodQueue

func GetPodQueue() workqueue.DelayingInterface

func GetRegistry

func GetRegistry() *prometheus.Registry

func ListMetricsWithPod

func ListMetricsWithPod() []*prometheus.MetricVec

func NewCounterVecWithPod

func NewCounterVecWithPod(opts prometheus.CounterOpts, labels []string) *prometheus.CounterVec

NewCounterVecWithPod is a wrapper around prometheus.NewCounterVec that also registers the metric to be cleaned up when a pod is deleted. It should be used only to register metrics that have "pod" and "namespace" labels.

func NewGaugeVecWithPod

func NewGaugeVecWithPod(opts prometheus.GaugeOpts, labels []string) *prometheus.GaugeVec

NewGaugeVecWithPod is a wrapper around prometheus.NewGaugeVec that also registers the metric to be cleaned up when a pod is deleted. It should be used only to register metrics that have "pod" and "namespace" labels.

func NewHistogramVecWithPod

func NewHistogramVecWithPod(opts prometheus.HistogramOpts, labels []string) *prometheus.HistogramVec

NewHistogramVecWithPod is a wrapper around prometheus.NewHistogramVec that also registers the metric to be cleaned up when a pod is deleted. It should be used only to register metrics that have "pod" and "namespace" labels.

func RegisterPodDeleteHandler

func RegisterPodDeleteHandler()

RegisterPodDeleteHandler registers handler for deleting metrics associated with deleted pods. Without it, Tetragon kept exposing stale metrics for deleted pods. This was causing continuous increase in memory usage in Tetragon agent as well as in the metrics scraper.

func StartPodDeleteHandler

func StartPodDeleteHandler()

Types

type BPFMetric

type BPFMetric interface {
	Desc() *prometheus.Desc
	MustMetric(value float64, labelValues ...string) prometheus.Metric
}

BPFMetric represents a metric read directly from a BPF map. It's intended to be used in custom collectors. The interface doesn't provide any validation, so it's up to the collector implementer to guarantee the metrics consistency.

func NewBPFCounter

func NewBPFCounter(desc *prometheus.Desc) BPFMetric

func NewBPFGauge

func NewBPFGauge(desc *prometheus.Desc) BPFMetric

type FilteredLabels

type FilteredLabels interface {
	Keys() []string
	Values() []string
}

type GranularCounter

type GranularCounter[L FilteredLabels] struct {
	// contains filtered or unexported fields
}

func MustNewGranularCounter

func MustNewGranularCounter[L FilteredLabels](opts prometheus.CounterOpts, extraLabels []string) *GranularCounter[L]

func NewGranularCounter

func NewGranularCounter[L FilteredLabels](opts prometheus.CounterOpts, extraLabels []string) (*GranularCounter[L], error)

func (*GranularCounter[L]) Collect

func (m *GranularCounter[L]) Collect(ch chan<- prometheus.Metric)

func (*GranularCounter[L]) Describe

func (m *GranularCounter[L]) Describe(ch chan<- *prometheus.Desc)

func (*GranularCounter[L]) WithLabelValues

func (m *GranularCounter[L]) WithLabelValues(commonLvs *L, extraLvs ...string) prometheus.Counter

type GranularGauge

type GranularGauge[L FilteredLabels] struct {
	// contains filtered or unexported fields
}

func MustNewGranularGauge

func MustNewGranularGauge[L FilteredLabels](opts prometheus.GaugeOpts, extraLabels []string) *GranularGauge[L]

func NewGranularGauge

func NewGranularGauge[L FilteredLabels](opts prometheus.GaugeOpts, extraLabels []string) (*GranularGauge[L], error)

func (*GranularGauge[L]) Collect

func (m *GranularGauge[L]) Collect(ch chan<- prometheus.Metric)

func (*GranularGauge[L]) Describe

func (m *GranularGauge[L]) Describe(ch chan<- *prometheus.Desc)

func (*GranularGauge[L]) WithLabelValues

func (m *GranularGauge[L]) WithLabelValues(commonLvs *L, extraLvs ...string) prometheus.Gauge

type GranularHistogram

type GranularHistogram[L FilteredLabels] struct {
	// contains filtered or unexported fields
}

func MustNewGranularHistogram

func MustNewGranularHistogram[L FilteredLabels](opts prometheus.HistogramOpts, extraLabels []string) *GranularHistogram[L]

func NewGranularHistogram

func NewGranularHistogram[L FilteredLabels](opts prometheus.HistogramOpts, extraLabels []string) (*GranularHistogram[L], error)

func (*GranularHistogram[L]) Collect

func (m *GranularHistogram[L]) Collect(ch chan<- prometheus.Metric)

func (*GranularHistogram[L]) Describe

func (m *GranularHistogram[L]) Describe(ch chan<- *prometheus.Desc)

func (*GranularHistogram[L]) WithLabelValues

func (m *GranularHistogram[L]) WithLabelValues(commonLvs *L, extraLvs ...string) prometheus.Observer

type LabelFilter

type LabelFilter map[string]bool

func (LabelFilter) WithEnabledLabels

func (f LabelFilter) WithEnabledLabels(enabledLabels []string) LabelFilter

WithEnabledLabels returns a new LabelFilter with only the labels in enabledLabels enabled. If enabledLabels is nil, a copy of the original LabelFilter is returned. If enabledLabels is empty, all labels are disabled. If enabledLabels contains labels that are not in the original LabelFilter, they are ignored.

type ProcessLabels

type ProcessLabels struct {
	Namespace string
	Workload  string
	Pod       string
	Binary    string
}

func NewProcessLabels

func NewProcessLabels(namespace, workload, pod, binary string) *ProcessLabels

func (ProcessLabels) Keys

func (l ProcessLabels) Keys() []string

func (ProcessLabels) Values

func (l ProcessLabels) Values() []string