nwaku/apps/networkmonitor
Darshan K 9bd8c33aee
chore: remove all pre-nim-1.6 deadcode from codebase (#2857)
2024-06-28 16:04:57 +05:30
..
README.md chore: switch wakuv2 to waku fleet (#2519) 2024-03-20 16:28:00 +01:00
networkmonitor.nim chore: remove all pre-nim-1.6 deadcode from codebase (#2857) 2024-06-28 16:04:57 +05:30
networkmonitor_config.nim chore: Minor enhancements (#2789) 2024-06-09 23:09:23 +02:00
networkmonitor_metrics.nim chore: remove all pre-nim-1.6 deadcode from codebase (#2857) 2024-06-28 16:04:57 +05:30
networkmonitor_utils.nim chore: remove all pre-nim-1.6 deadcode from codebase (#2857) 2024-06-28 16:04:57 +05:30
nim.cfg chore: move networkmonitor and wakucanary to apps directory 2023-04-27 16:25:31 +02:00

README.md

networkmonitor

Monitoring tool to run in an existing waku network with the following features:

  • Keeps discovering new peers using discv5
  • Tracks advertised capabilities of each node as per stored in the ENR waku field
  • Attempts to connect to all nodes, tracking which protocols each node supports
  • Presents grafana-ready metrics showing the state of the network in terms of locations, ips, number discovered peers, number of peers we could connect to, user-agent that each peer contains, content topics and the amount of rx messages in each one.
  • Metrics are exposed through prometheus metrics but also with a custom rest api, presenting detailed information about each peer. These metrics are exposed via a rest api.

Usage

./build/networkmonitor --help
Usage:

networkmonitor [OPTIONS]...

The following options are available:

 -l, --log-level               Sets the log level [=LogLevel.DEBUG].
 -t, --timeout                 Timeout to consider that the connection failed [=chronos.seconds(10)].
 -b, --bootstrap-node          Bootstrap ENR node. Argument may be repeated. [=@[""]].
     --dns-discovery-url       URL for DNS node list in format 'enrtree://<key>@<fqdn>'.
 -r, --refresh-interval        How often new peers are discovered and connected to (in seconds) [=5].
     --metrics-server          Enable the metrics server: true|false [=true].
     --metrics-server-address  Listening address of the metrics server. [=ValidIpAddress.init("127.0.0.1")].
     --metrics-server-port     Listening HTTP port of the metrics server. [=8008].
     --metrics-rest-address    Listening address of the metrics rest server. [=127.0.0.1].
     --metrics-rest-port       Listening HTTP port of the metrics rest server. [=8009].

Example

Connect to the network through a given bootstrap node, with default parameters. See metrics section for the data that it exposes.

./build/networkmonitor --log-level=INFO --b="enr:-QEkuEB3WHNS-xA3RDpfu9A2Qycr3bN3u7VoArMEiDIFZJ66F1EB3d4wxZN1hcdcOX-RfuXB-MQauhJGQbpz3qUofOtLAYJpZIJ2NIJpcIQI2SVcim11bHRpYWRkcnO4bgA0Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQZ2XwA2Ni9ub2RlLTAxLmFjLWNuLWhvbmdrb25nLWMud2FrdS5zYW5kYm94LnN0YXR1cy5pbQYfQN4DgnJzkwABCAAAAAEAAgADAAQABQAGAAeJc2VjcDI1NmsxoQPK35Nnz0cWUtSAhBp7zvHEhyU_AqeQUlqzLiLxfP2L4oN0Y3CCdl-DdWRwgiMohXdha3UyDw"
./build/networkmonitor --log-level=INFO --dns-discovery-url=enrtree://AL65EKLJAUXKKPG43HVTML5EFFWEZ7L4LOKTLZCLJASG4DSESQZEC@prod.status.nodes.status.im

Metrics

Metrics are divided into two categories:

  • Prometheus metrics, exposed as i.e. gauges.
  • Custom metrics, used for unconstrained labels such as peer information or content topics.
    • These metrics are not exposed through prometheus because since they are unconstrained, they can end up breaking the backend, as a new datapoint is generated for each one and it can reach up a point where is too much to handle.

### Prometheus Metrics

The following metrics are available. See http://localhost:8008/metrics

  • peer_type_as_per_enr: Number of peers supporting each capability according to the ENR (Relay, Store, Lightpush, Filter)
  • peer_type_as_per_protocol: Number of peers supporting each protocol, after a successful connection)
  • peer_user_agents: List of useragents found in the network and their count

Other relevant metrics reused from nim-eth:

  • routing_table_nodes: Inherited from nim-eth, number of nodes in the routing table
  • discovery_message_requests_outgoing_total: Inherited from nim-eth, number of outgoing discovery requests, useful to know if the node is actively looking for new peers

### Custom Metrics

The following endpoints are available:

  • http://localhost:8009/allpeersinfo: json list of all peers with extra information such as ip, location, supported protocols and last connection time.
  • http://localhost:8009/contenttopics: content topic messages and its message count.