Dashboards for KnowWhereGraph service monitoring
The grafana deployment can be found on port `3000`` of the server that it's deployed on.
Set the username and password in the docker-compose file; use these to sign into the dashboard. The data connection to prometheus and dashboard integrations are automatic and will be set up when the service is started.
The username and password for prometheus also need to be set in provisioning/datasources/all.yml.
Note: Folders that are mounted to the grafana container should have permissions set from sudo chown -R 472:472. Eg: sudo chown -R 472:472 persistent_config/.
Some important notes:
- There are dashboard JSON definitions. These are JSON files that are the actual dashboard controls.
- There are dashboard yaml definitions. These are yaml files that point to the JSON definitions.
- The two definitions are mounted in different locations (check the docker-compose)
- There is a
persistent_configfolder that's created by the Grafana process. This can be deleted between deployments - There is a
configfolder that contains important dashboard and Grafana config. Don't delete this
New dashboards should be added to the provisioning/dashboards folder and the sources (if needed) should be documented in this Readme, in the Dashboard Sources section.
The dashboards are taken from pre-designed packages, which are available on the Grafana Labs Portal. The dashboard sources are linked below.
- ElasticSearch
- Prometheus
- Node Exporter
- NGINX
- KWG-API: Custom
Grafana makes use of two data sources
Prometheus stores the metrics data and requires the prometheus user/pass to connect. This is set in the datasource yaml file, and the credentials should match the prometheus docker-compose credentials.
Loki is the log data source. The communication with this service is unauthenticated.