Adjusting redis docs#161
Merged
Merged
Conversation
jeff-matthews
approved these changes
Sep 18, 2025
jeff-matthews
left a comment
Contributor
There was a problem hiding this comment.
Thanks for the PR! I left a couple of minor editorial suggestions. I'll import to our internal delivery repo next. That repo includes some PR validation for .md formatting that may flag some additional superficial fixes, but I'll take care of that.
Contributor
|
@jeff-matthews the PR body must include the whatsnew tag to be detected by the automation |
Contributor
|
I added the tag word. |
Contributor
|
No, I think it's because repo sync is broken. I created a UGP ticket. Other repos are affected. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This PR improves the Redis guidance for Adobe Commerce on cloud infrastructure and clarifies configuration locations and intent. It documents how to enable stale cache on cloud, adds vetted server-side options (lazyfree and multithreaded I/O) with risks and operational notes, corrects the session configuration example, and adds client-side timeout/retry guidance. It also adds an explicit caveat that longer timeouts/retries are not a remedy for sustained overload.
Affected pages
Additional information
Summary of changes, rationale, and scope:
1. Stale cache enablement (cloud):
The instructions now point to config.php (cloud only) for enabling stale cache via RemoteSynchronizedCache and include a concrete configuration block. This aligns with how Cloud merges configuration and avoids implying .magento.env.yaml alone is sufficient for stale cache routing.
2. Session configuration example:
Removes a hardcoded port line from the session Redis example to prevent copy-paste errors. On Cloud, the service endpoint is injected via $MAGENTO_CLOUD_RELATIONSHIPS; specifying a port is usually unnecessary and often wrong.
3. Redis asynchronous freeing (lazyfree):
Adds operational guidance to request the following Redis settings via an Adobe Commerce Support ticket:
lazyfree-lazy-eviction yes, lazyfree-lazy-expire yes, lazyfree-lazy-server-del yes, replica-lazy-flush yes, lazyfree-lazy-user-del yes.
Explains the effect (offloading memory reclamation to background threads), a note that lazy-user-del makes DEL behave like UNLINK, and a warning about transient memory footprint under pressure.
4. Redis multithreaded I/O:
Adds instructions to request io-threads-do-reads yes and a tuned io-threads value via Support. Clarifies that only socket I/O and parsing are parallelized, not command execution, and includes a caution about CPU usage with guidance to benchmark and tune conservatively.
5. Client timeouts and retries:
Adds a small .magento.env.yaml snippet to increase read_timeout and connect_retries for cache clients. Clarifies this is to smooth brief congestion (e.g., many PHP workers connecting simultaneously) and explicitly states this is not a fix for persistent overload.
Links to the affected code
What's New highlights
whatsnew
Added guidance for enabling stale cache on cloud via config.php; new sections on Redis lazyfree and multithreaded I/O (requestable via Support); clarified session Redis example; and added client timeout/retry guidance with an explicit overload caveat.