Graaf

Thu, 28 Dec 2023 18:11:35 +0100

Graaf is a Go program that translates simple dashboards written in YAML to Grafana JSON. It has an extensive manual page that explains its usage. This is also known as Grafana as code, but then for real.

The following is a dashboard with 4 panels that I use for my own monitoring.

title: Overview i
uid: dashboard-overview
panels:
  - timeseries:
      title: 'Network Bytes [5m] - edgemax.i'
      y:
        unit: Bps
      exprs:
        - expr: 'rate(ifHCOutOctets{ifAlias="eth0",job="edgemax"}[5m])'
          legend: '{{ifAlias}} transmit'
        - expr: 'rate(ifHCInOctets{ifAlias="eth0",job="edgemax"}[5m])'
          legend: '{{ifAlias}} receive'
          transform: negative-y
  - timeseries:
      title: 'HTTPS Queries [5m]'
      y:
        unit: rps
      exprs:
        - expr: 'sum by (host) (rate(caddy_http_request_count_total{job="caddy"}[5m]))'
          legend: '{{host}}'
        - expr: 'sum (rate(caddy_http_request_count_total{job="caddy"}[5m]))'
          legend: total
          transform: negative-y
  - timeseries:
      title: 'DNS Queries [5m]'
      y:
        unit: rps
      exprs:
        - expr: 'sum by (zone) (rate(coredns_dns_requests_total{job="nsdns",zone!="dropped"}[5m]))'
          legend: '{{zone}}'
        - expr: 'sum (rate(coredns_dns_requests_total{job="nsdns"}[5m]))'
          legend: total
          transform: negative-y
        - expr: 'sum (rate(coredns_dns_requests_total{job="nsdns",zone="dropped"}[5m]))'
          legend: dropped
          transform: negative-y
  - timeseries:
      title: 'Network Bytes [5m] - nuc.i'
      y:
        unit: Bps
      exprs:
        - expr: 'rate(node_network_transmit_bytes_total{job="node",device="eno1"}[5m])'
          legend: '{{device}} transmit'
          threshold: 'ok{value="0"}'
        - expr: 'rate(node_network_receive_bytes_total{job="node",device="eno1"}[5m])'
          legend: '{{device}} receive'
          transform: negative-y

This dashboard is 47 lines, the generated JSON dashboard is 500 lines, a ~10-fold reduction in cruft. Not bad!

Grafana on Miek Gieben

Graaf