Improve caching

- Use cache database location within user folder
- Send cache database location to log
- Reduce default cache TTL from five minutes to 60 seconds

Author: amotl

CHANGES.rst

@@ -10,6 +10,11 @@ in progress
 - Add URLs to dashboard variables and panel view/edit pages to the output of
   the ``find`` subcommand. Thanks, @oplehto.
 - Improve display of progressbar wrt. being interrupted by logging output.
+- Improve caching
+
+  - Use cache database location within user folder
+  - c cache database location to log
+  - Reduce default cache TTL from five minutes to 60 seconds
 
 2022-06-19 0.13.4
 =================

grafana_wtf/commands.py

@@ -45,7 +45,7 @@ def run():
       --select-dashboard=<uuid>         Restrict operation to dashboard by UID.
                                         Can be a list of comma-separated dashboard UIDs.
       --format=<format>                 Output format. [default: json]
-      --cache-ttl=<cache-ttl>           Time-to-live for the request cache in seconds. [default: 300]
+      --cache-ttl=<cache-ttl>           Time-to-live for the request cache in seconds. [default: 60]
       --drop-cache                      Drop cache before requesting resources
       --concurrency=<concurrency>       Run multiple requests in parallel. [default: 5]
       --dry-run                         Dry-run mode for the `replace` subcommand.

grafana_wtf/core.py

@@ -48,13 +48,16 @@ def __init__(self, grafana_url, grafana_token):
         self.debug = log.getEffectiveLevel() == logging.DEBUG
         self.progressbar = not self.debug
 
-    def enable_cache(self, expire_after=300, drop_cache=False):
+    def enable_cache(self, expire_after=60, drop_cache=False):
         if expire_after is None:
-            log.info(f"Setting up response cache to never expire (infinite caching)")
+            log.info(f"Configure response cache to never expire (infinite caching)")
         else:
-            log.info(f"Setting up response cache to expire after {expire_after} seconds")
-        requests_cache.install_cache(expire_after=expire_after)
+            log.info(f"Configure response cache to expire after {expire_after} seconds")
+        requests_cache.install_cache(expire_after=expire_after, use_cache_dir=True)
+        cache_database_file = requests_cache.get_cache().db_path
+        log.info(f"Response cache database location is {cache_database_file}")
         if drop_cache:
+            log.info("Dropping response cache")
             self.clear_cache()
 
         return self

setup.py

@@ -18,7 +18,7 @@
     "grafana-client>=2.1.0,<4",
     "jsonpath-rw>=1.4.0,<2",
     # Caching
-    "requests-cache>=0.5.2,<1",
+    "requests-cache>=0.8.0,<1",
     # Output
     "tabulate>=0.8.5,<0.10",
     "colored>=1.4.3,<2",