From: Patrick Seidensal <pseidensal@suse.com>
Date: Fri, 11 Jun 2021 09:48:00 +0000 (+0200)
Subject: mgr/dashboard: Remove hard-coded timezone off Grafana dashboards
X-Git-Tag: v17.1.0~1555^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=5527c1c54f4cdc8d0ba6c86b259baa555bbd9def;p=ceph.git

mgr/dashboard: Remove hard-coded timezone off Grafana dashboards

Remove hard-coded timezone off Grafana dashboards to enable the Grafana
administrator to decide which timezone should be used for dashboards.

If we hard-coded those values, changing the global settings in Grafana
wouldn't have an effect. And the administrators can't change the
automatically imported Grafana dashboards provided by us.

Fixes: https://tracker.ceph.com/issues/51212

Signed-off-by: Patrick Seidensal <pseidensal@suse.com>
---

diff --git a/monitoring/grafana/dashboards/ceph-cluster.json b/monitoring/grafana/dashboards/ceph-cluster.json
index 447dbb29322e..d6cc4cf03fdf 100644
--- a/monitoring/grafana/dashboards/ceph-cluster.json
+++ b/monitoring/grafana/dashboards/ceph-cluster.json
@@ -1245,7 +1245,7 @@
       "30d"
     ]
   },
-  "timezone": "browser",
+  "timezone": "",
   "title": "Ceph - Cluster",
   "version": 13
     }
diff --git a/monitoring/grafana/dashboards/host-details.json b/monitoring/grafana/dashboards/host-details.json
index 237349dd36a1..71ac36f3709a 100644
--- a/monitoring/grafana/dashboards/host-details.json
+++ b/monitoring/grafana/dashboards/host-details.json
@@ -1208,7 +1208,7 @@
       "30d"
     ]
   },
-  "timezone": "browser",
+  "timezone": "",
   "title": "Host Details",
   "uid": "rtOg0AiWz",
   "version": 4
diff --git a/monitoring/grafana/dashboards/pool-detail.json b/monitoring/grafana/dashboards/pool-detail.json
index 41554ed30683..dd6bc3927faf 100644
--- a/monitoring/grafana/dashboards/pool-detail.json
+++ b/monitoring/grafana/dashboards/pool-detail.json
@@ -658,7 +658,7 @@
       "30d"
     ]
   },
-  "timezone": "browser",
+  "timezone": "",
   "title": "Ceph Pool Details",
   "uid": "-xyV8KCiz",
   "version": 1
diff --git a/monitoring/grafana/dashboards/pool-overview.json b/monitoring/grafana/dashboards/pool-overview.json
index cd699348b07f..c405f6075e17 100644
--- a/monitoring/grafana/dashboards/pool-overview.json
+++ b/monitoring/grafana/dashboards/pool-overview.json
@@ -1554,7 +1554,7 @@
       "30d"
     ]
   },
