Adaptive cache docs #17
Open
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
Updates documentation to introduce adaptive caching, support Valkey alongside Redis, and prepare for a new slot cache expiry setting.
- Adds an adaptive caching guide.
- Updates menus and API docs to reference Valkey.
- Inserts placeholder for
slot_cache_expiryin configuration.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/1.x/index.md | Added Eviction and Ratios sections; reordered menu entries |
| docs/1.x/connections.md | Expanded Redis connection notes to include Valkey |
| docs/1.x/configuration.md | Updated invalidation endpoint note; added placeholder for expiry |
| docs/1.x/api.md | Adjusted metadata bullets for Redis/Valkey commands |
| docs/1.x/adaptive.md | New guide for adaptive caching setup |
Comments suppressed due to low confidence (4)
docs/1.x/index.md:12
- The
Ratioslink currently points to/docs/1.x/events; it should target the correctratiospage (e.g.,/docs/1.x/ratios).
- [Ratios](/docs/1.x/events)
docs/1.x/index.md:14
- There are two
Tablesentries in this section; consider removing the duplicate to keep the menu concise.
- [Tables](/docs/1.x/tables)
docs/1.x/configuration.md:51
- This entry has a placeholder (
???); please provide a clear description of whatslot_cache_expirycontrols and its default behavior.
| `relay.cluster.slot_cache_expiry` | | ??? |
docs/1.x/api.md:26
- The
RedisCommandbullet was removed when addingValkeyCommand; you may want to retain both bullets to document the distinction between Redis and Valkey commands.
- `ValkeyCommand` indicates the method represents a [command](https://valkey.io/commands/)
tillkruss
commented
Jul 3, 2025
| | `relay.loglevel` | `off` | Whether Relay should log debug information. Supported levels: `debug`, `verbose`, `error`, `off` | | ||
| | `relay.logfile` | | The path to the file in which information should be logged, if logging is enabled. | | ||
| | `relay.cluster.seeds` | | The list of cluster nodes addresses grouped by cluster name, which will be used to initialize each cluster, encoded as URL query string, e.g. `cluster1[]=127.0.0.1:7000&cluster2[]=127.0.0.1:8000` | | ||
| | `relay.cluster.auth` | | The list of credentials for each cluster, encoded as URL query string. Password string or username/password pairs may be used, e.g. `cluster1=secret&cluster2[]=username&cluster2[]=secret` | | ||
| | `relay.cluster.timeout` | | The maximum number of seconds Relay will wait while establishing connection to a single cluster node. | | ||
| | `relay.cluster.read_timeout` | | The maximum number of seconds Relay will wait while reading from a cluster node. | | ||
| | `relay.cluster.slot_cache_expiry` | | ??? | |
There was a problem hiding this comment.
@yatsukhnenko What does this do in simple words?
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.
slot_cache_expirydescriptionadaptive.md