Observability as Code

This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow Observability as Code
Enterprise Open source RSS

Observability as Code

Using Observability as Code, you can version, automate, and scale Grafana configurations, including dashboards and observability workflows.

Overview

Observability as Code lets you apply code management best practices to your observability resources. By representing Grafana resources as code, you can integrate them into existing infrastructure-as-code workflows and apply standard development practices.

Observability as Code provides more control over configuration. Instead of manually configuring dashboards or settings through the Grafana UI, you can:

  • Write configurations in code: Define dashboards in JSON or other supported formats.
  • Sync your Grafana setup to GitHub: Track changes, collaborate, and roll back updates using Git and GitHub, or other remote sources.
  • Automate with CI/CD: Integrate Grafana directly into your development and deployment pipelines.
  • Standardize workflows: Ensure consistency across your teams by using repeatable, codified processes for managing Grafana resources.

Explore

Get started
Learn about how you can use Observability as Code.
Grafana CLI
Grafana CLI (grafanactl) is a command-line tool designed to simplify interaction with Grafana instances. You can authenticate, manage multiple environments, and perform administrative tasks through Grafana’s REST API, all from the terminal.
JSON schema v2
Grafana dashboards are represented as JSON objects that store metadata, panels, variables, and settings. Observability as Code works with all versions of the JSON model, and it’s fully compatible with version 2.
Foundation SDK
The Grafana Foundation SDK is a set of tools, types, and libraries that let you define Grafana dashboards and resources using strongly typed code.
Git Sync (experimental)
Git Sync is an experimental feature that lets you store your dashboard files in a GitHub repository and synchronize those changes with your Grafana instance.
File provisioning (experimental)
File provisioning in Grafana lets you include resources, including folders and dashboard JSON files, that are stored in a local file system.