From c1ab37a9d4e8befc428a32b535756d631ee68b0d Mon Sep 17 00:00:00 2001 From: "Grot (@grafanabot)" <43478413+grafanabot@users.noreply.github.com> Date: Wed, 24 Nov 2021 16:44:30 -0500 Subject: [PATCH] Docs: Add docs for caching timeouts (#39672) (#41851) Co-authored-by: Stephanie Hingtgen (cherry picked from commit c3f1cc6c7557434340415b7be9654ac7954ee555) Co-authored-by: Todd Treece <360020+toddtreece@users.noreply.github.com> --- .../enterprise/enterprise-configuration.md | 32 ++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/sources/enterprise/enterprise-configuration.md b/docs/sources/enterprise/enterprise-configuration.md index 78edef25efb..7baaa339d50 100644 --- a/docs/sources/enterprise/enterprise-configuration.md +++ b/docs/sources/enterprise/enterprise-configuration.md @@ -353,7 +353,15 @@ This value is `true` by default. ### ttl -_Time to live_ (TTL) is the time that a query result is stored in the caching system before it is deleted or refreshed. This setting defines the time to live for query caching, when TTL is not configured in data source settings. The default value is `5m` (5 minutes). +_Time to live_ (TTL) is the time that a query result is stored in the caching system before it is deleted or refreshed. This setting defines the time to live for query caching, when TTL is not configured in data source settings. The default value is `1m` (1 minute). + +### max_ttl + +The max duration that a query result is stored in the caching system before it is deleted or refreshed. This value will override `ttl` config option or data source setting if the `ttl` value is greater than `max_ttl`. To disable this constraint, set this value to `0s`. + +The default is `0s` (disabled). + +> **Note:** Disabling this constraint is not recommended in production environments. ### max_value_mb @@ -361,6 +369,28 @@ This value limits the size of a single cache value. If a cache value (or query r The default is `1`. +### connection_timeout + +This setting defines the duration to wait for a connection to the caching backend. + +The default is `5s`. + +### read_timeout + +This setting defines the duration to wait for the caching backend to return a cached result. To disable this timeout, set this value to `0s`. + +The default is `0s` (disabled). + +> **Note:** Disabling this timeout is not recommended in production environments. + +### write_timeout + +This setting defines the number of seconds to wait for the caching backend to store a result. To disable this timeout, set this value to `0s`. + +The default is `0s` (disabled). + +> **Note:** Disabling this timeout is not recommended in production environments. + ## [caching.encryption] ### enabled