From 6e1c5e957afa69f043cac0918ea546746f4e3ff0 Mon Sep 17 00:00:00 2001 From: Kevin Minehart Date: Tue, 16 Mar 2021 09:35:52 -0500 Subject: [PATCH] Enterprise: Add Redis caching documentation (#32001) * Document Redis cache config in Grafana Enterprise Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> --- docs/sources/enterprise/enterprise-configuration.md | 10 ++++++++++ docs/sources/enterprise/query-caching.md | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/sources/enterprise/enterprise-configuration.md b/docs/sources/enterprise/enterprise-configuration.md index 792bbbcffd6..080d6baa029 100644 --- a/docs/sources/enterprise/enterprise-configuration.md +++ b/docs/sources/enterprise/enterprise-configuration.md @@ -351,3 +351,13 @@ The default TTL (time to live) if no other TTL is available. ### gc_interval When storing cache data in-memory, this setting defines how often a background process cleans up stale data from the in-memory cache. More frequent "garbage collection" can keep memory usage from climbing but will increase CPU usage. + +## [caching.redis] + +### url + +The full Redis URL of your Redis server. Example: `redis://localhost:6739/0`. + +### prefix + +A string that prefixes all Redis keys. This value must be set if using a shared database in Redis. If `prefix` is empty, then one will not be used. diff --git a/docs/sources/enterprise/query-caching.md b/docs/sources/enterprise/query-caching.md index 8e160e68612..f11769a4a09 100644 --- a/docs/sources/enterprise/query-caching.md +++ b/docs/sources/enterprise/query-caching.md @@ -11,7 +11,7 @@ weight = 110 When query caching is enabled, Grafana temporarily stores the results of data source queries. When you or another user submit the exact same query again, the results will come back from the cache instead of from the data source (like Splunk or ServiceNow) itself. -Query caching currently works for all backend data sources. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL). The cache is in-memory only. +Query caching currently works for all backend data sources. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL). The cache can either be in-memory or in Redis. ## Query caching benefits