Merge lp:~jacekn/charms/trusty/grafana/layer-grafana into lp:~canonical-is-sa/charms/trusty/grafana/layer-grafana

[Jacek Nykis]

Added dashboards backup support

=== modified file 'config.yaml'
--- config.yaml	2016-05-06 20:42:51 +0000
+++ config.yaml	2016-07-14 15:09:02 +0000
@@ -78,4 +78,16 @@
     default: ""
     type: string
     description: |
-      Grafana admin password. Default, pwgen(16) random password
+      Grafana admin password. Default, pwgen(16) random password.
+      See also README.md for instructions how to retrieve automatically
+      generated password
+  dashboards_backup_schedule:
+    default: ""
+    type: string
+    description: |
+      Cron schedule for dashboards backups
+  dashboards_backup_dir:
+    default: "/srv/backups"
+    type: string
+    description: |
+      Location where to put dashboard dumps

=== added directory 'files'
=== added file 'files/dashboards_backup'
--- files/dashboards_backup	1970-01-01 00:00:00 +0000
+++ files/dashboards_backup	2016-07-14 15:09:02 +0000
@@ -0,0 +1,41 @@
+#!/usr/bin/env python
+
+import os
+import argparse
+import requests
+import string
+import datetime
+
+
+def get_backup_filename(directory, org_name, uri):
+    valid_chars = '-_(){}{}'.format(string.ascii_letters, string.digits)
+    dashboard = uri.split('/')[1]
+    filename = ''.join(c if c in valid_chars else '_' for c in dashboard)
+    filename += '.json.' + datetime.datetime.utcnow().strftime('%Y%m%d_%H%M%S')
+    org_name = ''.join(c if c in valid_chars else '_' for c in org_name)
+    return os.path.join(directory, org_name, filename)
+
+
+def main(args):
+    base_url = 'http://localhost:3000/api/'
+    for key in args.api_keys:
+        headers = {'Authorization': 'Bearer {}'.format(key)}
+        org_name = requests.get(base_url+'org', headers=headers).json()['name']
+        r = requests.get(base_url+'search', headers=headers).json()
+        uris = [i['uri'] for i in r]
+        for d in uris:
+            backup_file = get_backup_filename(args.directory, org_name, d)
+            if not os.path.isdir(os.path.dirname(backup_file)):
+                os.mkdir(os.path.dirname(backup_file))
+            dashboard = requests.get(base_url+'dashboards/'+d, headers=headers).json()['dashboard']
+            with open(backup_file, 'w') as f:
+                f.write(str(dashboard))
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(description='Back up grafana dashboards to disk')
+    parser.add_argument('-d', '--directory', help='Directory where to store backups',
+                        default='/srv/backups')
+    parser.add_argument('api_keys', help='List of API keys to use for backups', nargs='+')
+    args = parser.parse_args()
+    main(args)

=== modified file 'reactive/grafana.py'
--- reactive/grafana.py	2016-05-09 16:26:12 +0000
+++ reactive/grafana.py	2016-07-14 15:09:02 +0000
@@ -4,7 +4,9 @@
 import hashlib
 import datetime
 import requests
+import json
 import subprocess
+import base64
 from time import sleep
 from charmhelpers import fetch
 from charmhelpers.core import host, hookenv, unitdata
@@ -33,6 +35,8 @@
 GRAFANA_INI = '/etc/grafana/grafana.ini'
 GRAFANA_INI_TMPL = 'grafana.ini.j2'
 GRAFANA_DEPS = ['libfontconfig1']
+DASHBOARDS_BACKUP_CRON = '/etc/cron.d/juju-dashboards-backup'
+DASHBOARDS_BACKUP_CRON_TMPL = 'juju-dashboards-backup.j2'
 
 
 def install_packages():
@@ -64,6 +68,57 @@
         kv.set('grafana.port', new_port)
 
 
+def select_query(query, params=None):
+    conn = sqlite3.connect('/var/lib/grafana/grafana.db', timeout=30)
+    cur = conn.cursor()
+    if params:
+        return cur.execute(query, params).fetchall()
+    else:
+        return cur.execute(query).fetchall()
+
+
+def insert_query(query, params=None):
+    conn = sqlite3.connect('/var/lib/grafana/grafana.db', timeout=30)
+    cur = conn.cursor()
+    if params:
+        cur.execute(query, params)
+    else:
+        cur.execute(query)
+    conn.commit()
+
+
+def add_backup_api_keys():
+    name = 'juju-dashboards-backup'
+    passwd = host.pwgen(32)
+    hpasswd = hpwgen(passwd, name)
+    hookenv.log('Adding backup API keys for all organizations...')
+    for i in select_query('SELECT id FROM org'):
+        org_id = i[0]
+        if select_query('SELECT id FROM api_key WHERE org_id=? AND name=?', [org_id, name]):
+            hookenv.log('API key {} in org {} already exists, skipping'.format(name, org_id))
+            continue
+        j = {'n':  name,
+             'k':  passwd,
+             'id': org_id}
+        encoded = base64.b64encode(json.dumps(j).encode('ascii')).decode('ascii')
+        stmt = 'INSERT INTO api_key (org_id, name, key, role, created, updated)' + \
+               ' VALUES (?,?,?,"Viewer",?,?)'
+        dtime = datetime.datetime.today().strftime("%F %T")
+        params = [org_id, name, hpasswd, dtime, dtime]
+        insert_query(stmt, params)
+
+        kv = unitdata.kv()
+        backup_keys = kv.get('grafana.dashboards_backup_keys', False)
+        if not backup_keys:
+            backup_keys = [encoded]
+        else:
+            backup_keys.append(encoded)
+        kv.set('grafana.dashboards_backup_keys', backup_keys)
+
+    kv = unitdata.kv()
+    return kv.get('grafana.dashboards_backup_keys')
+
+
 @when_not('grafana.started')
 def setup_grafana():
     hookenv.status_set('maintenance', 'Configuring grafana')
@@ -76,6 +131,20 @@
            owner='root', group='grafana',
            perms=0o640,
            )
+    if config.get('dashboards_backup_schedule', False):
+        hookenv.log('Setting up dashboards backup job...')
+        host.rsync('files/dashboards_backup', '/usr/local/bin/dashboards_backup')
+        host.mkdir(config.get('dashboards_backup_dir'))
+        settings = {'schedule': config.get('dashboards_backup_schedule'),
+                    'directory': config.get('dashboards_backup_dir'),
+                    'backup_keys': ' '.join(add_backup_api_keys())}
+        render(source=DASHBOARDS_BACKUP_CRON_TMPL,
+               target=DASHBOARDS_BACKUP_CRON,
+               context=settings,
+               owner='root', group='root',
+               perms=0o640,
+               )
+        # copy script, create cronjob, ensure directory exists
     check_ports(config.get('port'))
     set_state('grafana.start')
     hookenv.status_set('active', 'Ready')

=== added file 'templates/juju-dashboards-backup.j2'
--- templates/juju-dashboards-backup.j2	1970-01-01 00:00:00 +0000
+++ templates/juju-dashboards-backup.j2	2016-07-14 15:09:02 +0000
@@ -0,0 +1,5 @@
+#
+# Please do not edit. Juju will overwrite it.
+#
+{{ schedule }} root /usr/local/bin/dashboards_backup -d {{ directory }} {{ backup_keys }}
+