snap-control 0.4.0

Control plane implementation of the SNAP transport underlay for SCION
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

// Copyright 2025 Anapaya Systems
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! SNAP control plane API Prometheus middleware.

use std::{
    future::Future,
    pin::Pin,
    task::{Context, Poll},
    time::Instant,
};

use axum::body::Body;
use http::{Request, Response};
use prometheus::{HistogramVec, IntCounterVec};
use scion_sdk_observability::metrics::registry::MetricsRegistry;
use tower::{BoxError, Layer, Service};

/// Prometheus middleware layer for tracking control plane API metrics.
#[derive(Clone)]
pub struct PrometheusMiddlewareLayer {
    metrics: Metrics,
}

impl PrometheusMiddlewareLayer {
    /// Create a new Prometheus middleware layer with the given metrics.
    pub fn new(metrics: Metrics) -> Self {
        Self { metrics }
    }
}

impl<S> Layer<S> for PrometheusMiddlewareLayer {
    type Service = PrometheusMiddleware<S>;

    fn layer(&self, inner: S) -> Self::Service {
        PrometheusMiddleware::new(inner, self.metrics.clone())
    }
}

/// Prometheus middleware for tracking control plane API metrics.
#[derive(Clone)]
pub struct PrometheusMiddleware<S> {
    inner: S,
    metrics: Metrics,
}

impl<S> PrometheusMiddleware<S> {
    /// Create a new Prometheus middleware with the given service and metrics.
    pub fn new(inner: S, metrics: Metrics) -> Self {
        Self { inner, metrics }
    }
}

impl<S> Service<Request<Body>> for PrometheusMiddleware<S>
where
    S: Service<Request<Body>, Response = Response<Body>> + Send + Clone + 'static,
    S::Error: Into<BoxError>,
    S::Future: Send + 'static,
{
    type Response = Response<Body>;
    type Error = BoxError;
    type Future = Pin<Box<dyn Future<Output = Result<Self::Response, Self::Error>> + Send>>;

    fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
        self.inner.poll_ready(cx).map_err(Into::into)
    }

    fn call(&mut self, request: Request<Body>) -> Self::Future {
        let method = request.uri().path().to_string();
        let metrics = self.metrics.clone();

        // Increment started metric
        metrics
            .control_plane_started_total
            .with_label_values(&[&method])
            .inc();

        let fut = self.inner.call(request);
        let start = Instant::now();

        Box::pin(async move {
            let result = fut.await.map_err(Into::into)?;
            let status = result.status().as_str().to_string();

            // Increment handled metric
            metrics
                .control_plane_handled_total
                .with_label_values(&[&method, &status])
                .inc();

            // Observe latency
            let elapsed = start.elapsed().as_secs_f64();
            metrics
                .control_plane_latency_seconds
                .with_label_values(&[&method, &status])
                .observe(elapsed);

            Ok(result)
        })
    }
}

/// SNAP control plane API metrics.
#[derive(Debug, Clone)]
pub struct Metrics {
    /// Total number of control plane API requests started on the server.
    pub control_plane_started_total: IntCounterVec,
    /// Total number of control plane API requests handled on the server.
    pub control_plane_handled_total: IntCounterVec,
    /// Latency of control plane API requests in seconds.
    pub control_plane_latency_seconds: HistogramVec,
}

impl Metrics {
    /// Create new metrics instance with the given registry.
    pub fn new(metrics_registry: &MetricsRegistry) -> Self {
        Metrics {
            control_plane_started_total: metrics_registry.int_counter_vec(
                "control_plane_requests_started_total",
                "Total number of control plane API requests started on the server.",
                &["method"],
            ),
            control_plane_handled_total: metrics_registry.int_counter_vec(
                "control_plane_requests_handled_total",
                "Total number of control plane API requests handled on the server.",
                &["method", "status"],
            ),
            control_plane_latency_seconds: metrics_registry.histogram_vec(
                "control_plane_requests_latency_seconds",
                "Latency of control plane API requests in seconds.",
                vec![0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1.0, 2.5, 5.0],
                &["method", "status"],
            ),
        }
    }
}