[DOCs] Update cache configuration to support Redis-backed caching#2139
[DOCs] Update cache configuration to support Redis-backed caching#2139KaveeshaPiumini wants to merge 1 commit intoasgardeo:mainfrom
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 7 minutes and 57 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation expanded to document Redis as a supported cache backend, add global Redis connection/key settings, introduce per-internal-cache overrides via Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/content/guides/getting-started/configuration.mdx`:
- Around line 157-159: Update the doc sentence "When Redis caching is enabled,
Thunder uses Redis native key expiration for TTL handling." by replacing the
word "expiration" with "TTL" to satisfy the Vale wording rule and align with
docs style; edit that sentence in the configuration guide so it reads something
like "When Redis caching is enabled, Thunder uses Redis native key TTL for key
handling" (or similar concise phrasing using "TTL") to maintain consistency with
existing documentation.
- Around line 129-134: The doc currently lists `cache.cleanup_interval` as a
general setting though the cleanup routine is only run for the in-memory cache;
update the table row for `cache.cleanup_interval` to state it is "In-memory only
(not used for `cache.type: redis`)" and optionally add a short note next to
`cache.type` or the `cache.properties[]` entry explaining that Redis does not
use the periodic cleanup routine. Reference the `cache.cleanup_interval` and
`cache.type` keys when making the change so readers know the backend-specific
applicability.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ac19ef81-5111-47d2-9209-48e3e04c9915
📒 Files selected for processing (1)
docs/content/guides/getting-started/configuration.mdx
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2139 +/- ##
==========================================
- Coverage 89.51% 89.51% -0.01%
==========================================
Files 913 913
Lines 60289 60289
==========================================
- Hits 53969 53965 -4
- Misses 4694 4698 +4
Partials 1626 1626
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
KaveeshaPiumini
changed the title
KaveeshaPiumini
added
Type/Docs
skip-changelog
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
docs/content/guides/getting-started/configuration.mdx (2)
133-133:⚠️ Potential issue | 🟡 MinorClarify that
cache.cleanup_intervalapplies to in-memory cache only.The
cache.cleanup_intervalsetting does not apply whencache.typeisredis. Mark it as in-memory-only to prevent configuration confusion.📝 Suggested clarification
-| `cache.cleanup_interval` | `300` | Interval in seconds to clean up expired entries | +| `cache.cleanup_interval` | `300` | Interval in seconds to clean up expired entries (in-memory cache only) |As per coding guidelines,
docs/**: "Completeness: are all new endpoints, config keys, and behavioral changes covered?"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/guides/getting-started/configuration.mdx` at line 133, Update the docs entry for cache.cleanup_interval to state it only applies to the in-memory cache: explicitly mention that cache.cleanup_interval controls the cleanup interval for in-memory entries and is ignored when cache.type is set to "redis" (or any non-in-memory backend); reference the existing config keys cache.cleanup_interval and cache.type in the text so readers know the limitation and avoid misconfiguration.
197-197:⚠️ Potential issue | 🟡 MinorReplace "expiration" with "TTL" to satisfy style guidelines.
Vale flags "expiration" as too wordy. Although a past review comment marked this as addressed, the word "expiration" remains on line 197.
📝 Suggested fix
-When Redis caching is enabled, Thunder uses Redis native key expiration for TTL handling. +When Redis caching is enabled, Thunder uses Redis native key TTL handling.As per coding guidelines,
docs/**: "Consistency: does the style match existing documentation?"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/guides/getting-started/configuration.mdx` at line 197, Update the sentence that currently reads "When Redis caching is enabled, Thunder uses Redis native key expiration for TTL handling." by replacing the word "expiration" with "TTL" so it reads "When Redis caching is enabled, Thunder uses Redis native key TTL for TTL handling." Locate this text in the configuration guide (the sentence containing "Redis native key expiration") and make the single-word replacement to conform to the docs style guidelines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/content/guides/getting-started/configuration.mdx`:
- Line 141: Update the heading text "Per-Cache Overrides With
`cache.properties`" to use title case by changing "With" to lowercase — i.e.,
"Per-Cache Overrides with `cache.properties`" so it matches documentation style
and existing docs casing conventions; locate and edit the heading string in the
docs content where that exact heading appears.
- Line 173: The sentence describing FlowGraphCache is wordy; replace "It is not
a system-level cache used to optimize shared database reads across Thunder
instances. Instead, it caches in-process flow graph objects used during flow
execution, and those entries are stored as Go object structures rather than as
Redis-backed cache data." with a concise alternative that removes "It is"
phrasing—e.g., state that FlowGraphCache is always in-memory and caches
in-process flow graph Go objects (not a system-level or Redis-backed cache) to
match docs style; update the sentence mentioning FlowGraphCache in
configuration.mdx accordingly.
---
Duplicate comments:
In `@docs/content/guides/getting-started/configuration.mdx`:
- Line 133: Update the docs entry for cache.cleanup_interval to state it only
applies to the in-memory cache: explicitly mention that cache.cleanup_interval
controls the cleanup interval for in-memory entries and is ignored when
cache.type is set to "redis" (or any non-in-memory backend); reference the
existing config keys cache.cleanup_interval and cache.type in the text so
readers know the limitation and avoid misconfiguration.
- Line 197: Update the sentence that currently reads "When Redis caching is
enabled, Thunder uses Redis native key expiration for TTL handling." by
replacing the word "expiration" with "TTL" so it reads "When Redis caching is
enabled, Thunder uses Redis native key TTL for TTL handling." Locate this text
in the configuration guide (the sentence containing "Redis native key
expiration") and make the single-word replacement to conform to the docs style
guidelines.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 47091ba5-a8c3-4f5b-8d86-d766ff991949
📒 Files selected for processing (1)
docs/content/guides/getting-started/configuration.mdx
There was a problem hiding this comment.
♻️ Duplicate comments (2)
docs/content/guides/getting-started/configuration.mdx (2)
141-141:⚠️ Potential issue | 🟡 MinorFix heading casing to satisfy title-case lint.
Line 141 currently fails
WSO2-IAM.TitleCaseTitles. Update the heading text to match the project’s title-case rule.Suggested fix
-### Per-Cache Overrides with `cache.properties` +### Per-Cache Overrides With `cache.properties`As per coding guidelines,
docs/**: "Consistency: does the style match existing documentation?"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/guides/getting-started/configuration.mdx` at line 141, The heading "Per-Cache Overrides with `cache.properties`" violates the TitleCase rule; update this heading in the file to use the project's title-case style (e.g., "Per-Cache Overrides With `cache.properties`" or whatever exact TitleCase convention the repo uses) so it satisfies WSO2-IAM.TitleCaseTitles; locate the heading text "Per-Cache Overrides with `cache.properties`" and edit only the casing while leaving the inline code token `cache.properties` unchanged.
197-197:⚠️ Potential issue | 🟡 MinorReplace “expiration” with “TTL” to pass Vale wording rules.
Line 197 triggers
WSO2-IAM.TooWordy; use “TTL” phrasing instead.Suggested fix
-When Redis caching is enabled, Thunder uses Redis native key expiration for TTL handling. +When Redis caching is enabled, Thunder uses Redis native key TTL handling.As per coding guidelines,
docs/**: "Consistency: does the style match existing documentation?"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/guides/getting-started/configuration.mdx` at line 197, Update the sentence "When Redis caching is enabled, Thunder uses Redis native key expiration for TTL handling." to replace the word "expiration" with the abbreviation "TTL" to satisfy Vale rules; e.g., reword it to "When Redis caching is enabled, Thunder uses Redis native key TTL handling" (or similar phrasing that uses "TTL" instead of "expiration") so the docs remain consistent with existing documentation style.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/content/guides/getting-started/configuration.mdx`:
- Line 141: The heading "Per-Cache Overrides with `cache.properties`" violates
the TitleCase rule; update this heading in the file to use the project's
title-case style (e.g., "Per-Cache Overrides With `cache.properties`" or
whatever exact TitleCase convention the repo uses) so it satisfies
WSO2-IAM.TitleCaseTitles; locate the heading text "Per-Cache Overrides with
`cache.properties`" and edit only the casing while leaving the inline code token
`cache.properties` unchanged.
- Line 197: Update the sentence "When Redis caching is enabled, Thunder uses
Redis native key expiration for TTL handling." to replace the word "expiration"
with the abbreviation "TTL" to satisfy Vale rules; e.g., reword it to "When
Redis caching is enabled, Thunder uses Redis native key TTL handling" (or
similar phrasing that uses "TTL" instead of "expiration") so the docs remain
consistent with existing documentation style.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 5c77a6e4-cce4-4746-8100-709b80972c83
📒 Files selected for processing (1)
docs/content/guides/getting-started/configuration.mdx
1 participant
Purpose
This pull request updates the cache configuration documentation to include support for Redis-backed caching in addition to the existing in-memory cache. The documentation now explains how to configure Redis as the cache backend and details the relevant settings.
Cache system enhancements:
address,username,password,db, andkey_prefix.Related Issues
Related PRs
Checklist
breaking changelabel added.Security checks
Summary by CodeRabbit