mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-14 11:51:19 +00:00
135942d319
The `unreachable_pub` lint makes us aware of uses of `pub` that are not actually reachable from the crate root. This is considered good because it means reading a `pub` somewhere means it is actually public API. Some of our crates are quite large and keeping their entire API surface in your head is difficult. We should strive for most items being `pub(crate)`. This lint helps us enforce that. Pull-Request: #3735.
110 lines
3.6 KiB
Rust
110 lines
3.6 KiB
Rust
// Copyright 2021 Protocol Labs.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
use prometheus_client::encoding::{EncodeLabelSet, EncodeLabelValue};
|
|
use prometheus_client::metrics::counter::Counter;
|
|
use prometheus_client::metrics::family::Family;
|
|
use prometheus_client::metrics::histogram::{exponential_buckets, Histogram};
|
|
use prometheus_client::registry::{Registry, Unit};
|
|
|
|
#[derive(Clone, Hash, PartialEq, Eq, EncodeLabelSet, Debug)]
|
|
struct FailureLabels {
|
|
reason: Failure,
|
|
}
|
|
|
|
impl From<&libp2p_ping::Failure> for FailureLabels {
|
|
fn from(failure: &libp2p_ping::Failure) -> Self {
|
|
match failure {
|
|
libp2p_ping::Failure::Timeout => FailureLabels {
|
|
reason: Failure::Timeout,
|
|
},
|
|
libp2p_ping::Failure::Unsupported => FailureLabels {
|
|
reason: Failure::Unsupported,
|
|
},
|
|
libp2p_ping::Failure::Other { .. } => FailureLabels {
|
|
reason: Failure::Other,
|
|
},
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Hash, PartialEq, Eq, EncodeLabelValue, Debug)]
|
|
enum Failure {
|
|
Timeout,
|
|
Unsupported,
|
|
Other,
|
|
}
|
|
|
|
pub(crate) struct Metrics {
|
|
rtt: Histogram,
|
|
failure: Family<FailureLabels, Counter>,
|
|
pong_received: Counter,
|
|
}
|
|
|
|
impl Metrics {
|
|
pub(crate) fn new(registry: &mut Registry) -> Self {
|
|
let sub_registry = registry.sub_registry_with_prefix("ping");
|
|
|
|
let rtt = Histogram::new(exponential_buckets(0.001, 2.0, 12));
|
|
sub_registry.register_with_unit(
|
|
"rtt",
|
|
"Round-trip time sending a 'ping' and receiving a 'pong'",
|
|
Unit::Seconds,
|
|
rtt.clone(),
|
|
);
|
|
|
|
let failure = Family::default();
|
|
sub_registry.register(
|
|
"failure",
|
|
"Failure while sending a 'ping' or receiving a 'pong'",
|
|
failure.clone(),
|
|
);
|
|
|
|
let pong_received = Counter::default();
|
|
sub_registry.register(
|
|
"pong_received",
|
|
"Number of 'pong's received",
|
|
pong_received.clone(),
|
|
);
|
|
|
|
Self {
|
|
rtt,
|
|
failure,
|
|
pong_received,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl super::Recorder<libp2p_ping::Event> for Metrics {
|
|
fn record(&self, event: &libp2p_ping::Event) {
|
|
match &event.result {
|
|
Ok(libp2p_ping::Success::Pong) => {
|
|
self.pong_received.inc();
|
|
}
|
|
Ok(libp2p_ping::Success::Ping { rtt }) => {
|
|
self.rtt.observe(rtt.as_secs_f64());
|
|
}
|
|
Err(failure) => {
|
|
self.failure.get_or_create(&failure.into()).inc();
|
|
}
|
|
}
|
|
}
|
|
}
|