Skip to content

Commit

Permalink
chore(docs): update the main readme to point to the metrics docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RolandSherwin committed Oct 4, 2023
1 parent 57dceae commit 1fee7af
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,11 @@ $ cargo run --release --example safenode_rpc_client -- 127.0.0.1:12001 update 70
Node successfully received the request to try to update in 7s
```

# OpenMetrics
# Metrics Dashboard

Use the `open-metrics` feature flag on the node / client to start an [OpenMetrics](https://github.com/OpenObservability/OpenMetrics/) exporter. The metrics are served via a webserver started at a random port. Check the log file / stdout to find the webserver URL, `Metrics server on http://127.0.0.1:xxxx/metrics`

The metrics can then be collected using a collector (for e.g. Prometheus) and the data can then be imported into any visualization tool (for e.g., Grafana) to be further analyzed.
The metrics can then be collected using a collector (for e.g. Prometheus) and the data can then be imported into any visualization tool (for e.g., Grafana) to be further analyzed. Refer to this [Guide](./metrics/README.md) to easily setup a dockerized Grafana dashboard to visualize the metrics.

### Archive

Expand Down
2 changes: 1 addition & 1 deletion metrics/grafana/provisioning/dashboards/safe-network.json
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@
},
"disableTextWrap": false,
"editorMode": "builder",
"expr": "sn_node_reward_wallet_balance",
"expr": "sn_node_reward_wallet_balance{node_id=~\"$var_node_list\"}",
"fullMetaSearch": false,
"includeNullMetadata": true,
"instant": false,
Expand Down

0 comments on commit 1fee7af

Please sign in to comment.