folk-api 0.1.2

Plugin contract for the Folk PHP application server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Metrics registration. Plugins create metric families and update counters,
//! gauges, and histograms.

use std::sync::Arc;

/// Single counter handle (one specific label combination).
pub trait Counter: Send + Sync + 'static {
    fn inc(&self);
    fn inc_by(&self, v: u64);
    fn get(&self) -> u64;
}

/// Single gauge handle (one specific label combination).
pub trait Gauge: Send + Sync + 'static {
    fn set(&self, v: i64);
    fn inc(&self);
    fn dec(&self);
    fn get(&self) -> i64;
}

/// Single histogram handle (one specific label combination).
pub trait Histogram: Send + Sync + 'static {
    fn observe(&self, v: f64);
}

/// A counter metric family — use `with_labels` to get a concrete handle.
pub trait CounterVec: Send + Sync + 'static {
    fn with_labels(&self, labels: &[&str]) -> Arc<dyn Counter>;
}

pub trait GaugeVec: Send + Sync + 'static {
    fn with_labels(&self, labels: &[&str]) -> Arc<dyn Gauge>;
}

pub trait HistogramVec: Send + Sync + 'static {
    fn with_labels(&self, labels: &[&str]) -> Arc<dyn Histogram>;
}

/// Plugins register metric families here. Observers render them.
pub trait MetricsRegistry: Send + Sync + 'static {
    fn counter_vec(&self, name: &str, help: &str, label_keys: &[&str]) -> Arc<dyn CounterVec>;
    fn gauge_vec(&self, name: &str, help: &str, label_keys: &[&str]) -> Arc<dyn GaugeVec>;
    fn histogram_vec(&self, name: &str, help: &str, label_keys: &[&str]) -> Arc<dyn HistogramVec>;

    /// Render all registered metrics in Prometheus text exposition format.
    fn render(&self) -> String;
}