Skip to content

chore(docs): Update cache docs #17420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 18 commits into from
Apr 29, 2025
Merged

chore(docs): Update cache docs #17420

merged 18 commits into from
Apr 29, 2025

Conversation

poyzannur
Copy link
Contributor

What this PR does / why we need it:
This is a start to improve cache documentation on Loki.
It will follow up with a sizing recommendation on this page: https://grafana.com/docs/loki/latest/setup/size/
And a second follow up on memcached-extstore configuration.

Which issue(s) this PR fixes:
Fixes #6201

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Apr 23, 2025
Copy link
Contributor

github-actions bot commented Apr 23, 2025

@poyzannur poyzannur changed the title chore(docs): Update OSS cache docs chore(docs): Update cache docs Apr 23, 2025
poyzannur and others added 7 commits April 23, 2025 20:00
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
@poyzannur poyzannur marked this pull request as ready for review April 24, 2025 11:28
@poyzannur poyzannur requested a review from a team as a code owner April 24, 2025 11:28
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team]


## Before you begin

- It is recommended to deploy three, or in the case of the Helm chart two, dedicated Memcached clusters.
- As of 2025-02-06, the `memcached:1.6.35-alpine` version of the library is recommended.
- It is recommended to deploy separate Memcached clusters for these components.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"these components" - We should explicitly list the components.

poyzannur and others added 9 commits April 25, 2025 11:57
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Docs team] Just a couple of very small tweaks

Minor copyedits

Signed-off-by: J Stickler <julie.stickler@grafana.com>
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] LGTM

@poyzannur poyzannur merged commit 1cb4647 into main Apr 29, 2025
61 checks passed
@poyzannur poyzannur deleted the poyzan/update-memcached-docs branch April 29, 2025 22:12
loki-gh-app bot pushed a commit that referenced this pull request May 2, 2025
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Signed-off-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit 1cb4647)
loki-gh-app bot pushed a commit that referenced this pull request May 2, 2025
Signed-off-by: Poyzan <31743851+poyzannur@users.noreply.github.com>
Signed-off-by: J Stickler <julie.stickler@grafana.com>
Co-authored-by: Paul Rogers <129207811+paul1r@users.noreply.github.com>
Co-authored-by: J Stickler <julie.stickler@grafana.com>
(cherry picked from commit 1cb4647)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.4.x backport release-3.5.x size/M type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: Have a dedicated doc about caching in Loki
3 participants