Updates as per comments

waku-org · Jan 20, 2025 · e01a61e · e01a61e
1 parent 0bf5e7e
commit e01a61e
Showing 1 changed file with 24 additions and 20 deletions.
diff --git a/docs/benchmarks/test-results-summary.md b/docs/benchmarks/test-results-summary.md
@@ -4,36 +4,40 @@ title: Performance Benchmarks and Test Reports
 
 
 ## Introduction
-This page summarizes key performance metrics for nwaku and provides links to detailed test reports.
+This page summarises key performance metrics for nwaku and provides links to detailed test reports.
 
-> ## Quick reference
+> ## TL;DR
 >
-> - **10%** decrease in bandwidth usage in larger networks (1000 vs 2000 relay nodes)
-> - **0.4s** average, **5.5s** max message propogation latency (2000 relay nodes)
+> - libp2p bandwidth usage fluctuates between 5 and 15 KB/s for topologies of up to 1000 nodes, with average bandwidth usage at **10 KB/s**.
+> - The average bandwidth usage remains roughly the same at **9 KB/s** for a larger topology of 2000 nodes.  
+This is expected for Relay networks and the slight fluctuation could be due to simulation artifacts or chance differences in routing or connectivity between test runs.
+> - **0.4s** on average for a message to propagate to 100% of nodes in topologies of up to 2000 Relay nodes
+> - In a network with all nodes continuously online, the average per-node bandwidth usage of the Discv5 protocol is **8.7 KB/s** for incoming traffic and **7.4 KB/s** for outgoing traffic 
 > - Relevancy to Status App: TODO
 
 
-
 ## Insights
-*Some metrics for specific protocols are currently unavailable due to reporting and logging limitations. Improvements are in progress.*
 
 ### Bandwidth Usage: nwaku v0.34
-Average `libp2p` bandwidth usage for  1KB message size in a 1000 relay nodes network
+Average `libp2p` per-node bandwidth usage for various message injection rates into a Relay network of constant size `1000`.
+The messages are all 1KB in size.
 
-| Message Rate | libp2p-in (KB/s) | libp2p-out (KB/s) |
-|--------------|------------------|-------------------|
-| 1 msg/s      | ~10.1            | ~10.3             |
-| 1 msg/10s    | ~1.8             | ~1.9              |
+| Message Injection Rate | Average libp2p incoming bandwidth (KB/s) | Average libp2p outgoing bandwidth (KB/s) |
+|------------------------|------------------------------------------|------------------------------------------|
+| 1 msg/s                | ~10.1                                    | ~10.3                                    |
+| 1 msg/10s              | ~1.8                                     | ~1.9                                     |
 
-### Message Latency: nwaku v0.34.0-rc1
-Latency results for 1KB messages (1msg/s, 600 total). Click on config to see detailed report:
+### Message Propagation Latency: nwaku v0.34.0-rc1
+The results for the average time for messages to reach all nodes in different network configurations are shown below.  
+For each simulation 600 messages of 1KB were sent at a message injection rate of 1msg/s.  
+Click on a specific config to see the detailed test report.
 
 
-| Config            | Avg Latency | Max Latency |
-|------------------------|-------------|-------------|
-| [Relay](https://www.notion.so/Waku-regression-testing-v0-34-1618f96fb65c803bb7bad6ecd6bafff9) (1000 nodes)     | 0.05s       | 1.6s        |
-| [Mixed](https://www.notion.so/Mixed-environment-analysis-1688f96fb65c809eb235c59b97d6e15b) (210 nodes)      | 0.0125s     | 0.007s      |
-| [Non-persistent Relay](https://www.notion.so/High-Churn-Relay-Store-Reliability-16c8f96fb65c8008bacaf5e86881160c)   | 0.0125s     | 0.25s       |  
+| Config                                                                                                           | Avg Message Propagation Latency (s) | Max Message Propagation Latency (s)|
+|------------------------------------------------------------------------------------------------------------------|-------------------------------------|------------------------------------|
+| [Relay](https://www.notion.so/Waku-regression-testing-v0-34-1618f96fb65c803bb7bad6ecd6bafff9) (1000 nodes)       | 0.05                                | 1.6                                |
+| [Mixed](https://www.notion.so/Mixed-environment-analysis-1688f96fb65c809eb235c59b97d6e15b) (210 nodes)           | 0.0125                              | 0.007                              |
+| [Non-persistent Relay](https://www.notion.so/High-Churn-Relay-Store-Reliability-16c8f96fb65c8008bacaf5e86881160c) (510 nodes)| 0.0125                              | 0.25                               |  
 
 
 ## Testing
@@ -44,7 +48,7 @@ The VAC DST team performs regression testing on all new **nwaku** releases, comp
 
 
 ### QA
-The VAC QA team performs interoperability tests for **Nim Waku** and **Go Waku** using the latest main branch images. These tests run daily and verify protocol functionality by targeting specific features of each protocol.  
+The VAC QA team performs interoperability tests for **nwaku** and **go-waku** using the latest main branch builds. These tests run daily and verify protocol functionality by targeting specific features of each protocol.  
 
 **Test Reports**: [QA Reports](https://discord.com/channels/1110799176264056863/1196933819614363678)  
 
@@ -60,4 +64,4 @@ The Waku Research team conducts a variety of benchmarking, performance testing,
 
 **Test Reports**: [Waku Research Reports](https://www.notion.so/Miscellaneous-2c02516248db4a28ba8cb2797a40d1bb)
 
-**Waku Simulator**: [Waku SImulator Book](https://waku-org.github.io/waku-simulator/)
+**Waku Simulator**: [Waku Simulator Book](https://waku-org.github.io/waku-simulator/)