mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 11:38:01 +00:00
ec47877288
* Refactor sc-network/service metrics. 1. Aggregate sc-network metrics into a submodule, introducing two more sourced metrics to avoid duplicate atomics. 2. Decouple periodic sc-service network metrics from other metrics, so that they can be updated independently. * Update client/service/src/metrics.rs * Update client/service/src/metrics.rs
110 lines
3.9 KiB
Rust
110 lines
3.9 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) 2017-2020 Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
//! Information about the networking, for diagnostic purposes.
|
|
//!
|
|
//! **Warning**: These APIs are not stable.
|
|
|
|
use libp2p::{core::ConnectedPoint, Multiaddr};
|
|
use serde::{Deserialize, Serialize};
|
|
use slog_derive::SerdeValue;
|
|
use std::{collections::{HashMap, HashSet}, time::Duration};
|
|
|
|
/// Returns general information about the networking.
|
|
///
|
|
/// Meant for general diagnostic purposes.
|
|
///
|
|
/// **Warning**: This API is not stable.
|
|
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, SerdeValue)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct NetworkState {
|
|
/// PeerId of the local node.
|
|
pub peer_id: String,
|
|
/// List of addresses the node is currently listening on.
|
|
pub listened_addresses: HashSet<Multiaddr>,
|
|
/// List of addresses the node knows it can be reached as.
|
|
pub external_addresses: HashSet<Multiaddr>,
|
|
/// List of node we're connected to.
|
|
pub connected_peers: HashMap<String, Peer>,
|
|
/// List of node that we know of but that we're not connected to.
|
|
pub not_connected_peers: HashMap<String, NotConnectedPeer>,
|
|
/// State of the peerset manager.
|
|
pub peerset: serde_json::Value,
|
|
}
|
|
|
|
/// Part of the `NetworkState` struct. Unstable.
|
|
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct Peer {
|
|
/// How we are connected to the node.
|
|
pub endpoint: PeerEndpoint,
|
|
/// Node information, as provided by the node itself. Can be empty if not known yet.
|
|
pub version_string: Option<String>,
|
|
/// Latest ping duration with this node.
|
|
pub latest_ping_time: Option<Duration>,
|
|
/// If true, the peer is "enabled", which means that we try to open Substrate-related protocols
|
|
/// with this peer. If false, we stick to Kademlia and/or other network-only protocols.
|
|
pub enabled: bool,
|
|
/// If true, the peer is "open", which means that we have a Substrate-related protocol
|
|
/// with this peer.
|
|
pub open: bool,
|
|
/// List of addresses known for this node.
|
|
pub known_addresses: HashSet<Multiaddr>,
|
|
}
|
|
|
|
/// Part of the `NetworkState` struct. Unstable.
|
|
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct NotConnectedPeer {
|
|
/// List of addresses known for this node.
|
|
pub known_addresses: HashSet<Multiaddr>,
|
|
/// Node information, as provided by the node itself, if we were ever connected to this node.
|
|
pub version_string: Option<String>,
|
|
/// Latest ping duration with this node, if we were ever connected to this node.
|
|
pub latest_ping_time: Option<Duration>,
|
|
}
|
|
|
|
/// Part of the `NetworkState` struct. Unstable.
|
|
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub enum PeerEndpoint {
|
|
/// We are dialing the given address.
|
|
Dialing(Multiaddr),
|
|
/// We are listening.
|
|
Listening {
|
|
/// Local address of the connection.
|
|
local_addr: Multiaddr,
|
|
/// Address data is sent back to.
|
|
send_back_addr: Multiaddr,
|
|
},
|
|
}
|
|
|
|
impl From<ConnectedPoint> for PeerEndpoint {
|
|
fn from(endpoint: ConnectedPoint) -> Self {
|
|
match endpoint {
|
|
ConnectedPoint::Dialer { address } =>
|
|
PeerEndpoint::Dialing(address),
|
|
ConnectedPoint::Listener { local_addr, send_back_addr } =>
|
|
PeerEndpoint::Listening {
|
|
local_addr,
|
|
send_back_addr
|
|
}
|
|
}
|
|
}
|
|
}
|