Skip to content

Helpers to manage dashboards and interactions with Grafana Cloud

License

Notifications You must be signed in to change notification settings

adevinta/go-grafana-toolkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grafana Modules

A collection of Go modules for working with Grafana Cloud, focusing on dashboard management and Grafana API interactions.

Modules

Publisher

The Dashboard Publisher module provides programmatic control for deploying Grafana dashboards across multiple Grafana Cloud stacks.

It supports:

  • Publishing common dashboards to multiple stacks
  • Managing stack-specific dashboards
  • Test deployments to a designated stack
  • Dashboard deletion tracking
  • Automatic datasource variable handling

Learn more about the Publisher

Client

A Go module that provides a convenient wrapper around:

  • Grafana Cloud API (using grafana-com-public-clients/go/gcom)
  • Grafana HTTP API (using grafana-openapi-client-go)

Learn more about the Client

Usage

  1. Import the modules in your Go code:

    import (
        "github.com/adevinta/go-grafana-toolkit/publisher"
        "github.com/adevinta/go-grafana-toolkit/client"
    )
  2. Set up your Grafana Cloud API token in the GRAFANA_CLOUD_TOKEN env varible.

  3. Configure your dashboard publishing strategy using publisher-config.yaml

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

Helpers to manage dashboards and interactions with Grafana Cloud

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages