2c3823432d
We are relying on the "slug" field being the same as our "url friendly" title that we create. For whatever reason the slug field was deprecated in Grafana v5.0, and now with v8.3.4 it has stopped working. We can turn the name/slug into a UID by hashing, and then use this in the various API calls. Change-Id: I13d3162c917e094684756e51836d12000621fefa
112 lines
3.3 KiB
Python
112 lines
3.3 KiB
Python
# Copyright 2015 Red Hat, Inc.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import hashlib
|
|
import json
|
|
|
|
from requests import exceptions
|
|
|
|
from grafana_dashboards.grafana import utils
|
|
|
|
|
|
class Dashboard(object):
|
|
|
|
def __init__(self, url, session):
|
|
self.db_url = utils.urljoin(url, 'api/dashboards/db/')
|
|
self.uid_url = utils.urljoin(url, 'api/dashboards/uid/')
|
|
self.session = session
|
|
|
|
def dashboard_uid(self, name):
|
|
return hashlib.sha256(name.encode('utf-8')).hexdigest()[0:10]
|
|
|
|
def create(self, name, data, overwrite=False, folder_id=0):
|
|
"""Create a new dashboard
|
|
|
|
:param name: URL friendly title of the dashboard
|
|
:type name: str
|
|
:param data: Dashboard model
|
|
:type data: dict
|
|
:param overwrite: Overwrite existing dashboard with newer version or
|
|
with the same dashboard title
|
|
:type overwrite: bool
|
|
:param folder_id: The id of the folder to save the dashboard in.
|
|
:type folder_id: int
|
|
|
|
:raises Exception: if dashboard already exists
|
|
|
|
"""
|
|
uid = self.dashboard_uid(name)
|
|
data['uid'] = uid
|
|
dashboard = {
|
|
'dashboard': data,
|
|
'folderId': folder_id,
|
|
'overwrite': overwrite,
|
|
}
|
|
if not overwrite and self.is_dashboard(name):
|
|
raise Exception('dashboard[%s] already exists' % name)
|
|
|
|
res = self.session.post(
|
|
self.db_url, data=json.dumps(dashboard))
|
|
res.raise_for_status()
|
|
if not self.is_dashboard(name):
|
|
raise Exception('dashboard[%s] does not exist' % name)
|
|
|
|
def delete(self, name):
|
|
"""Delete a dashboard
|
|
|
|
:param name: URL friendly title of the dashboard
|
|
:type name: str
|
|
|
|
:raises Exception: if dashboard failed to delete
|
|
|
|
"""
|
|
uid = self.dashboard_uid(name)
|
|
url = utils.urljoin(self.uid_url, uid)
|
|
self.session.delete(url)
|
|
if self.is_dashboard(name):
|
|
raise Exception(
|
|
'dashboard %s (uid: %s) failed to delete' % (name, uid))
|
|
|
|
def get(self, name):
|
|
"""Get a dashboard
|
|
|
|
:param name: URL friendly title of the dashboard
|
|
:type name: str
|
|
|
|
:rtype: dict or None
|
|
|
|
"""
|
|
url = utils.urljoin(self.uid_url, self.dashboard_uid(name))
|
|
try:
|
|
res = self.session.get(url)
|
|
res.raise_for_status()
|
|
except exceptions.HTTPError:
|
|
return None
|
|
|
|
json = res.json()
|
|
return json if json else None
|
|
|
|
def is_dashboard(self, name):
|
|
"""Check if a dashboard exists
|
|
|
|
:param name: URL friendly title of the dashboard
|
|
:type name: str
|
|
|
|
:returns: True if dashboard exists
|
|
:rtype: bool
|
|
|
|
"""
|
|
res = self.get(name)
|
|
return True if res else False
|