YGGverse/aquatic
1
0
Fork 0
mirror of https://github.com/YGGverse/aquatic.git synced 2026-04-02 18:55:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

udp: update config comments

Browse source
This commit is contained in:
Joakim Frostegård 2023-06-08 01:25:58 +02:00
parent da25d60a5d
commit e6b0585372
1 changed files with 3 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
aquatic_udp/src/config.rs
View file

@ -169,7 +169,8 @@ pub struct StatisticsConfig {
/// ///
/// Also, see `prometheus_peer_id_prefixes`. /// Also, see `prometheus_peer_id_prefixes`.
/// ///
/// Quite costly when it comes to CPU and RAM. /// Expect a certain CPU hit (maybe 5% higher consumption) and a bit higher
/// memory use
pub peer_clients: bool, pub peer_clients: bool,
/// Print statistics to standard output /// Print statistics to standard output
pub print_to_stdout: bool, pub print_to_stdout: bool,
@ -184,6 +185,7 @@ pub struct StatisticsConfig {
#[cfg(feature = "prometheus")] #[cfg(feature = "prometheus")]
pub prometheus_endpoint_address: SocketAddr, pub prometheus_endpoint_address: SocketAddr,
/// Serve information on all peer id prefixes on the prometheus endpoint. /// Serve information on all peer id prefixes on the prometheus endpoint.
///
/// Requires `peer_clients` to be activated. /// Requires `peer_clients` to be activated.
/// ///
/// May consume quite a bit of CPU and RAM, since data on every single peer /// May consume quite a bit of CPU and RAM, since data on every single peer