blockworks-foundation
/
solana
mirror of https://github.com/blockworks-foundation/solana.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
solana/metrics
History
Will Hickey c0e4379f43
Whickey/version v1.15 (#27739) 
* Bump version to v1.13.0
* Bump version to v1.14.0
* Bump version to v1.15.0
 		2022-09-13 09:06:15 -05:00
..
benches Use write! to fix clippy and save heap allocation (#25220) 2022-05-16 22:39:33 +02:00
scripts Use net-stats-validator metric on the dashboard (#25171) 2022-05-12 20:20:20 +00:00
src Standardize thread names 2022-08-20 07:49:39 -07:00
.gitignore
…
Cargo.toml Whickey/version v1.15 (#27739) 2022-09-13 09:06:15 -05:00
README.md Rework cluster metrics dashboard to support the modern clusters 2020-03-11 14:14:56 -07:00
grafcli.conf
…
publish-metrics-dashboard.sh Rework cluster metrics dashboard to support the modern clusters 2020-03-11 14:14:56 -07: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/scripts/grafana-provisioning/dashboards/cluster-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/scripts/grafana-provisioning/dashboards/cluster-monitor.json, manual edits made directly in Grafana will be overwritten.

  • Check out metrics to add at https://metrics.solana.com:8888/ in the data explorer.
  • When editing a query for a dashboard graph, use the "Toggle Edit Mode" selection behind the hamburger button to use raw SQL and copy the query into the text field. You may have to fixup the query with the dashboard variables like $testnet or $timeFilter, check other functioning fields in the dashboard for examples.
  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/scripts/grafana-provisioning/dashboards/cluster-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 cluster-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.