Struct PrometheusMetrics 

pub struct PrometheusMetrics { /* private fields */ }

A ReconcileObserver that exports Prometheus metrics. Requires the prometheus feature.

The metrics, each prefixed with the namespace given to new, are:

• <namespace>_reconciliations_total{controller, phase, outcome}: count of reconciliation passes. An outcome of failed is the signal to alert on. waiting is normal while a resource converges.
• <namespace>_reconciliation_duration_seconds{controller, phase}: histogram of time spent in each pass. Reconcilers that wait by requeueing, rather than by blocking, return promptly, so this measures work done rather than time to converge.
• <namespace>_reconciliation_steps_total{controller, step, outcome}: count of steps. Since a step that an error propagates out of is reported as abandoned, as is one in a pass that was cancelled, abandoned locates where passes stop, but is not itself a failure signal.
• <namespace>_reconciliation_step_duration_seconds{controller, step}: histogram of time spent in each step.

Label values are the controller name, Phase::as_str, Outcome::as_str, and the step name.

This is a Collector, so it must be registered with a registry to be exported, and then shared by every controller that reports to it:

let metrics = k8s_controller::PrometheusMetrics::new("my_operator")?;
let registry = prometheus::Registry::new();
registry.register(Box::new(metrics.clone()))?;
let observer: Arc<dyn k8s_controller::ReconcileObserver> = Arc::new(metrics);
// pass `Arc::clone(&observer)` to each `Controller::with_observer`

Implementations

impl PrometheusMetrics

pub const DEFAULT_BUCKETS: &[f64]

The default histogram buckets, in seconds.

pub fn new(namespace: &str) -> Result<Self, Error>

Creates the metrics, with names prefixed by namespace (which may be empty, for no prefix) and histograms using DEFAULT_BUCKETS.

pub fn with_buckets(namespace: &str, buckets: Vec<f64>) -> Result<Self, Error>

Creates the metrics, with names prefixed by namespace (which may be empty, for no prefix) and histograms using the given buckets, in seconds.

Trait Implementations

impl Clone for PrometheusMetrics

fn clone(&self) -> PrometheusMetrics

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Collector for PrometheusMetrics

fn desc(&self) -> Vec<&Desc>

Return descriptors for metrics.

fn collect(&self) -> Vec<MetricFamily>

Collect metrics.

impl Debug for PrometheusMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ReconcileObserver for PrometheusMetrics

fn reconciled(&self, record: &ReconcileRecord<'_>)

Called when a reconciliation pass ends, including when it is cancelled.

fn step_finished(&self, record: &StepRecord<'_>)

Called when a Step is finished or dropped.