From d9a79b449f4e3d5378c377f3c9f5412c289c349d Mon Sep 17 00:00:00 2001
From: Kaviraj Kanagaraj <kavirajkanagaraj@gmail.com>
Date: Mon, 14 Nov 2022 11:36:24 +0100
Subject: [PATCH] docs(embedded-cache): Add missing docs on config page.
 (#7684)

**What this PR does / why we need it**:
Adds `embedded-cache` config under `cache_config` section. Also adds
message about deprecation of `fifocache`

**Which issue(s) this PR fixes**:
Fixes #7677

**Special notes for your reviewer**:

**Checklist**
- [x] Documentation added
- [x] `CHANGELOG.md` updated

(cherry picked from commit 7073ea870252c7392198eaddee607c4fd8c66a74)
---
 CHANGELOG.md                         |  1 +
 docs/sources/configuration/_index.md | 29 +++++++++++++++++++++-------
 2 files changed, 23 insertions(+), 7 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7245f028937a..1434e3021b7c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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.
 
diff --git a/docs/sources/configuration/_index.md b/docs/sources/configuration/_index.md
index f8f4ad46f8c1..373c5c09bf92 100644
--- a/docs/sources/configuration/_index.md
+++ b/docs/sources/configuration/_index.md
@@ -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
@@ -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.
@@ -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>]
 
@@ -1855,6 +1856,20 @@ 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.
@@ -1862,7 +1877,7 @@ background:
   [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.
@@ -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
@@ -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.