chaincodec-observability 0.2.0

OpenTelemetry metrics, tracing, and structured logging for ChainCodec
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! ChainCodec metrics definitions.
//!
//! All metrics use OpenTelemetry conventions.
//! They can be exported via OTLP to Prometheus, Grafana, Datadog, etc.

use opentelemetry::{
    metrics::{Counter, Histogram, Meter},
    KeyValue,
};

/// Central metrics handle for ChainCodec.
#[derive(Clone)]
pub struct ChainCodecMetrics {
    pub events_decoded: Counter<u64>,
    pub events_skipped: Counter<u64>,
    pub decode_errors: Counter<u64>,
    pub decode_latency_ms: Histogram<f64>,
    pub batch_size: Histogram<u64>,
    pub schema_cache_hits: Counter<u64>,
}

impl ChainCodecMetrics {
    pub fn new(meter: &Meter) -> Self {
        Self {
            events_decoded: meter
                .u64_counter("chaincodec.events_decoded")
                .with_description("Total number of successfully decoded events")
                .init(),
            events_skipped: meter
                .u64_counter("chaincodec.events_skipped")
                .with_description("Events skipped due to missing schema or filtering")
                .init(),
            decode_errors: meter
                .u64_counter("chaincodec.decode_errors")
                .with_description("Events that failed to decode")
                .init(),
            decode_latency_ms: meter
                .f64_histogram("chaincodec.decode_latency_ms")
                .with_description("Time to decode a single event in milliseconds")
                .init(),
            batch_size: meter
                .u64_histogram("chaincodec.batch_size")
                .with_description("Number of events in a batch decode request")
                .init(),
            schema_cache_hits: meter
                .u64_counter("chaincodec.schema_cache_hits")
                .with_description("Registry fingerprint lookup cache hits")
                .init(),
        }
    }

    pub fn record_decoded(&self, chain: &str, schema: &str) {
        self.events_decoded.add(
            1,
            &[
                KeyValue::new("chain", chain.to_string()),
                KeyValue::new("schema", schema.to_string()),
            ],
        );
    }

    pub fn record_error(&self, chain: &str, error_type: &str) {
        self.decode_errors.add(
            1,
            &[
                KeyValue::new("chain", chain.to_string()),
                KeyValue::new("error_type", error_type.to_string()),
            ],
        );
    }

    pub fn record_latency(&self, ms: f64, chain: &str) {
        self.decode_latency_ms
            .record(ms, &[KeyValue::new("chain", chain.to_string())]);
    }
}