ineersa / grafana-backup-tool

Python codes to dump or create dashboards and datasources from Grafana using it's API

Grafana Dashboard Backup Tool

Some python programs to call Grafana API to:

• Save every datasource to each datasource file.
  • saveDatasources.py
• Save every dashboard to each dashboard file.
  • saveDashboards.py
• Create datasource from a backup file.
  • createDatasource.py
• Create dashboard from a backup file.
  • createDashboard.py

There a three convenient script files:

1. backup_grafana.sh
2. restore_dashboards.sh
3. restore_datasources.sh

you can use them to

1. backup all datasources and dashboards. 2. ex: sh backup_grafana.sh
2. restore dashboards from your dashboard backup folder. 3. ex: sh restore_dashboards.sh /tmp/dashboards/2016-10-10_12:00:00
3. restore datasources from your datasource backup folder. 4. ex: sh restore_dashboards.sh /tmp/datasources/2016-10-10_12:00:00

Grafana API document

ENV:

• python 2.7
  • Need to pip install requests library
• Garafana 3.0 API

Setting

1. Export the environment variables bellow 2. GRAFANA_URL (the default url is http://localhost:3000) 3. GRAFANA_TOKEN

Remember, you can the token from Grafana Web page

How to Use

• First edit grafana_settings.py as above.

• Use saveDashboards.py to save each dashboard to each file.

  • ex: python saveDashboards.py folder_path

• Use saveDatasources.py to save each datasources to each file under specific folder.

  • ex: python saveDatasources.py folder_path

• Use createDashboard.py to read the dashboard file and create or update them on Grafana.

  • ex: python createDashboard.py file_path

• Use createDatasource.py to read the datasource file and create or update them on Grafana.

  • ex: python createDatasource.py file_path

• Use backup_grafana.sh to backup all your dashboards and datasources to /tmp folder.

  • It will create
    • two files: /tmp/dashboards.tar.gz, /tmp/datasources.tar.gz
    • two folders contain dashboard files and datasource files: /tmp/dashboards/$current_time, /tmp/datasources/$current_time
  • ex：sh backup_grafana.sh
  • result：/tmp/dashboads.tar.gz, /tmp/datasourcess.tar.gz, /tmp/dashboards/2016-10-10_12:00:00, /tmp/datasources/2016-10-10_12:00:00