Update readme with metrics info + example dashboard json

status-im · Dec 18, 2019 · a596e02 · a596e02
1 parent 6ef3be0
commit a596e02
Show file tree

Hide file tree

Showing 2 changed files with 649 additions and 0 deletions.
diff --git a/waku/README.md b/waku/README.md
@@ -33,3 +33,20 @@ Example of a quick test with nim-web3:
 
 ./build/quicksim
 ```
+
+# Using Metrics
+
+Metrics are available for valid envelopes and dropped envelopes.
+
+To compile in an HTTP endpoint for accessing the metrics we need to provide the
+`insecure` flag:
+```bash
+make NIMFLAGS="-d:insecure" wakunode
+./build/wakunode --metrics-server
+```
+
+For visualisation, similar steps can be used as is written down for Nimbus
+[here](https://github.com/status-im/nimbus#metric-visualisation).
+
+There is a similar example dashboard that includes visualisation of the
+envelopes available at `waku/examples/waku-grafana-dashboard.json`.