def _rows_differ(row, _row):
"""
Check if grafana dashboard row and _row differ
"""
row_copy = copy.deepcopy(row)
_row_copy = copy.deepcopy(_row)
# Strip id from all panels in both rows, since they are always generated.
for panel in row_copy["panels"]:
if "id" in panel:
del panel["id"]
for _panel in _row_copy["panels"]:
if "id" in _panel:
del _panel["id"]
diff = DictDiffer(row_copy, _row_copy)
return diff.changed() or diff.added() or diff.removed()
def _rows_differ(row, _row):
'''
Check if grafana dashboard row and _row differ
'''
row_copy = copy.deepcopy(row)
_row_copy = copy.deepcopy(_row)
# Strip id from all panels in both rows, since they are always generated.
for panel in row_copy['panels']:
if 'id' in panel:
del panel['id']
for _panel in _row_copy['panels']:
if 'id' in _panel:
del _panel['id']
diff = DictDiffer(row_copy, _row_copy)
return diff.changed() or diff.added() or diff.removed()
def present(name,
base_dashboards_from_pillar=None,
base_panels_from_pillar=None,
base_rows_from_pillar=None,
dashboard=None,
dashboard_format='yaml',
profile='grafana'):
'''
Ensure the grafana dashboard exists and is managed.
name
Name of the grafana dashboard.
base_dashboards_from_pillar
A pillar key that contains a list of dashboards to inherit from
base_panels_from_pillar
A pillar key that contains a list of panels to inherit from
base_rows_from_pillar
A pillar key that contains a list of rows to inherit from
dashboard
A dict that defines a dashboard that should be managed.
dashboard_format
You can use two formats for dashboards. You can use the JSON format
if you provide a complete dashboard in raw JSON or you can use the YAML
format (this is the default) and provide a description of the
dashboard in YAML.
profile
A pillar key or dict that contains grafana information
'''
ret = {'name': name, 'result': True, 'comment': '', 'changes': {}}
dashboard = dashboard or {}
if isinstance(profile, six.string_types):
profile = __salt__['config.option'](profile)
if dashboard_format == 'json':
# In this case, a raw JSON of the full dashboard is provided.
response = _update(dashboard, profile)
if response.get('status') == 'success':
ret['comment'] = 'Dashboard {0} created.'.format(name)
ret['changes']['new'] = 'Dashboard {0} created.'.format(name)
else:
ret['result'] = False
ret['comment'] = ("Failed to create dashboard {0}, "
"response={1}").format(name, response)
return ret
base_dashboards_from_pillar = base_dashboards_from_pillar or []
base_panels_from_pillar = base_panels_from_pillar or []
base_rows_from_pillar = base_rows_from_pillar or []
# Add pillar keys for default configuration
base_dashboards_from_pillar = ([_DEFAULT_DASHBOARD_PILLAR] +
base_dashboards_from_pillar)
base_panels_from_pillar = ([_DEFAULT_PANEL_PILLAR] +
base_panels_from_pillar)
base_rows_from_pillar = [_DEFAULT_ROW_PILLAR] + base_rows_from_pillar
# Build out all dashboard fields
new_dashboard = _inherited_dashboard(dashboard,
base_dashboards_from_pillar, ret)
new_dashboard['title'] = name
rows = new_dashboard.get('rows', [])
for i, row in enumerate(rows):
rows[i] = _inherited_row(row, base_rows_from_pillar, ret)
for row in rows:
panels = row.get('panels', [])
for i, panel in enumerate(panels):
panels[i] = _inherited_panel(panel, base_panels_from_pillar, ret)
_auto_adjust_panel_spans(new_dashboard)
_ensure_panel_ids(new_dashboard)
_ensure_annotations(new_dashboard)
# Create dashboard if it does not exist
url = 'db/{0}'.format(name)
old_dashboard = _get(url, profile)
if not old_dashboard:
if __opts__['test']:
ret['result'] = None
ret['comment'] = 'Dashboard {0} is set to be created.'.format(name)
return ret
response = _update(new_dashboard, profile)
if response.get('status') == 'success':
ret['comment'] = 'Dashboard {0} created.'.format(name)
ret['changes']['new'] = 'Dashboard {0} created.'.format(name)
else:
ret['result'] = False
ret['comment'] = ("Failed to create dashboard {0}, "
"response={1}").format(name, response)
return ret
# Add unmanaged rows to the dashboard. They appear at the top if they are
# marked as pinned. They appear at the bottom otherwise.
managed_row_titles = [
row.get('title') for row in new_dashboard.get('rows', [])
]
new_rows = new_dashboard.get('rows', [])
for old_row in old_dashboard.get('rows', []):
if old_row.get('title') not in managed_row_titles:
new_rows.append(copy.deepcopy(old_row))
_ensure_pinned_rows(new_dashboard)
_ensure_panel_ids(new_dashboard)
# Update dashboard if it differs
dashboard_diff = DictDiffer(_cleaned(new_dashboard),
_cleaned(old_dashboard))
updated_needed = (dashboard_diff.changed() or dashboard_diff.added()
or dashboard_diff.removed())
if updated_needed:
if __opts__['test']:
ret['result'] = None
ret['comment'] = ('Dashboard {0} is set to be updated, '
'changes={1}').format(
name,
json.dumps(_dashboard_diff(
_cleaned(new_dashboard),
_cleaned(old_dashboard)),
indent=4))
return ret
response = _update(new_dashboard, profile)
if response.get('status') == 'success':
updated_dashboard = _get(url, profile)
dashboard_diff = DictDiffer(_cleaned(updated_dashboard),
_cleaned(old_dashboard))
ret['comment'] = 'Dashboard {0} updated.'.format(name)
ret['changes'] = _dashboard_diff(_cleaned(new_dashboard),
_cleaned(old_dashboard))
else:
ret['result'] = False
ret['comment'] = ("Failed to update dashboard {0}, "
"response={1}").format(name, response)
return ret
ret['comment'] = 'Dashboard present'
return ret
def _dashboard_diff(_new_dashboard, _old_dashboard):
'''Return a dictionary of changes between dashboards.'''
diff = {}
# Dashboard diff
new_dashboard = copy.deepcopy(_new_dashboard)
old_dashboard = copy.deepcopy(_old_dashboard)
dashboard_diff = DictDiffer(new_dashboard, old_dashboard)
diff['dashboard'] = _stripped({
'changed':
list(dashboard_diff.changed()) or None,
'added':
list(dashboard_diff.added()) or None,
'removed':
list(dashboard_diff.removed()) or None,
})
# Row diff
new_rows = new_dashboard.get('rows', [])
old_rows = old_dashboard.get('rows', [])
new_rows_by_title = {}
old_rows_by_title = {}
for row in new_rows:
if 'title' in row:
new_rows_by_title[row['title']] = row
for row in old_rows:
if 'title' in row:
old_rows_by_title[row['title']] = row
rows_diff = DictDiffer(new_rows_by_title, old_rows_by_title)
diff['rows'] = _stripped({
'added': list(rows_diff.added()) or None,
'removed': list(rows_diff.removed()) or None,
})
for changed_row_title in rows_diff.changed():
old_row = old_rows_by_title[changed_row_title]
new_row = new_rows_by_title[changed_row_title]
row_diff = DictDiffer(new_row, old_row)
diff['rows'].setdefault('changed', {})
diff['rows']['changed'][changed_row_title] = _stripped({
'changed':
list(row_diff.changed()) or None,
'added':
list(row_diff.added()) or None,
'removed':
list(row_diff.removed()) or None,
})
# Panel diff
old_panels_by_id = {}
new_panels_by_id = {}
for row in old_dashboard.get('rows', []):
for panel in row.get('panels', []):
if 'id' in panel:
old_panels_by_id[panel['id']] = panel
for row in new_dashboard.get('rows', []):
for panel in row.get('panels', []):
if 'id' in panel:
new_panels_by_id[panel['id']] = panel
panels_diff = DictDiffer(new_panels_by_id, old_panels_by_id)
diff['panels'] = _stripped({
'added': list(panels_diff.added()) or None,
'removed': list(panels_diff.removed()) or None,
})
for changed_panel_id in panels_diff.changed():
old_panel = old_panels_by_id[changed_panel_id]
new_panel = new_panels_by_id[changed_panel_id]
panels_diff = DictDiffer(new_panel, old_panel)
diff['panels'].setdefault('changed', {})
diff['panels']['changed'][changed_panel_id] = _stripped({
'changed':
list(panels_diff.changed()) or None,
'added':
list(panels_diff.added()) or None,
'removed':
list(panels_diff.removed()) or None,
})
return diff
def present(name,
base_dashboards_from_pillar=None,
base_panels_from_pillar=None,
base_rows_from_pillar=None,
dashboard=None,
orgname=None,
profile='grafana'):
'''
Ensure the grafana dashboard exists and is managed.
name
Name of the grafana dashboard.
base_dashboards_from_pillar
A pillar key that contains a list of dashboards to inherit from
base_panels_from_pillar
A pillar key that contains a list of panels to inherit from
base_rows_from_pillar
A pillar key that contains a list of rows to inherit from
dashboard
A dict that defines a dashboard that should be managed.
orgname
Name of the organization in which the dashboard should be present.
profile
Configuration profile used to connect to the Grafana instance.
Default is 'grafana'.
'''
ret = {'name': name, 'result': True, 'comment': '', 'changes': {}}
dashboard = dashboard or {}
if isinstance(profile, six.string_types):
profile = __salt__['config.option'](profile)
# Add pillar keys for default configuration
base_dashboards_from_pillar = [_DEFAULT_DASHBOARD_PILLAR
] + (base_dashboards_from_pillar or [])
base_panels_from_pillar = [_DEFAULT_PANEL_PILLAR
] + (base_panels_from_pillar or [])
base_rows_from_pillar = [_DEFAULT_ROW_PILLAR] + (base_rows_from_pillar
or [])
# Build out all dashboard fields
new_dashboard = _inherited_dashboard(dashboard,
base_dashboards_from_pillar, ret)
if 'title' not in new_dashboard:
new_dashboard['title'] = name
rows = new_dashboard.get('rows', [])
for i, row in enumerate(rows):
rows[i] = _inherited_row(row, base_rows_from_pillar, ret)
for row in rows:
panels = row.get('panels', [])
for i, panel in enumerate(panels):
panels[i] = _inherited_panel(panel, base_panels_from_pillar, ret)
_auto_adjust_panel_spans(new_dashboard)
_ensure_panel_ids(new_dashboard)
_ensure_annotations(new_dashboard)
# Create dashboard if it does not exist
old_dashboard = __salt__['grafana4.get_dashboard'](name, orgname, profile)
if not old_dashboard:
if __opts__['test']:
ret['result'] = None
ret['comment'] = 'Dashboard {0} is set to be created.'.format(name)
return ret
response = __salt__['grafana4.create_update_dashboard'](
dashboard=new_dashboard, overwrite=True, profile=profile)
if response.get('status') == 'success':
ret['comment'] = 'Dashboard {0} created.'.format(name)
ret['changes']['new'] = 'Dashboard {0} created.'.format(name)
else:
ret['result'] = False
ret['comment'] = ("Failed to create dashboard {0}, "
"response={1}").format(name, response)
return ret
# Add unmanaged rows to the dashboard. They appear at the top if they are
# marked as pinned. They appear at the bottom otherwise.
managed_row_titles = [
row.get('title') for row in new_dashboard.get('rows', [])
]
new_rows = new_dashboard.get('rows', [])
for old_row in old_dashboard.get('rows', []):
if old_row.get('title') not in managed_row_titles:
new_rows.append(copy.deepcopy(old_row))
_ensure_pinned_rows(new_dashboard)
_ensure_panel_ids(new_dashboard)
# Update dashboard if it differs
dashboard_diff = DictDiffer(_cleaned(new_dashboard),
_cleaned(old_dashboard))
updated_needed = (dashboard_diff.changed() or dashboard_diff.added()
or dashboard_diff.removed())
if updated_needed:
if __opts__['test']:
ret['result'] = None
ret['comment'] = (
str('Dashboard {0} is set to be updated, changes={1}').
format( # future lint: blacklisted-function
name,
salt.utils.json.dumps(_dashboard_diff(
_cleaned(new_dashboard), _cleaned(old_dashboard)),
indent=4)))
return ret
response = __salt__['grafana4.create_update_dashboard'](
dashboard=new_dashboard, overwrite=True, profile=profile)
if response.get('status') == 'success':
updated_dashboard = __salt__['grafana4.get_dashboard'](name,
orgname,
profile)
dashboard_diff = DictDiffer(_cleaned(updated_dashboard),
_cleaned(old_dashboard))
ret['comment'] = 'Dashboard {0} updated.'.format(name)
ret['changes'] = _dashboard_diff(_cleaned(new_dashboard),
_cleaned(old_dashboard))
else:
ret['result'] = False
ret['comment'] = ("Failed to update dashboard {0}, "
"response={1}").format(name, response)
return ret
ret['comment'] = 'Dashboard present'
return ret
def _dashboard_diff(_new_dashboard, _old_dashboard):
"""Return a dictionary of changes between dashboards."""
diff = {}
# Dashboard diff
new_dashboard = copy.deepcopy(_new_dashboard)
old_dashboard = copy.deepcopy(_old_dashboard)
dashboard_diff = DictDiffer(new_dashboard, old_dashboard)
diff["dashboard"] = _stripped({
"changed":
list(dashboard_diff.changed()) or None,
"added":
list(dashboard_diff.added()) or None,
"removed":
list(dashboard_diff.removed()) or None,
})
# Row diff
new_rows = new_dashboard.get("rows", [])
old_rows = old_dashboard.get("rows", [])
new_rows_by_title = {}
old_rows_by_title = {}
for row in new_rows:
if "title" in row:
new_rows_by_title[row["title"]] = row
for row in old_rows:
if "title" in row:
old_rows_by_title[row["title"]] = row
rows_diff = DictDiffer(new_rows_by_title, old_rows_by_title)
diff["rows"] = _stripped({
"added": list(rows_diff.added()) or None,
"removed": list(rows_diff.removed()) or None,
})
for changed_row_title in rows_diff.changed():
old_row = old_rows_by_title[changed_row_title]
new_row = new_rows_by_title[changed_row_title]
row_diff = DictDiffer(new_row, old_row)
diff["rows"].setdefault("changed", {})
diff["rows"]["changed"][changed_row_title] = _stripped({
"changed":
list(row_diff.changed()) or None,
"added":
list(row_diff.added()) or None,
"removed":
list(row_diff.removed()) or None,
})
# Panel diff
old_panels_by_id = {}
new_panels_by_id = {}
for row in old_dashboard.get("rows", []):
for panel in row.get("panels", []):
if "id" in panel:
old_panels_by_id[panel["id"]] = panel
for row in new_dashboard.get("rows", []):
for panel in row.get("panels", []):
if "id" in panel:
new_panels_by_id[panel["id"]] = panel
panels_diff = DictDiffer(new_panels_by_id, old_panels_by_id)
diff["panels"] = _stripped({
"added": list(panels_diff.added()) or None,
"removed": list(panels_diff.removed()) or None,
})
for changed_panel_id in panels_diff.changed():
old_panel = old_panels_by_id[changed_panel_id]
new_panel = new_panels_by_id[changed_panel_id]
panels_diff = DictDiffer(new_panel, old_panel)
diff["panels"].setdefault("changed", {})
diff["panels"]["changed"][changed_panel_id] = _stripped({
"changed":
list(panels_diff.changed()) or None,
"added":
list(panels_diff.added()) or None,
"removed":
list(panels_diff.removed()) or None,
})
return diff
def present(
name,
base_dashboards_from_pillar=None,
base_panels_from_pillar=None,
base_rows_from_pillar=None,
dashboard=None,
profile="grafana",
):
"""
Ensure the grafana dashboard exists and is managed.
name
Name of the grafana dashboard.
base_dashboards_from_pillar
A pillar key that contains a list of dashboards to inherit from
base_panels_from_pillar
A pillar key that contains a list of panels to inherit from
base_rows_from_pillar
A pillar key that contains a list of rows to inherit from
dashboard
A dict that defines a dashboard that should be managed.
profile
A pillar key or dict that contains grafana information
"""
ret = {"name": name, "result": True, "comment": "", "changes": {}}
base_dashboards_from_pillar = base_dashboards_from_pillar or []
base_panels_from_pillar = base_panels_from_pillar or []
base_rows_from_pillar = base_rows_from_pillar or []
dashboard = dashboard or {}
if isinstance(profile, str):
profile = __salt__["config.option"](profile)
# Add pillar keys for default configuration
base_dashboards_from_pillar = [_DEFAULT_DASHBOARD_PILLAR
] + base_dashboards_from_pillar
base_panels_from_pillar = [_DEFAULT_PANEL_PILLAR] + base_panels_from_pillar
base_rows_from_pillar = [_DEFAULT_ROW_PILLAR] + base_rows_from_pillar
# Build out all dashboard fields
new_dashboard = _inherited_dashboard(dashboard,
base_dashboards_from_pillar, ret)
new_dashboard["title"] = name
rows = new_dashboard.get("rows", [])
for i, row in enumerate(rows):
rows[i] = _inherited_row(row, base_rows_from_pillar, ret)
for row in rows:
panels = row.get("panels", [])
for i, panel in enumerate(panels):
panels[i] = _inherited_panel(panel, base_panels_from_pillar, ret)
_auto_adjust_panel_spans(new_dashboard)
_ensure_panel_ids(new_dashboard)
_ensure_annotations(new_dashboard)
# Create dashboard if it does not exist
url = "db/{}".format(name)
old_dashboard = _get(url, profile)
if not old_dashboard:
if __opts__["test"]:
ret["result"] = None
ret["comment"] = "Dashboard {} is set to be created.".format(name)
return ret
response = _update(new_dashboard, profile)
if response.get("status") == "success":
ret["comment"] = "Dashboard {} created.".format(name)
ret["changes"]["new"] = "Dashboard {} created.".format(name)
else:
ret["result"] = False
ret["comment"] = "Failed to create dashboard {}, response={}".format(
name, response)
return ret
# Add unmanaged rows to the dashboard. They appear at the top if they are
# marked as pinned. They appear at the bottom otherwise.
managed_row_titles = [
row.get("title") for row in new_dashboard.get("rows", [])
]
new_rows = new_dashboard.get("rows", [])
for old_row in old_dashboard.get("rows", []):
if old_row.get("title") not in managed_row_titles:
new_rows.append(copy.deepcopy(old_row))
_ensure_pinned_rows(new_dashboard)
_ensure_panel_ids(new_dashboard)
# Update dashboard if it differs
dashboard_diff = DictDiffer(_cleaned(new_dashboard),
_cleaned(old_dashboard))
updated_needed = (dashboard_diff.changed() or dashboard_diff.added()
or dashboard_diff.removed())
if updated_needed:
if __opts__["test"]:
ret["result"] = None
ret["comment"] = "Dashboard {} is set to be updated, changes={}".format(
name,
salt.utils.json.dumps(
_dashboard_diff(_cleaned(new_dashboard),
_cleaned(old_dashboard)),
indent=4,
),
)
return ret
response = _update(new_dashboard, profile)
if response.get("status") == "success":
updated_dashboard = _get(url, profile)
dashboard_diff = DictDiffer(_cleaned(updated_dashboard),
_cleaned(old_dashboard))
ret["comment"] = "Dashboard {} updated.".format(name)
ret["changes"] = _dashboard_diff(_cleaned(new_dashboard),
_cleaned(old_dashboard))
else:
ret["result"] = False
ret["comment"] = "Failed to update dashboard {}, response={}".format(
name, response)
return ret
ret["comment"] = "Dashboard present"
return ret