The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/observability-as-code/_index.md

5.3 KiB

description keywords labels title weight cards hero
Overview of Observability as Code including description, key features, and explanation of benefits. [observability configuration as code dashboards git integration git sync github] [{products [enterprise oss]}] Observability as Code 100 [{items {title Get started} {height 24} {href ./get-started/} {description Learn about how you can use Observability as Code.}] [{title Grafana CLI} {height 24} {href ./grafana-cli/} {description 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.}] [{title JSON schema v2} {height 24} {href ./schema-v2/} {description 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.}] [{title Foundation SDK} {height 24} {href ./foundation-sdk/} {description The Grafana Foundation SDK is a set of tools, types, and libraries that let you define Grafana dashboards and resources using strongly typed code.}] [{title Git Sync (experimental)} {height 24} {href ./provision-resources/intro-git-sync/} {description 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.}] [{title File provisioning (experimental)} {height 24} {href ./provision-resources/} {description File provisioning in Grafana lets you include resources, including folders and dashboard JSON files, that are stored in a local file system.}} {title_class pt-0 lh-1}] [{title Observability as Code} {description Using Observability as Code, you can version, automate, and scale Grafana configurations, including dashboards and observability workflows.} {height 110} {level 1} {width 110}]

{{< docs/hero-simple key="hero" >}}


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

{{< card-grid key="cards" type="simple" >}}