batch-aint-one-prometheus

Prometheus metrics for batch-aint-one.

Usage

# use batch_aint_one::{Batcher, BatchingPolicy, Limits, Processor};
use batch_aint_one_prometheus::BatchMetrics;
use prometheus::Registry;
#
# #[derive(Debug, Clone)]
# struct MyProcessor;
# impl Processor for MyProcessor {
#     type Key = String;
#     type Input = String;
#     type Output = String;
#     type Error = String;
#     type Resources = ();
#     async fn acquire_resources(&self, _key: String) -> Result<(), String> { Ok(()) }
#     async fn process(&self, _key: String, inputs: impl Iterator<Item = String> + Send, _resources: ()) -> Result<Vec<String>, String> {
#         Ok(inputs.collect())
#     }
# }

// Register metrics on your Prometheus registry.
let registry = Registry::new();
let metrics = BatchMetrics::new(&registry).unwrap();

// Pass the metrics to each Batcher. The batcher label is set from the batcher's name.
# tokio_test::block_on(async {
let batcher = Batcher::builder()
    .name("my-batcher")
    .processor(MyProcessor)
    .limits(Limits::builder().max_batch_size(10).build())
    .batching_policy(BatchingPolicy::Immediate)
    .metrics(Box::new(metrics))
    .build();
# });

All metrics are labelled with a batcher label, so multiple Batcher instances can share the same BatchMetrics. BatchMetrics implements MetricsRecorderFactory, so the batcher creates its own recorder using its name.

Use BatchMetrics::with_prefix to customise the metric name prefix (default: batch).

Metrics