mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-05-09 01:22:16 +00:00
17ee5047e3
This commit adds an implementation for the circuit relay v2 protocol to be used as a relay server, i.e. it supports incoming HOP requests and outgoing STOP requests and used as a relay clients, i.e. outgoing HOP requests and incoming STOP requests. The existing circuit relay v1 protocol implementation is moved to protocols/relay/src/v1. Co-authored-by: ronzigelman <ronzigelman@gmail.com> Co-authored-by: Marco Munizaga <git@marcopolo.io> Co-authored-by: Thomas Eizinger <thomas@eizinger.io> Co-authored-by: Elena Frank <57632201+elenaf9@users.noreply.github.com>
89 lines
3.1 KiB
Rust
89 lines
3.1 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.
|
|
|
|
//! Auxiliary crate recording protocol and Swarm events and exposing them as
|
|
//! metrics in the [OpenMetrics] format.
|
|
//!
|
|
//! [OpenMetrics]: https://github.com/OpenObservability/OpenMetrics/
|
|
//!
|
|
//! See `examples` directory for more.
|
|
|
|
#[cfg(feature = "gossipsub")]
|
|
mod gossipsub;
|
|
#[cfg(feature = "identify")]
|
|
mod identify;
|
|
#[cfg(feature = "kad")]
|
|
mod kad;
|
|
#[cfg(feature = "ping")]
|
|
mod ping;
|
|
#[cfg(feature = "relay")]
|
|
mod relay;
|
|
mod swarm;
|
|
|
|
use open_metrics_client::registry::Registry;
|
|
|
|
/// Set of Swarm and protocol metrics derived from emitted events.
|
|
pub struct Metrics {
|
|
#[cfg(feature = "gossipsub")]
|
|
gossipsub: gossipsub::Metrics,
|
|
#[cfg(feature = "identify")]
|
|
identify: identify::Metrics,
|
|
#[cfg(feature = "kad")]
|
|
kad: kad::Metrics,
|
|
#[cfg(feature = "ping")]
|
|
ping: ping::Metrics,
|
|
#[cfg(feature = "relay")]
|
|
relay: relay::Metrics,
|
|
swarm: swarm::Metrics,
|
|
}
|
|
|
|
impl Metrics {
|
|
/// Create a new set of Swarm and protocol [`Metrics`].
|
|
///
|
|
/// ```
|
|
/// use open_metrics_client::registry::Registry;
|
|
/// use libp2p_metrics::Metrics;
|
|
/// let mut registry = Registry::default();
|
|
/// let metrics = Metrics::new(&mut registry);
|
|
/// ```
|
|
pub fn new(registry: &mut Registry) -> Self {
|
|
let sub_registry = registry.sub_registry_with_prefix("libp2p");
|
|
Self {
|
|
#[cfg(feature = "gossipsub")]
|
|
gossipsub: gossipsub::Metrics::new(sub_registry),
|
|
#[cfg(feature = "identify")]
|
|
identify: identify::Metrics::new(sub_registry),
|
|
#[cfg(feature = "kad")]
|
|
kad: kad::Metrics::new(sub_registry),
|
|
#[cfg(feature = "ping")]
|
|
ping: ping::Metrics::new(sub_registry),
|
|
#[cfg(feature = "relay")]
|
|
relay: relay::Metrics::new(sub_registry),
|
|
swarm: swarm::Metrics::new(sub_registry),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Recorder that can record Swarm and protocol events.
|
|
pub trait Recorder<Event> {
|
|
/// Record the given event.
|
|
fn record(&self, event: &Event);
|
|
}
|