capsule 0.1.5

A framework for network function development. Written in Rust, inspired by NetBricks and built on Intel's Data Plane Development Kit.
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

/*
* Copyright 2019 Comcast Cable Communications Management, LLC
*
* 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.
*
* SPDX-License-Identifier: Apache-2.0
*/

//! Exposes framework metrics, including port, kni, mempool, and pipeline
//! metrics.
//!
//! # Port Metrics
//!
//! * `port.packets`, total number of successfully received or transmitted
//! packets.
//! * `port.octets`, total number of successfully received or transmitted
//! bytes.
//! * `port.dropped`, total number of packets dropped because the receive
//! or transmit queues are full.
//! * `port.errors`, total number of erroneous received packets or packets
//! failed to transmit.
//! * `port.no_mbuf`, total number of packets dropped due to mbuf allocation
//! failures.
//!
//! Each metric is labeled with the port name and a direction, which can be
//! either RX or TX. `port.packets` and `port.dropped` are tracked per core
//! and labeled with the core id. The others are tracked by only the overall
//! metrics.
//!
//!
//! # KNI Metrics
//!
//! * `kni.packets`, total number of successfully received or transmitted
//! packets.
//! * `kni.octets`, total number of successfully received or transmitted bytes.
//! * `kni.dropped`, total number of packets dropped because the transmit
//! queue is full.
//!
//! Each metric is labeled with the KNI interface name and a direction, which
//! can be either RX or TX.
//!
//!
//! # Mempool Metrics
//!
//! * `mempool.used`, total number of mbufs which have been allocated from
//! the mempool.
//! * `mempool.free`, total number of mbufs available for allocation.
//!
//! Each metric is labeled with the mempool name.
//!
//!
//! # Pipeline Metrics
//!
//! * `pipeline.runs`, total number of times the pipeline executes.
//! * `pipeline.processed`, total number of successfully processed packets.
//! * `pipeline.dropped`, total number of packets intentionally dropped.
//! * `pipeline.errors`, total number of packet dropped due to processing
//! errors.
//!
//! Each metric is tracked per core and labeled with the core id and the
//! pipeline name. If the pipeline doesn't have a name, it will be labeled
//! as "default".

// re-export some metrics types to make feature gated imports easier.
pub(crate) use metrics_core::{labels, Key};
pub(crate) use metrics_runtime::data::Counter;
pub(crate) use metrics_runtime::Measurement;

use crate::dpdk::{Mempool, MempoolStats, Port};
use crate::warn;
use anyhow::{anyhow, Result};
use metrics_runtime::{Receiver, Sink};
use once_cell::sync::{Lazy, OnceCell};

/// The metrics store.
static RECEIVER: OnceCell<Receiver> = OnceCell::new();

/// Safely initializes the metrics store. Because the receiver builder could
/// potentially fail, the `Lazy` convenience type is not safe.
///
/// Also very important that `init` is not called twice.
pub(crate) fn init() -> Result<()> {
    let receiver = Receiver::builder().build()?;

    RECEIVER
        .set(receiver)
        .map_err(|_| anyhow!("already initialized."))?;
    Ok(())
}

/// Registers DPDK collected port stats with the metrics store.
pub(crate) fn register_port_stats(ports: &[Port]) {
    let stats = ports.iter().map(Port::stats).collect::<Vec<_>>();
    SINK.clone().proxy("port", move || {
        stats
            .iter()
            .flat_map(|s| {
                s.collect().unwrap_or_else(|err| {
                    warn!(message = "failed to collect stats.", port = s.name(), ?err);
                    Vec::new()
                })
            })
            .collect()
    });
}

/// Registers collected mempool stats with the metrics store.
pub(crate) fn register_mempool_stats(mempools: &[Mempool]) {
    let stats = mempools.iter().map(Mempool::stats).collect::<Vec<_>>();
    SINK.clone().proxy("mempool", move || {
        stats.iter().flat_map(MempoolStats::collect).collect()
    });
}

/// Returns the global metrics store.
///
/// Metrics are managed using [metrics-rs]. The application can use this to
/// access framework metrics or to add new application metrics.
///
/// # Panics
///
/// Panics if `Runtime::build` is not called first.
///
/// [metrics-rs]: https://github.com/metrics-rs
pub fn global() -> &'static Receiver {
    unsafe { RECEIVER.get_unchecked() }
}

/// The root sink for all framework metrics.
pub(crate) static SINK: Lazy<Sink> = Lazy::new(|| global().sink().scoped("capsule"));