Examples

A collection of sample Grafana dashboards written in TypeScript is available in the grafana/grafana-foundation-sdk repository.

Each example showcases different aspects of building dashboards as code:

• custom-panel: definition and usage of a custom Panel type
• custom-query: definition and usage of a custom Query type
• grafana-agent-overview:
  • reproduction of the "Grafana Agent Overview" dashboard from the Grafana Agent integration available in Grafana Cloud.
  • dashboard variables
  • table panels
  • timeseries panels
  • prometheus queries
• linux-node-overview:
  • reproduction of the "Grafana Agent Overview" dashboard from the Linux Server integration available in Grafana Cloud.
  • dashboard variables
  • dashboard links
  • stat panels
  • table panels
  • timeseries panels
  • prometheus queries
• red-method:
  • example of a dashboard following the RED method