snap-dataplane 0.2.0

Data 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

// 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.
//! Tunnel gateway metrics.

use prometheus::{IntCounter, IntGauge};
use scion_sdk_observability::metrics::registry::MetricsRegistry;

/// Tunnel gateway metrics.
#[derive(Debug, Clone)]
pub struct TunnelGatewayMetrics {
    /// Total number of active snaptun connections.
    pub snaptun_connections_active: IntGauge,
}

impl TunnelGatewayMetrics {
    /// Create new tunnel gateway metrics instance with the given registry.
    pub fn new(metrics_registry: &MetricsRegistry) -> Self {
        TunnelGatewayMetrics {
            snaptun_connections_active: metrics_registry.int_gauge(
                "snap_snaptun_active_connections",
                "Total number of active snaptun connections.",
            ),
        }
    }
}

/// Tunnel gateway dispatcher metrics.
#[derive(Debug, Clone)]
pub struct TunnelGatewayDispatcherMetrics {
    // dispatch queue metrics:
    /// Current size of the tunnel gateway dispatch queue.
    pub dispatch_queue_size: IntGauge,
    /// Total number of errors when the dispatch queue is full.
    pub full_dispatch_queue_errors: IntCounter,
    /// Total number of errors when the dispatch queue is closed.
    pub closed_dispatch_queue_errors: IntCounter,
    // dispatcher error metrics:
    /// Total number of errors when dispatching a packet to the tunnel gateway.
    pub invalid_packets_errors: IntCounter,
    /// Total number of errors when the connection is closed.
    pub connection_closed_errors: IntCounter,
    /// Total number of errors when a new assigned address is received.
    pub new_assigned_address_errors: IntCounter,
    /// Total number of errors when no address is assigned.
    pub no_address_assigned_errors: IntCounter,
    /// Total number of errors when sending a datagram to the snaptun.
    pub send_datagram_errors: IntCounter,
    /// Total number of errors when the tunnel is missing.
    pub missing_tunnel_errors: IntCounter,
}

impl TunnelGatewayDispatcherMetrics {
    /// Create new tunnel gateway dispatcher metrics instance with the given registry.
    pub fn new(metrics_registry: &MetricsRegistry) -> Self {
        let dispatch_errors = metrics_registry.int_counter_vec(
            "snap_tunnel_gw_dispatch_errors_total",
            "Total number of errors when dispatching a packet to the tunnel gateway.",
            &["error_type"],
        );

        let forwarding_errors = metrics_registry.int_counter_vec(
            "snap_tunnel_gw_forwarding_errors_total",
            "Total number of errors when forwarding a packet to corresponding snaptun.",
            &["error_type"],
        );

        TunnelGatewayDispatcherMetrics {
            dispatch_queue_size: metrics_registry.int_gauge(
                "snap_tunnel_gw_dispatch_queue_size",
                "Current size of the tunnel gateway dispatch queue.",
            ),
            full_dispatch_queue_errors: dispatch_errors.with_label_values(&["queue_full"]),
            closed_dispatch_queue_errors: dispatch_errors.with_label_values(&["queue_closed"]),
            invalid_packets_errors: forwarding_errors.with_label_values(&["invalid_packet"]),
            connection_closed_errors: forwarding_errors.with_label_values(&["connection_closed"]),
            new_assigned_address_errors: forwarding_errors
                .with_label_values(&["new_assigned_address"]),
            no_address_assigned_errors: forwarding_errors
                .with_label_values(&["no_address_assigned"]),
            send_datagram_errors: forwarding_errors.with_label_values(&["send_datagram_error"]),
            missing_tunnel_errors: forwarding_errors.with_label_values(&["tunnel_missing"]),
        }
    }
}