Skip to content

Commit

Permalink
[release-2.7.x] docs(embedded-cache): Add missing docs on config page. (
Browse files Browse the repository at this point in the history
#7687)

Backport 7073ea8 from #7684

Co-authored-by: Kaviraj Kanagaraj <kavirajkanagaraj@gmail.com>
  • Loading branch information
grafanabot and kavirajk committed Nov 14, 2022
1 parent 8d2fbb7 commit 568f741
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

##### Enhancements

* [7684](https://github.com/grafana/loki/pull/7684) **kavirajk**: Add missing `embedded-cache` config under `cache_config` doc.
* [6360](https://github.com/grafana/loki/pull/6099) **liguozhong**: Hide error message when ctx timeout occurs in s3.getObject
* [7602](https://github.com/grafana/loki/pull/7602) **vmax**: Add decolorize filter to easily parse colored logs.

Expand Down
29 changes: 22 additions & 7 deletions docs/sources/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ ring:
# reading and writing.
# CLI flag: -distributor.ring.heartbeat-timeout
[heartbeat_timeout: <duration> | default = 1m]

rate_store:
# The max number of concurrent requests to make to ingester stream apis
# CLI flag: -distributor.rate-store.max-request-parallelism
Expand Down Expand Up @@ -625,7 +625,7 @@ remote_write:

# Deprecated: Use `clients` instead
# Configure remote write client.
[client: <remote_write_client_config>]
[client: <remote_write_client_config>]

# Configure remote write clients.
# A map with remote client id as key.
Expand Down Expand Up @@ -1846,7 +1846,8 @@ the index to a backing cache store.
<span style="background-color:#f3f973;">The memcached configuration variable addresses is experimental.</span>

```yaml
# Enable in-memory cache.
# NOTE: `fifocache` is deprecated. Use `embedded-cache` instead.
# Enable in-memory cache (auto-enabled for the chunks & query results cache if no other cache is configured).
# CLI flag: -<prefix>.cache.enable-fifocache
[enable_fifocache: <boolean>]

Expand All @@ -1855,14 +1856,28 @@ the index to a backing cache store.
# CLI flag: -<prefix>.default-validity
[default_validity: <duration>]

# Configures embedded cache settings.
embedded-cache:
# Whether embedded cache is enabled.
# CLI flag: -<prefix>.embeddec-cache.enabled
[enabled: <bool> | default = false]

# Maximum memory size of the cache in MB.
# CLI flag: -<prefix>.embedded-cache.max-size-mb
[max_size_mb: <int> | default = 100]

# The time to live for items in the cache before they get purged.
# CLI flag: -<prefix>.embedded-cache.ttl
[ttl: <duration> | default = 1hr]

# Configures the background cache when memcached is used.
background:
# How many goroutines to use to write back to memcached.
# CLI flag: -<prefix>.background.write-back-concurrency
[writeback_goroutines: <int> | default = 10]

# How many chunks to buffer for background write back to memcached.
# CLI flagL -<prefix>.background.write-back-buffer
# CLI flag: -<prefix>.background.write-back-buffer
[writeback_buffer: <int> = 10000]

# Configures memcached settings.
Expand Down Expand Up @@ -2373,7 +2388,7 @@ shard_streams:
[enabled: <boolean> | default = false]

# Enable logging when sharding streams because logging on the read path may
# impact performance. When disabled, stream sharding will emit no logs
# impact performance. When disabled, stream sharding will emit no logs
# regardless of log level
#
# CLI flag: -shard-streams.logging-enabled
Expand Down Expand Up @@ -2457,9 +2472,9 @@ shard_streams:
# sign every remote write request.
[ruler_remote_write_sigv4_config: <sigv4_config>]

# Configures global and per-tenant limits for remote write clients.
# Configures global and per-tenant limits for remote write clients.
# A map with remote client id as key.
ruler_remote_write_config:
ruler_remote_write_config:
[<string>: <remote_write_client_config>]

# Limit queries that can be sharded.
Expand Down

0 comments on commit 568f741

Please sign in to comment.