solana/metrics
Michael Vines 6e00c6790e Move testnet metrics dashboard management out of the Grafana UI 2018-11-25 16:10:25 -08:00
..
src Move metrics into its own crate 2018-11-16 15:10:07 -08:00
Cargo.toml Move metrics into its own crate 2018-11-16 15:10:07 -08:00
README.md Move testnet metrics dashboard management out of the Grafana UI 2018-11-25 16:10:25 -08:00
adjust-dashboard-for-channel.py Move testnet metrics dashboard management out of the Grafana UI 2018-11-25 16:10:25 -08:00
grafcli.conf Move testnet metrics dashboard management out of the Grafana UI 2018-11-25 16:10:25 -08:00
publish-metrics-dashboard.sh Move testnet metrics dashboard management out of the Grafana UI 2018-11-25 16:10:25 -08:00
testnet-monitor.json Move testnet metrics dashboard management out of the Grafana UI 2018-11-25 16:10:25 -08:00

README.md

Metrics

Testnet Grafana Dashboard

There are three versions of the testnet dashboard, corresponding to the three release channels:

The dashboard for each channel is defined from the metrics/testnet-monitor.json source file in the git branch associated with that channel, and deployed by automation running ci/publish-metrics-dashboard.sh.

A deploy can be triggered at any time via the New Build button of https://buildkite.com/solana-labs/publish-metrics-dashboard.

Modifying a Dashboard

Dashboard updates are accomplished by modifying metrics/testnet-monitor.json, manual edits made directly in Grafana will be overwritten.

  1. Open the desired dashboard in Grafana
  2. Create a development copy of the dashboard by selecting Save As.. in the Settings menu for the dashboard
  3. Edit dashboard as desired
  4. Extract the JSON Model by selecting JSON Model in the Settings menu. Copy the JSON to the clipboard and paste into metrics/testnet-monitor.json
  5. Delete your development dashboard: Settings => Delete

Deploying a Dashboard Manually

If you need to immediately deploy a dashboard using the contents of metrics/testnet-monitor.json in your local workspace,

$ export GRAFANA_API_TOKEN="an API key from https://metrics.solana.com:3000/org/apikeys"
$ metrics/publish-metrics-dashboard.sh (edge|beta|stable)

Note that automation will eventually overwrite your manual deploy.