From 1e2c1c81b61808ed76813b662f834e048e313976 Mon Sep 17 00:00:00 2001 From: Ben Ye Date: Thu, 5 Oct 2023 00:41:11 -0700 Subject: [PATCH] update docs Signed-off-by: Ben Ye --- docs/components/store.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/components/store.md b/docs/components/store.md index 6c0f713411c..c80de3d2df9 100644 --- a/docs/components/store.md +++ b/docs/components/store.md @@ -291,14 +291,22 @@ type: IN-MEMORY config: max_size: 0 max_item_size: 0 +<<<<<<< HEAD enabled_items: [] +======= +ttl: 0s +>>>>>>> 3b06b209 (update docs) ``` All the settings are **optional**: - `max_size`: overall maximum number of bytes cache can contain. The value should be specified with a bytes unit (ie. `250MB`). - `max_item_size`: maximum size of single item, in bytes. The value should be specified with a bytes unit (ie. `125MB`). +<<<<<<< HEAD - `enabled_items`: selectively choose what types of items to cache. Supported values are `Postings`, `Series` and `ExpandedPostings`. By default, all items are cached. +======= +- `ttl`: this field doesn't do anything for inmemory cache. +>>>>>>> 3b06b209 (update docs) ### Memcached index cache @@ -317,7 +325,11 @@ config: max_get_multi_batch_size: 0 dns_provider_update_interval: 0s auto_discovery: false +<<<<<<< HEAD enabled_items: [] +======= +ttl: 0s +>>>>>>> 3b06b209 (update docs) ``` The **required** settings are: @@ -335,7 +347,11 @@ While the remaining settings are **optional**: - `max_item_size`: maximum size of an item to be stored in memcached. This option should be set to the same value of memcached `-I` flag (defaults to 1MB) in order to avoid wasting network round trips to store items larger than the max item size allowed in memcached. If set to `0`, the item size is unlimited. - `dns_provider_update_interval`: the DNS discovery update interval. - `auto_discovery`: whether to use the auto-discovery mechanism for memcached. +<<<<<<< HEAD - `enabled_items`: selectively choose what types of items to cache. Supported values are `Postings`, `Series` and `ExpandedPostings`. By default, all items are cached. +======= +- `ttl`: ttl to store index cache items in memcached. +>>>>>>> 3b06b209 (update docs) ### Redis index cache @@ -367,6 +383,7 @@ config: max_async_buffer_size: 10000 max_async_concurrency: 20 enabled_items: [] +ttl: 0s ``` The **required** settings are: @@ -383,6 +400,7 @@ While the remaining settings are **optional**: - `write_timeout`: the redis write timeout. - `cache_size` size of the in-memory cache used for client-side caching. Client-side caching is enabled when this value is not zero. See [official documentation](https://redis.io/docs/manual/client-side-caching/) for more. It is highly recommended to enable this so that Thanos Store would not need to continuously retrieve data from Redis for repeated requests of the same key(-s). - `enabled_items`: selectively choose what types of items to cache. Supported values are `Postings`, `Series` and `ExpandedPostings`. By default, all items are cached. +- `ttl`: ttl to store index cache items in redis. Here is an example of what effect client-side caching could have: