Skip to content
Public template

Repository files navigation

Grafana Setup for Planetary Quantum

https://www.planetary-quantum.com/

In order to access logs and metrics in a unified fashion, this repository contains an example for installing Grafana on your Quantum cluster.

Deploy

In order to deploy, you'll need our quantum-cli tool.

Then follow these two steps:

Create stack file

Run cp docker-compose.example.yml docker-compose.yml, and edit it:

  • set the traefik.frontend.rule label to include the hostname of your endpoint/cluster (or your custom domain, if you want that)
  • set INITIAL_ADMIN_PASSWORD to something random
  • set QUANTUM_ENDPOINT to the name of your endpoint/cluster

Deploy it

Tip

Use our GitHub Action: setup-quantum-cli.

$ export QUANTUM_ENDPOINT=your-cluster-name
$ quantum-cli stack deploy --stack "grafana-$QUANTUM_ENDPOINT"

Basic usage

  • on the left-hand side menu choose "Explore" explore menu screenshot
  • select "Logs" at the top, and click on "Logs" right next to it docker logs selection screenshot
  • select some log label via the drop-down next to the search bar log label selection
  • you should now see your logs

For metrics: go to Dashboards. These dashboards are pre-configured:

  • "Nodes Overview": size and usage (CPU, RAM, disk) of each node, with links to the other two
  • "Usage By Stack": usage per node, stack and service
  • "Node Exporter Full": all details of a single node

Development

The dashboards live in dashboards. They are copies from our internal Grafana:

  • swarm.json keeps its uid, so existing links continue to work
  • node-exporter.json is 1860 with a patch: the host is selected by instance, not by nodename
$ make lint     # validate the dashboards
$ make test     # build the image, start it, check the provisioning
$ make run-dev  # http://localhost:3000 (admin/admin)