IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-26 02:40:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Update Grafana Enterprise caching documentation (#33398)

Browse Source 
* update caching documentation

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
This commit is contained in:
Kevin Minehart 2021-04-27 11:06:25 -05:00 committed by GitHub
parent 467ab124dd
commit 43bfa2801c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/sources/enterprise/enterprise-configuration.md
View File

@ -330,7 +330,6 @@ A list of cookies that are stripped from the outgoing data source and alerting r
## [caching]
> **Note:** Available in Grafana Enterprise v7.5 and later versions.
> **Note:** The Memcached cache backend is unavailable in Grafana Enterprise v7.5.
When query caching is enabled, Grafana temporarily stores the results of data source queries and serves cached responses to similar requests.
@ -338,9 +337,13 @@ When query caching is enabled, Grafana temporarily stores the results of data so
The caching backend to use when storing cached queries. Options: memory
> **Note:** This setting enables the caching feature, and does not enable query caching for any data source. To enable query caching for a data source, refer to the data source’s configuration page.
### enabled
Setting 'enabled' to true enables caching datasource queries for all data sources.
Setting 'enabled' to true enables query caching for data sources with configured caching.
This value is enabled by default.
### ttl
@ -361,3 +364,9 @@ 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.
## [caching.memcached]
### memcached_servers
A space-separated list of memcached servers. Example: `memcached-server-1:11211 memcached-server-2:11212 memcached-server-3:11211`. Or if there's only one server: `memcached-server:11211`

18
docs/sources/enterprise/query-caching.md
View File

@ -7,11 +7,13 @@ weight = 110
# Query caching
> **Note:** Query caching is available behind the `caching` feature flag in Grafana Enterprise 7.5+.
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 can either be in-memory or in Redis.
Query caching works for all backend data sources, and queries sent through the data source proxy. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL).
The following cache backends are available: in-memory, Redis, and Memcached.
> **Note:** Storing cached queries in-memory can increase Grafana's memory footprint. In production environments, a Redis or Memcached backend is highly recommended.
## Query caching benefits
@ -21,8 +23,18 @@ Query caching currently works for all backend data sources. You can enable the c
## Enable query caching
> **Note:** The query caching feature is enabled by default. To start caching data source queries, visit the data source's configuration page.
To enable and configure query caching, please refer the the [Query caching section of Enterprise Configuration]({{< relref "./enterprise-configuration.md#caching" >}}).
Once caching is enabled in the Grafana instance, query caching can be enabled per data source in the data source settings.
## Disable query caching
To disable query caching for a single data source, visit the data source settings page.
To unilaterally disable query caching for all data sources, edit the `enabled` flag in the [Query caching section of Enterprise Configuration]({{< relref "./enterprise-configuration.md#caching" >}}).
## Sending a request without cache
If the data source query request contains an `X-Cache-Skip` header, then Grafana skips the caching middleware, and does not search the cache for a response. This can be particularly useful when debugging data source queries using cURL.