chore: remove redundancies

Author: lla-dane

docs/examples.metrics.rst

@@ -65,6 +65,20 @@ start the prometheus and grafana dashboards. For this create a `docker-compose.y
     depends_on:
       - prometheus
 
+And a `prometheus.yml` file like this:
+
+.. code-block:: console
+
+    global:
+        scrape_interval: 5s
+
+    scrape_configs:
+    - job_name: "libp2p-python"
+        static_configs:
+        - targets:
+            - "host.docker.internal:8000"
+
+
 And run it like this
 .. code-block:: console
 
@@ -73,6 +87,7 @@ And run it like this
 A similar file is present in `py-libp2p/libp2p/metrics` directory also, so either create a new docker-compose
 file or run it from the above path. This basically starts a prometheus and grafana server in your localhost,
 with which the metrics can be viewed in graph format.
+Remember that the dashboards will be created for the node, whose prometheus metric-server is running on port `8000`.
 
 Now see how to communicate between the 2 nodes, via Pubsub/Gossipsub, Ping and Kad-DHT
 

examples/metrics/coordinator.py

@@ -20,13 +20,18 @@
 Available commands:
 - connect <multiaddr>               - Connect to another peer
 - ping <maddr> <count>              - Ping to another peer
+
+GOSSIPSUB
 - join <topic>                      - Subscribe to a topic
 - leave <topic>                     - Unsubscribe to a topic
 - publish <topic> <message>         - Publish a message
+
+KAD-DHT
 - put <key> <value>                 - Execute PUT_VALUE in DHT
 - get <key>                         - Execute GET_VALUE in DHT
 - advertize <content-id>            - Execute ADD_PROVIDER in DHT
 - get_provider <content-id>         - Execute GET_PROVIDERS in DHT
+
 - local                             - List local multiaddr
 - help                              - List the existing commands
 - exit                              - Shut down

libp2p/metrics/kad_dht.py

@@ -2,15 +2,6 @@
 
 from libp2p.kad_dht.kad_dht import KadDhtEvent
 
-# COUNTER
-
-# INBOUND_REQ
-# FIND_NODE
-# GET_VALUE
-# PUT_VALUE
-# GET_PROVIDERS
-# ADD_PROVIDERS
-
 
 class KadDhtMetrics:
     inbound: Counter

libp2p/metrics/swarm.py

@@ -1,12 +1,5 @@
 from prometheus_client import Counter
 
-# METRICS
-
-# conn_incoming
-# conn_incoming_error
-# dial_attemp
-# conn_outgoing_error
-
 
 class SwarmEvent:
     peer_id: str | None = None

libp2p/pubsub/gossipsub.py

@@ -78,6 +78,7 @@
 
 _MAX_PENDING_GRAFT_PRUNE_PER_PEER = 64
 
+
 class GossipSub(IPubsubRouter, Service):
     protocols: list[TProtocol]
     pubsub: Pubsub | None

tests/core/network/test_stream_semaphore.py

@@ -44,7 +44,7 @@ def _mock_net_stream(swarm_conn: Mock | None = None) -> NetStream:
     muxed_stream.close = AsyncMock()
     muxed_stream.reset = AsyncMock()
 
-    ns = NetStream(muxed_stream, swarm_conn)
+    ns = NetStream(muxed_stream, swarm_conn, None)
     return ns