mpostument / Grafana Sync
Labels
Projects that are alternatives of or similar to Grafana Sync
grafana-sync
Keep your grafana dashboards in sync.
Table of Contents
- grafana-sync
Installing
Download the latest binary from releases
Getting Started
Pull
Save all dashboards to directory
grafana-sync pull-dashboards --directory="dashboards
Example:
grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000
Save dashboards with specific tags to directory
grafana-sync pull-dashboards --tag=export
Example:
grafana-sync pull-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000 --tag=export
Save folders configuration to directory
grafana-sync pull-folders
Example:
grafana-sync pull-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000
Save notifications configuration to directory
grafana-sync pull-notifications
Example:
grafana-sync pull-notifications --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="notifications" --url http://127.0.0.1:3000
Save datasources configuration to directory
grafana-sync pull-datasources
Example:
grafana-sync pull-datasources --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="datasources" --url http://127.0.0.1:3000
Push
Push dashboards to grafana
grafana-sync push-dashboards
Example:
grafana-sync push-dashboards --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="dashboards" --url http://127.0.0.1:3000
Push folders to grafana
grafana-sync push-folders
Example:
grafana-sync push-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000
Push folders to grafana in custom folder
Find grafana folder Id by opening /api/folders in browser.
Example:
http://127.0.0.1:3000/api/folders
Find required folderId in output
[{"id":1,"uid":"RcuWg5UMz","title":"TestFolder"}]
Specify folder id in push command
grafana-sync push-folders --folderId=<FolderId>
Example:
grafana-sync push-folders --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="folders" --url http://127.0.0.1:3000 --folderId=1
Push notifications to grafana
grafana-sync push-notifications
Example:
grafana-sync push-notifications --apikey="eyJrIjoiOWJYTktGNFlCbFVMOG1LY3d6ekN4Mmw4MFgyYU44a1UiLCJuIjoiY29icmEiLCJpZCI6MX0=" --directory="notifications" --url http://127.0.0.1:3000
Push datasources to grafana
grafana-sync push-datasources
Example:
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: <ApiKey>
url - Grafana Url with port. Default http://localhost:3000
Contributing
- Fork it
- Download your fork to your PC (
git clone https://github.com/your_username/grafana-sync && cd grafana-sync) - Create your feature branch (
git checkout -b my-new-feature) - Make changes and add them (
git add .) - Commit your changes (
git commit -m 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new pull request
License
grafana-sync is released under the Apache 2.0 license. See LICENSE.txt