Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mpostument/grafana-sync
Keep your Grafana dashboards in sync
https://github.com/mpostument/grafana-sync
cobra go golang grafana grafana-dashboard
Last synced: 3 days ago
JSON representation
Keep your Grafana dashboards in sync
- Host: GitHub
- URL: https://github.com/mpostument/grafana-sync
- Owner: mpostument
- License: apache-2.0
- Created: 2020-12-21T17:11:48.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-08T01:08:10.000Z (10 months ago)
- Last Synced: 2024-08-02T15:47:49.477Z (3 months ago)
- Topics: cobra, go, golang, grafana, grafana-dashboard
- Language: Go
- Homepage:
- Size: 430 KB
- Stars: 214
- Watchers: 3
- Forks: 22
- Open Issues: 15
-
Metadata Files:
- Readme: README.MD
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - mpostument/grafana-sync - Keep your Grafana dashboards in sync (Go)
README
# grafana-sync
Keep your grafana dashboards in sync.
## Table of Contents
- [grafana-sync](#grafana-sync)
- [Table of Contents](#table-of-contents)
- [Installing](#installing)
- [Getting Started](#getting-started)
- [Pull dashboards](#pull-dashboards)
- [Pull folder](#pull-folder)
- [Pull notifications](#pull-notifications)
- [Pull datasources](#pull-datasources)
- [Push dashboards](#push-dashboards)
- [Push folders](#push-folders)
- [Push notifications](#push-notifications)
- [Push datasources](#push-datasources)
- [Global parameters](#global-parameters)
- [Contributing](#contributing)
- [License](#license)
## Installing
Download the latest binary from [releases](https://github.com/mpostument/grafana-sync/releases)
Or use docker image from [github registry](https://github.com/mpostument/grafana-sync/pkgs/container/grafana-sync)
## Getting Started
### Pull dashboards
```shell
# Save all dashboards to directory
grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000
# Save all dashboards from specific folder to local directory using folder name
grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --folderName="TestFolder"
# Save all dashboards from specific folder to local directory using folder id
grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --folderId=1
# Save dashboards with specific tags to directory
grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --tag=export
```
### Pull folder
```shell
grafana-sync pull-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000
```
### Pull notifications
```shell
grafana-sync pull-notifications --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="notifications" --url http://127.0.0.1:3000
```
### Pull datasources
```shell
grafana-sync pull-datasources --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="datasources" --url http://127.0.0.1:3000
```
### Push dashboards
```shell
# Push all dashboards to general directory
grafana-sync push-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000
# Push dashboards to grafana in custom folder by folder name
grafana-sync push-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --folderName="TestFolder"
# Push folders to grafana in custom folder by folder id
grafana-sync push-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --folderId=1
```
### Push folders
```shell
grafana-sync push-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000
```
### Push notifications
```shell
grafana-sync push-notifications --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="notifications" --url http://127.0.0.1:3000
```
### Push datasources
```shell
grafana-sync push-datasources --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="datasources" --url http://127.0.0.1:3000
```
## Global parameters
`directory` - Directory where to save dashboards. Default `.`
`tag` - Dashboard tag to read. Supported only with `pull` option. Default `""`
`apikey` - Grafana api key, need to be editor or admin. Default `""`.
Api key can be stored in `$HOME/.grafana-sync.yaml` as `apikey: `
`url` - Grafana Url with port. Default `http://localhost:3000`
`customHeaders` - Key-value pairs of custom http headers (header1=value1,header2=value2)
## Contributing
1. Fork it
2. Download your fork to your PC ( `git clone https://github.com/your_username/grafana-sync && cd grafana-sync` )
3. Create your feature branch ( `git checkout -b my-new-feature` )
4. Make changes and add them ( `git add .` )
5. Commit your changes ( `git commit -m 'Add some feature'` )
6. Push to the branch ( `git push origin my-new-feature` )
7. Create new pull request
## License
grafana-sync is released under the Apache 2.0 license. See [LICENSE.txt](https://github.com/mpostument/grafana-sync/blob/master/LICENSE)