Evaluate/projects/libp2p/rust/misc/metrics/src/relay.rs

// 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::registry::Registry;

pub(crate) struct Metrics {
    events: Family<EventLabels, Counter>,
}

impl Metrics {
    pub(crate) fn new(registry: &mut Registry) -> Self {
        let sub_registry = registry.sub_registry_with_prefix("relay");

        let events = Family::default();
        sub_registry.register(
            "events",
            "Events emitted by the relay NetworkBehaviour",
            events.clone(),
        );

        Self { events }
    }
}

#[derive(Debug, Clone, Hash, PartialEq, Eq, EncodeLabelSet)]
struct EventLabels {
    event: EventType,
}

#[derive(Debug, Clone, Hash, PartialEq, Eq, EncodeLabelValue)]
enum EventType {
    ReservationReqAccepted,
    ReservationReqAcceptFailed,
    ReservationReqDenied,
    ReservationReqDenyFailed,
    ReservationTimedOut,
    CircuitReqDenied,
    CircuitReqDenyFailed,
    CircuitReqOutboundConnectFailed,
    CircuitReqAccepted,
    CircuitReqAcceptFailed,
    CircuitClosed,
}

impl From<&libp2p_relay::Event> for EventType {
    fn from(event: &libp2p_relay::Event) -> Self {
        match event {
            libp2p_relay::Event::ReservationReqAccepted { .. } => EventType::ReservationReqAccepted,
            #[allow(deprecated)]
            libp2p_relay::Event::ReservationReqAcceptFailed { .. } => {
                EventType::ReservationReqAcceptFailed
            }
            libp2p_relay::Event::ReservationReqDenied { .. } => EventType::ReservationReqDenied,
            #[allow(deprecated)]
            libp2p_relay::Event::ReservationReqDenyFailed { .. } => {
                EventType::ReservationReqDenyFailed
            }
            libp2p_relay::Event::ReservationTimedOut { .. } => EventType::ReservationTimedOut,
            libp2p_relay::Event::CircuitReqDenied { .. } => EventType::CircuitReqDenied,
            #[allow(deprecated)]
            libp2p_relay::Event::CircuitReqOutboundConnectFailed { .. } => {
                EventType::CircuitReqOutboundConnectFailed
            }
            #[allow(deprecated)]
            libp2p_relay::Event::CircuitReqDenyFailed { .. } => EventType::CircuitReqDenyFailed,
            libp2p_relay::Event::CircuitReqAccepted { .. } => EventType::CircuitReqAccepted,
            #[allow(deprecated)]
            libp2p_relay::Event::CircuitReqAcceptFailed { .. } => EventType::CircuitReqAcceptFailed,
            libp2p_relay::Event::CircuitClosed { .. } => EventType::CircuitClosed,
        }
    }
}

impl super::Recorder<libp2p_relay::Event> for Metrics {
    fn record(&self, event: &libp2p_relay::Event) {
        self.events
            .get_or_create(&EventLabels {
                event: event.into(),
            })
            .inc();
    }
}