-  "timezone": "browser",
+  "timezone": "",
   "title": "Ceph Pools Overview",
   "uid": "z99hzWtmk",
   "variables": {
diff --git a/src/pybind/mgr/dashboard/ci/check_grafana_dashboards.py b/src/pybind/mgr/dashboard/ci/check_grafana_dashboards.py
new file mode 100644
index 000000000000..47e553c84e58
--- /dev/null
+++ b/src/pybind/mgr/dashboard/ci/check_grafana_dashboards.py
@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=F0401
+"""
+This script does:
+* Scan through Angular html templates and extract <cd-grafana> tags
+* Check if every tag has a corresponding Grafana dashboard by `uid`
+
+Usage:
+    python <script> <angular_app_dir> <grafana_dashboard_dir>
+
+e.g.
+    cd /ceph/src/pybind/mgr/dashboard
+    python ci/<script> frontend/src/app /ceph/monitoring/grafana/dashboards
+"""
+import argparse
+import codecs
+import copy
+import json
+import os
+from html.parser import HTMLParser
+
+
+class TemplateParser(HTMLParser):
+
+    def __init__(self, _file, search_tag):
+        super().__init__()
+        self.search_tag = search_tag
+        self.file = _file
+        self.parsed_data = []
+
+    def parse(self):
+        with codecs.open(self.file, encoding='UTF-8') as f:
+            self.feed(f.read())
+
+    def handle_starttag(self, tag, attrs):
+        if tag != self.search_tag:
+            return
+        tag_data = {
+            'file': self.file,
+            'attrs': dict(attrs),
+            'line': self.getpos()[0]
+        }
+        self.parsed_data.append(tag_data)
+
+    def error(self, message):
+        error_msg = 'fail to parse file {} (@{}): {}'.\
+            format(self.file, self.getpos(), message)
+        exit(error_msg)
+
+
+def get_files(base_dir, file_ext):
+    result = []
+    for root, _, files in os.walk(base_dir):
+        for _file in files:
+            if _file.endswith('.{}'.format(file_ext)):
+                result.append(os.path.join(root, _file))
+    return result
+
+
+def get_tags(base_dir, tag='cd-grafana'):
+    templates = get_files(base_dir, 'html')
+    tags = []
+    for templ in templates:
+        parser = TemplateParser(templ, tag)
+        parser.parse()
+        if parser.parsed_data:
+            tags.extend(parser.parsed_data)
+    return tags
+
+
+def get_grafana_dashboards(base_dir):
+    json_files = get_files(base_dir, 'json')
+    dashboards = {}
+    for json_file in json_files:
+        try:
+            with open(json_file) as f:
+                dashboard_config = json.load(f)
+                uid = dashboard_config.get('uid')
+                assert dashboard_config['id'] is None, \
+                    "'id' not null: '{}'".format(dashboard_config['id'])
+
+                assert 'timezone' not in dashboard_config or dashboard_config['timezone'] == '', \
+                    ("'timezone' field must not be set to anything but an empty string or be "
+                     "omitted completely")
+
+                # Grafana dashboard checks
+                title = dashboard_config['title']
+                assert len(title) > 0, \
+                    "Title not found in '{}'".format(json_file)
+                assert len(dashboard_config.get('links', [])) == 0, \
+                    "Links found in '{}'".format(json_file)
+                if not uid:
+                    continue
+                if uid in dashboards:
+                    # duplicated uids
+                    error_msg = 'Duplicated UID {} found, already defined in {}'.\
+                        format(uid, dashboards[uid]['file'])
+                    exit(error_msg)
+
+                dashboards[uid] = {
+                    'file': json_file,
+                    'title': title
+                }
+        except Exception as e:
+            print(f"Error in file {json_file}")
+            raise e
+    return dashboards
+
+
+def parse_args():
+    long_desc = ('Check every <cd-grafana> component in Angular template has a'
+                 ' mapped Grafana dashboard.')
+    parser = argparse.ArgumentParser(description=long_desc)
+    parser.add_argument('angular_app_dir', type=str,
+                        help='Angular app base directory')
+    parser.add_argument('grafana_dash_dir', type=str,
+                        help='Directory contains Grafana dashboard JSON files')
+    parser.add_argument('--verbose', action='store_true',
+                        help='Display verbose mapping information.')
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+    tags = get_tags(args.angular_app_dir)
+    grafana_dashboards = get_grafana_dashboards(args.grafana_dash_dir)
+    verbose = args.verbose
+
+    if not tags:
+        error_msg = 'Can not find any cd-grafana component under {}'.\
+            format(args.angular_app_dir)
+        exit(error_msg)
+
+    if verbose:
+        print('Found mappings:')
+    no_dashboard_tags = []
+    for tag in tags:
+        uid = tag['attrs']['uid']
+        if uid not in grafana_dashboards:
+            no_dashboard_tags.append(copy.copy(tag))
+            continue
+        if verbose:
+            msg = '{} ({}:{}) \n\t-> {} ({})'.\
+                format(uid, tag['file'], tag['line'],
+                       grafana_dashboards[uid]['title'],
+                       grafana_dashboards[uid]['file'])
+            print(msg)
+
+    if no_dashboard_tags:
+        title = ('Checking Grafana dashboards UIDs: ERROR\n'
+                 'Components that have no mapped Grafana dashboards:\n')
+        lines = ('{} ({}:{})'.format(tag['attrs']['uid'],
+                                     tag['file'],
+                                     tag['line'])
+                 for tag in no_dashboard_tags)
+        error_msg = title + '\n'.join(lines)
+        exit(error_msg)
+    else:
+        print('Checking Grafana dashboards UIDs: OK')
+
+
+if __name__ == '__main__':
+    main()
diff --git a/src/pybind/mgr/dashboard/ci/check_grafana_uids.py b/src/pybind/mgr/dashboard/ci/check_grafana_uids.py
deleted file mode 100644
index 250fb8bad480..000000000000
--- a/src/pybind/mgr/dashboard/ci/check_grafana_uids.py
+++ /dev/null
@@ -1,159 +0,0 @@
-# -*- coding: utf-8 -*-
-# pylint: disable=F0401
-"""
-This script does:
-* Scan through Angular html templates and extract <cd-grafana> tags
-* Check if every tag has a corresponding Grafana dashboard by `uid`
-
-Usage:
-    python <script> <angular_app_dir> <grafana_dashboard_dir>
-
-e.g.
-    cd /ceph/src/pybind/mgr/dashboard
-    python ci/<script> frontend/src/app /ceph/monitoring/grafana/dashboards
-"""
-import argparse
-import codecs
-import copy
-import json
-import os
-from html.parser import HTMLParser
-
-
-class TemplateParser(HTMLParser):
-
-    def __init__(self, _file, search_tag):
-        super().__init__()
-        self.search_tag = search_tag
-        self.file = _file
-        self.parsed_data = []
-
-    def parse(self):
-        with codecs.open(self.file, encoding='UTF-8') as f:
-            self.feed(f.read())
-
-    def handle_starttag(self, tag, attrs):
-        if tag != self.search_tag:
-            return
-        tag_data = {
-            'file': self.file,
-            'attrs': dict(attrs),
-            'line': self.getpos()[0]
-        }
-        self.parsed_data.append(tag_data)
-
-    def error(self, message):
-        error_msg = 'fail to parse file {} (@{}): {}'.\
-            format(self.file, self.getpos(), message)
-        exit(error_msg)
-
-
-def get_files(base_dir, file_ext):
-    result = []
-    for root, _, files in os.walk(base_dir):
-        for _file in files:
-            if _file.endswith('.{}'.format(file_ext)):
-                result.append(os.path.join(root, _file))
-    return result
-
-
-def get_tags(base_dir, tag='cd-grafana'):
-    templates = get_files(base_dir, 'html')
-    tags = []
-    for templ in templates:
-        parser = TemplateParser(templ, tag)
-        parser.parse()
-        if parser.parsed_data:
-            tags.extend(parser.parsed_data)
-    return tags
-
-
-def get_grafana_dashboards(base_dir):
-    json_files = get_files(base_dir, 'json')
-    dashboards = {}
-    for json_file in json_files:
-        try:
-            with open(json_file) as f:
-                dashboard_config = json.load(f)
-                uid = dashboard_config.get('uid')
-                assert dashboard_config['id'] is None, \
-                    "'id' not null: '{}'".format(dashboard_config['id'])
-
-                # Grafana dashboard checks
-                title = dashboard_config['title']
-                assert len(title) > 0, \
-                    "Title not found in '{}'".format(json_file)
-                assert len(dashboard_config.get('links', [])) == 0, \
-                    "Links found in '{}'".format(json_file)
-                if not uid:
-                    continue
-                if uid in dashboards:
-                    # duplicated uids
-                    error_msg = 'Duplicated UID {} found, already defined in {}'.\
-                        format(uid, dashboards[uid]['file'])
-                    exit(error_msg)
-
-                dashboards[uid] = {
-                    'file': json_file,
-                    'title': title
-                }
-        except Exception as e:
-            print(f"Error in file {json_file}")
-            raise e
-    return dashboards
-
-
-def parse_args():
-    long_desc = ('Check every <cd-grafana> component in Angular template has a'
-                 ' mapped Grafana dashboard.')
-    parser = argparse.ArgumentParser(description=long_desc)
-    parser.add_argument('angular_app_dir', type=str,
-                        help='Angular app base directory')
-    parser.add_argument('grafana_dash_dir', type=str,
-                        help='Directory contains Grafana dashboard JSON files')
-    parser.add_argument('--verbose', action='store_true',
-                        help='Display verbose mapping information.')
-    return parser.parse_args()
-
-
-def main():
-    args = parse_args()
-    tags = get_tags(args.angular_app_dir)
-    grafana_dashboards = get_grafana_dashboards(args.grafana_dash_dir)
-    verbose = args.verbose
-
-    if not tags:
-        error_msg = 'Can not find any cd-grafana component under {}'.\
-            format(args.angular_app_dir)
-        exit(error_msg)
-
-    if verbose:
-        print('Found mappings:')
-    no_dashboard_tags = []
-    for tag in tags:
-        uid = tag['attrs']['uid']
-        if uid not in grafana_dashboards:
-            no_dashboard_tags.append(copy.copy(tag))
-            continue
-        if verbose:
-            msg = '{} ({}:{}) \n\t-> {} ({})'.\
-                format(uid, tag['file'], tag['line'],
-                       grafana_dashboards[uid]['title'],
-                       grafana_dashboards[uid]['file'])
-            print(msg)
-
-    if no_dashboard_tags:
-        title = ('Checking Grafana dashboards UIDs: ERROR\n'
-                 'Components that have no mapped Grafana dashboards:\n')
-        lines = ('{} ({}:{})'.format(tag['attrs']['uid'],
-                                     tag['file'],
-                                     tag['line'])
-                 for tag in no_dashboard_tags)
-        error_msg = title + '\n'.join(lines)
-        exit(error_msg)
-    else:
-        print('Checking Grafana dashboards UIDs: OK')
-
-
-if __name__ == '__main__':
-    main()
diff --git a/src/pybind/mgr/dashboard/tox.ini b/src/pybind/mgr/dashboard/tox.ini
index 1cda4c45acd0..50224bb8f652 100644
--- a/src/pybind/mgr/dashboard/tox.ini
+++ b/src/pybind/mgr/dashboard/tox.ini
@@ -154,7 +154,7 @@ commands =
 
 [testenv:check]
 commands =
-    python ci/check_grafana_uids.py frontend/src/app ../../../../monitoring/grafana/dashboards
+    python ci/check_grafana_dashboards.py frontend/src/app ../../../../monitoring/grafana/dashboards
 
 [testenv:openapi-{check,fix}]
 basepython = python3