solana/metrics/scripts/README.md

50 lines
1.3 KiB
Markdown
Raw Normal View History

This directory contains scripts to manage a local instance of [InfluxDB OSS](https://docs.influxdata.com/influxdb/v1.5/) and [Grafana](https://grafana.com/docs/v5.2/)
### Setup
Start the local metric services:
`$ ./start.sh`
Metrics are enabled on a per-shell basis which means you must `source` the following scripts in each shell in which you start an application you wish to collect metrics from. For example, if running a Solana fullnode you must call `source ./enable.sh` before starting the node.
`$ source ./enable.sh`
Once metrics have been started and you have an application running you can view the metrics at:
http://localhost:3000/d/local/local-monitor
Stop metric services:
`$ ./stop.sh`
### InfluxDB CLI
You may find it useful to install the InfluxDB client for
adhoc metrics collection/viewing
* Linux - `sudo apt-get install influxdb-client`
* macOS - `brew install influxdb`
Simple example of pulling all `thinclient` measurements out
of the `local` database:
```sh
$ influx -database local -username admin -password admin -execute 'select * from thinclient'
```
Reference: https://docs.influxdata.com/influxdb/v1.5/query_language/
### Monitoring
To monitor activity, run one of:
```
$ docker logs -f influxdb
$ docker logs -f grafana
```
### Reference
* https://hub.docker.com/_/influxdata-influxdb
* https://hub.docker.com/r/grafana/grafana