Skip to content
This repository has been archived by the owner on Jun 5, 2024. It is now read-only.

Latest commit

 

History

History
42 lines (35 loc) · 2.31 KB

README.md

File metadata and controls

42 lines (35 loc) · 2.31 KB
Raw

grok

Caution

This repository has been archived, this project has been superseeded by the grafana-foundation-sdk. It contains the JSON schemas as well as builders for Go, Python and Typescript.

Grok (Grafana Object development Kit) is a CLI tool and Go library for working with Grafana objects from code, primarily dashboards.

Maturity

The code in this repository should be considered experimental. Documentation is only available alongside the code. It comes with no support, but we are keen to receive feedback on the product and suggestions on how to improve it, though we cannot commit to resolution of any particular issue. No SLAs are available. It is not meant to be used in production environments, and the risks are unknown/high.

Grafana Labs defines experimental features as follows:

Projects and features in the Experimental stage are supported only by the Engineering teams; on-call support is not available. Documentation is either limited or not provided outside of code comments. No SLA is provided.

Experimental projects or features are primarily intended for open source engineers who want to participate in ensuring systems stability, and to gain consensus and approval for open source governance projects.

Projects and features in the Experimental phase are not meant to be used in production environments, and the risks are unknown/high.

Goals

Key goals include:

  • Provide a structured, stable interface to canonical Grafana kind schemas in a preferred language (Go, CUE, Jsonnet)
    • Go
    • CUE
    • Jsonnet
  • Creating a dashboard/object in code, from scratch.
  • Ingesting a UI-created dashboard/object, transforming it, and emitting the result.
  • Composing a dashboard JSON object from a set of convenient, predefined parts (e.g. queries, panels, template variables) expressed in text form (JSON, YAML)
    • Decomposing a dashboard JSON object into the above parts
  • Extracting a "partial" from a dashboard/object into a portable, reusable text format (CUE)
  • Incorporating a partial fragment into another dashboard/object, either as:
    • Defaults (values in partial fragments may be overwritten)
    • Policy/Constraints (values in partial fragments are enforced)