Docs: add query caching to Enterprise docs (#31741)

* Docs: add query caching to Enterprise docs

Co-authored-by: Kevin Minehart <kmineh0151@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
This commit is contained in:
Mitch Seaman 2021-03-05 13:07:07 -07:00 committed by GitHub
parent 6819a25add
commit 04e82add68
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 0 deletions

View File

@ -326,3 +326,22 @@ A list of headers that are stripped from the outgoing data source and alerting r
### cookie_drop_list
A list of cookies that are stripped from the outgoing data source and alerting requests.
## [caching]
> **Note:** Available in Grafana Enterprise v7.5 and later versions.
> **Note:** Redis and memcached sections are in the defaults.ini setting, but Redis and Memcached backends are 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.
### backend
The caching backend to use when storing cached queries. Options: memory
### enabled
Setting 'enabled' to true enables caching datasource queries for all data sources.
### ttl
The default TTL (time to live) if no other TTL is available.

View File

@ -0,0 +1,24 @@
+++
title = "Query caching"
description = "Grafana Enterprise data source query caching"
keywords = ["grafana", "plugins", "query", "caching"]
weight = 110
+++
# Query caching
> **Note:** Query caching is available behind a 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 or per data source, and you can configure the cache duration per data source. The cache is in-memory only.
## Query caching benefits
- Faster dashboard load times, especially for popular dashboards.
- Reduced API costs.
- Reduced likelihood that APIs will rate-limit or throttle requests.
## Enable query caching
To enable and configure query caching, please refer the the [Query caching section of Enterprise Configuration]({{< relref "./enterprise-configuration.md#query-caching" >}}).