https://github.com/grafana/grafonnet

Jsonnet library for generating Grafana dashboards.
https://github.com/grafana/grafonnet

grafana jsonnet jsonnet-lib

Last synced: about 2 months ago
JSON representation

Jsonnet library for generating Grafana dashboards.

• Host: GitHub
• URL: https://github.com/grafana/grafonnet
• Owner: grafana
• License: apache-2.0
• Created: 2023-02-08T09:07:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-29T09:00:42.000Z (about 2 months ago)
• Last Synced: 2024-07-29T12:12:44.730Z (about 2 months ago)
• Topics: grafana, jsonnet, jsonnet-lib
• Language: Jsonnet
• Homepage: https://grafana.github.io/grafonnet/
• Size: 27.3 MB
• Stars: 330
• Watchers: 116
• Forks: 18
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# Grafonnet

Jsonnet library for generating Grafana dashboards.

## Introduction

This library is generated from OpenAPI documents in [grafana-foundation-sdk](https://github.com/grafana/grafana-foundation-sdk),

these are generated from the Grafana repository to ensure Grafonnet can

keep up with Grafana development.

Grafonnet is the spiritual successor of [grafonnet-lib](https://github.com/grafana/grafonnet-lib).

As grafonnet-lib was manually written, it had a hard time to keep up with Grafana

development, this resulted in it being under-maintained. Besides that, it also came with

a performance penalty in jsonnet as it used the builder pattern, although visually

appealing it becomes very slow for environments that need to manage many dashboards.

> **This library is experimental**

>

> The code in this repository should be considered experimental. Documentation is only

> available alongside the code. It comes without 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.

>

> Additional information can be found in [Release life cycle for Grafana Labs](https://grafana.com/docs/release-life-cycle/).

## Requirements

Grafonnet uses the [Jsonnet](https://jsonnet.org/) programming language.

> **NOTE**: There is a significant performance issue with the C implementation of Jsonnet. You are strongly

recommended to use the newer [go-jsonnet](https://github.com/google/go-jsonnet) Jsonnet implementation.

This is also the implementation recommended by the Jsonnet developers themselves.

The library can be installed with [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler/).

## Install

To add grafonnet to a jsonnet project:

```console

jb install github.com/grafana/grafonnet/gen/grafonnet-latest@main

```

## Usage

```jsonnet

// dashboard.jsonnet

local grafonnet = import 'github.com/grafana/grafonnet/gen/grafonnet-latest/main.libsonnet';

grafonnet.dashboard.new('My Dashboard')

```

```console

jsonnet -J vendor dashboard.jsonnet

```