History: Stop grafana-wtf log <UID> acquiring *all* dashboards

Author: amotl

CHANGES.rst

@@ -8,6 +8,7 @@ in progress
 - Explore dashboards: Ignore ``-- Mixed --`` data sources
 - Caching: Increase default cache TTL to five minutes again
 - Caching: Optionally configure TTL using environment variable ``CACHE_TTL``
+- History: Stop ``grafana-wtf log <UID>`` acquiring *all* dashboards
 
 2023-03-05 0.14.1
 =================

grafana_wtf/commands.py

@@ -186,6 +186,8 @@ def run():
             'No Grafana URL given. Please use "--grafana-url" option or environment variable "GRAFANA_URL".'
         )
 
+    log.info(f"Using Grafana at {grafana_url}")
+
     engine = GrafanaWtf(grafana_url, grafana_token)
     engine.enable_cache(expire_after=cache_ttl, drop_cache=options["drop-cache"])
     engine.enable_concurrency(int(options["concurrency"]))
@@ -222,7 +224,6 @@ def run():
         engine.clear_cache()
 
     if options.log:
-        engine.scan_dashboards()
         entries = engine.log(dashboard_uid=options.dashboard_uid)
         entries = sorted(entries, key=itemgetter("datetime"), reverse=True)
 

grafana_wtf/core.py

@@ -357,21 +357,30 @@ def log(self, dashboard_uid=None):
             what = 'Grafana dashboard "{}"'.format(dashboard_uid)
         else:
             what = "multiple Grafana dashboards"
-        log.info("Aggregating edit history for {what} at {url}".format(what=what, url=self.grafana_url))
+        log.info(f"Acquiring data for {what}")
 
+        uid_filter = None
+        if dashboard_uid:
+            uid_filter = [dashboard_uid]
+        dashboards = self.scan_dashboards(dashboard_uids=uid_filter)
+
+        log.info(f"Aggregating edit history for {what}")
         entries = []
-        for dashboard_meta in self.data.dashboard_list:
-            if dashboard_uid is not None and dashboard_meta["uid"] != dashboard_uid:
+        for dashboard in dashboards:
+            dashboard_data = dashboard["dashboard"]
+            dashboard_meta = dashboard["meta"]
+
+            if dashboard_uid is not None and dashboard_data["uid"] != dashboard_uid:
                 continue
 
-            dashboard_versions = self.get_dashboard_versions(dashboard_meta["id"])
+            dashboard_versions = self.get_dashboard_versions(dashboard_data["id"])
             for dashboard_revision in dashboard_versions:
                 entry = OrderedDict(
                     datetime=dashboard_revision["created"],
                     user=dashboard_revision["createdBy"],
                     message=dashboard_revision["message"],
                     folder=dashboard_meta.get("folderTitle"),
-                    title=dashboard_meta["title"],
+                    title=dashboard_data["title"],
                     version=dashboard_revision["version"],
                     url=urljoin(self.grafana_url, dashboard_meta["url"]),
                 )

tests/test_commands.py

@@ -191,18 +191,35 @@ def test_replace_dashboard_dry_run_success(ldi_resources, capsys):
     assert "Dashboards: 0 hits" in captured.out
 
 
-def test_log_empty(capsys, caplog):
+def test_log_empty(docker_grafana, capsys, caplog):
     # Run command and capture output.
     set_command("log foobar")
     with caplog.at_level(logging.DEBUG):
         grafana_wtf.commands.run()
     captured = capsys.readouterr()
 
     # Verify output.
-    assert 'Aggregating edit history for Grafana dashboard "foobar" at http://localhost:33333' in caplog.text
+    assert 'Aggregating edit history for Grafana dashboard "foobar"' in caplog.text
     assert "[]" in captured.out
 
 
+def test_log_all(ldi_resources, capsys, caplog):
+
+    # Only provision specific dashboard(s).
+    ldi_resources(dashboards=["tests/grafana/dashboards/ldi-v27.json", "tests/grafana/dashboards/ldi-v33.json"])
+
+    # Run command and capture output.
+    set_command("log")
+    with caplog.at_level(logging.DEBUG):
+        grafana_wtf.commands.run()
+    captured = capsys.readouterr()
+
+    # Verify output.
+    assert 'Aggregating edit history for multiple Grafana dashboards' in caplog.text
+    history = json.loads(captured.out)
+    assert len(history) == 3
+
+
 def test_log_json_success(ldi_resources, capsys, caplog):
     # Only provision specific dashboard(s).
     ldi_resources(dashboards=["tests/grafana/dashboards/ldi-v27.json", "tests/grafana/dashboards/ldi-v33.json"])
@@ -214,7 +231,7 @@ def test_log_json_success(ldi_resources, capsys, caplog):
     captured = capsys.readouterr()
 
     # Verify output.
-    assert 'Aggregating edit history for Grafana dashboard "ioUrPwQiz" at http://localhost:33333' in caplog.text
+    assert 'Aggregating edit history for Grafana dashboard "ioUrPwQiz"' in caplog.text
 
     reference = {
         # "datetime": "2021-09-29T17:32:23Z",
@@ -244,7 +261,7 @@ def test_log_tabular_success(ldi_resources, capsys, caplog):
         captured = capsys.readouterr()
 
     # Verify output.
-    assert 'Aggregating edit history for Grafana dashboard "ioUrPwQiz" at http://localhost:33333' in caplog.text
+    assert 'Aggregating edit history for Grafana dashboard "ioUrPwQiz"' in caplog.text
 
     reference = """
     | Notes: n/a<br/>[Testdrive » luftdaten.info generic trend v27](http://localhost:33333/d/ioUrPwQiz/luftdaten-info-generic-trend-v27) | User: admin<br/>Date: xxxx-xx-xxTxx:xx:xxZ      |