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
Ruud van Asseldonk 3f92abedd5
Make metrics tests independent of RUST_LOG env var (#16710) 
Previously, running the tests with RUST_LOG=none would fail, because the
env logger would set its filter level to reject all log messages, and
incrementing a counter only happens if the global logger has at least
the specified log level. Having the tests behave differently when
RUST_LOG is set is surprising, they should be self-contained.

Nix' buildRustPackage sets RUST_LOG="" to make the build logs less
verbose. I have trouble packaging Solana for Nix because of this, and I
believe making the tests independent of the environment is a good
solution for this.
 		2021-04-21 18:14:49 -06:00
..
scripts Merge pull request from GHSA-8v47-8c53-wwrc 2021-04-13 00:28:08 -06:00
src Make metrics tests independent of RUST_LOG env var (#16710) 2021-04-21 18:14:49 -06:00
.gitignore tmp dirs target to farf (#5079) 2019-07-12 18:28:42 -07:00
Cargo.toml Update to reqwest 0.11.2 2021-03-18 11:59:41 -07:00
README.md Rework cluster metrics dashboard to support the modern clusters 2020-03-11 14:14:56 -07: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 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.