Creating custom Grafana dashboards

Guide explaining how to manage custom Grafana dashboards in the Observability Platform.

You can find in your installations Grafana a set of out-of-the-box dashboards provided by Giant Swarm. However these default dashboards might not satisfy your specific observability requirements or your apps or clusters unique context. This is why the Observability Platform allows you to create your own dashboards in self-service.

Creating your own dashboard

To create your own dashboard, you can create a configmap resource in the management cluster in any namespace you want containing the dashboard. For example:

apiVersion: v1
data:
  my-dashboard.json: |-
    { ... my dashboard in JSON format }    
kind: ConfigMap
metadata:
  annotations:
    ## Define the organization in Grafana where the dashboard will be added
    observability.giantswarm.io/organization: Customer
  labels:
    ## Tell Grafana to load this configmap as a dashboard
    app.giantswarm.io/kind: dashboard
  name: my-grafana-dashboard
  namespace: my-namespace

Limitations

• the dashboard’s JSON must contain an uid otherwise it won’t be provisioned.
• the dashboard name and UID must be unique in each Grafana organization.