opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 21:32:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/enterprise/query-caching.md
Kevin Minehart 43bfa2801c Documentation: Update Grafana Enterprise caching documentation (#33398) 
* update caching documentation

Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com>
2021-04-27 11:06:25 -05:00

2.1 KiB
Raw Blame History

+++ title = "Query caching" description = "Grafana Enterprise data source query caching" keywords = ["grafana", "plugins", "query", "caching"] weight = 110 +++

Query caching

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 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

  • Faster dashboard load times, especially for popular dashboards.
  • Reduced API costs.
  • Reduced likelihood that APIs will rate-limit or throttle requests.

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.