fix: refactor metrics strategy to support multiple subnetworks

Cargo.toml

@@ -20,6 +20,7 @@ eth2_ssz = "0.4.0"
 ethereum-types = "0.12.1"
 ethportal-api = { path = "ethportal-api" }
 jsonrpsee = "0.20.0"
+lazy_static = "1.4.0"
 parking_lot = "0.11.2"
 portalnet = { path = "portalnet" }
 prometheus_exporter = "0.8.4"

book/src/users/monitoring.md

@@ -266,6 +266,12 @@ cargo run -p trin -- \
  --web3-transport http
 ```
 
+### Updating metrics dashboard
+If there are new changes to the metrics dashboard template that you want to view in
+an already-existing dashboard. The simplest way to update your dashboard is to delete
+your `prometheus` datasource and `Trin App metrics` dashboard, and re-run the
+`create-dashboard` command.
+
 ### View metrics remotely
 Trin metrics on a remote machine can be monitored by listening to the grafana
 address on a local machine.

ethportal-api/src/dashboard/grafana.rs

@@ -12,6 +12,8 @@ pub struct GrafanaAPI {
  address: String,
 }
 
+// todo: automatically update datasource/dashboard via `create-dashboard` command
+// rather than deleting and recreating them
 impl GrafanaAPI {
  pub fn new(username: String, password: String, address: String) -> Self {
  let basic_auth_string = format!("{username}:{password}");

portalnet/src/config.rs

@@ -0,0 +1,52 @@
+use std::net::SocketAddr;
+
+use ethereum_types::H256;
+
+use ethportal_api::types::bootnodes::Bootnodes;
+use ethportal_api::types::cli::TrinConfig;
+use ethportal_api::types::distance::Distance;
+
+/// Capacity of the cache for observed `NodeAddress` values.
+/// Provides capacity for 32 full k-buckets. This capacity will be shared among all active portal
+/// subnetworks.
+const NODE_ADDR_CACHE_CAPACITY: usize = discv5::kbucket::MAX_NODES_PER_BUCKET * 32;
+
+#[derive(Clone)]
+pub struct PortalnetConfig {
+ pub external_addr: Option<SocketAddr>,
+ pub private_key: H256,
+ pub listen_port: u16,
+ pub bootnodes: Bootnodes,
+ pub data_radius: Distance,
+ pub internal_ip: bool,
+ pub no_stun: bool,
+ pub node_addr_cache_capacity: usize,
+}
+
+impl Default for PortalnetConfig {
+ fn default() -> Self {
+ Self {
+ external_addr: None,
+ private_key: H256::random(),
+ listen_port: 4242,
+ bootnodes: Bootnodes::default(),
+ data_radius: Distance::MAX,
+ internal_ip: false,
+ no_stun: false,
+ node_addr_cache_capacity: NODE_ADDR_CACHE_CAPACITY,
+ }
+ }
+}
+
+impl PortalnetConfig {
+ pub fn new(trin_config: &TrinConfig, private_key: H256) -> Self {
+ Self {
+ external_addr: trin_config.external_addr,
+ private_key,
+ listen_port: trin_config.discovery_port,
+ no_stun: trin_config.no_stun,
+ bootnodes: trin_config.bootnodes.clone(),
+ ..Default::default()
+ }
+ }
+}

portalnet/src/discovery.rs

@@ -1,29 +1,32 @@
-use super::types::messages::{PortalnetConfig, ProtocolId};
-use crate::socket;
+use std::hash::{Hash, Hasher};
+use std::net::Ipv4Addr;
+use std::path::PathBuf;
+use std::str::FromStr;
+use std::{convert::TryFrom, fmt, fs, io, net::SocketAddr, sync::Arc};
+
 use anyhow::anyhow;
 use async_trait::async_trait;
 use bytes::BytesMut;
 use discv5::{
  enr::{CombinedKey, EnrBuilder, NodeId},
  ConfigBuilder, Discv5, Event, ListenConfig, RequestError, TalkRequest,
 };
-use ethportal_api::types::enr::Enr;
-use ethportal_api::utils::bytes::hex_encode;
-use ethportal_api::NodeInfo;
 use lru::LruCache;
 use parking_lot::RwLock;
 use rlp::RlpStream;
 use serde_json::{json, Value};
-use std::hash::{Hash, Hasher};
-use std::net::Ipv4Addr;
-use std::path::PathBuf;
-use std::str::FromStr;
-use std::{convert::TryFrom, fmt, fs, io, net::SocketAddr, sync::Arc};
 use tokio::sync::mpsc;
 use tracing::{debug, info, warn};
-use trin_utils::version::get_trin_version;
 use utp_rs::{cid::ConnectionPeer, udp::AsyncUdpSocket};
 
+use super::config::PortalnetConfig;
+use super::types::messages::ProtocolId;
+use crate::socket;
+use ethportal_api::types::enr::Enr;
+use ethportal_api::utils::bytes::hex_encode;
+use ethportal_api::NodeInfo;
+use trin_utils::version::get_trin_version;
+
 /// Size of the buffer of the Discv5 TALKREQ channel.
 const TALKREQ_CHANNEL_BUFFER: usize = 100;
 

portalnet/src/lib.rs

@@ -1,5 +1,6 @@
 #![warn(clippy::unwrap_used)]
 
+pub mod config;
 pub mod discovery;
 pub mod events;
 pub mod find;

portalnet/src/metrics/mod.rs

@@ -1,2 +1,4 @@
 pub mod labels;
 pub mod overlay;
+pub mod portalnet;
+pub mod storage;