Docs - auto retry (timeout and OOM) #14701
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
WalkthroughThe changes introduce a new informational callout in the documentation regarding error handling for Out of Memory (OOM) and Timeout errors. This callout clarifies that workflows will not automatically retry in these cases and recommends adjusting configuration settings if such errors are frequent. The existing documentation structure remains largely unchanged, with the new content integrated into the relevant sections while maintaining consistency in formatting. Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs-v2/pages/workflows/settings.mdx (1)
48-52: Enhance the callout with specific configuration guidance.While the callout provides important information about OOM and timeout errors, it could be more helpful by including:
- Direct links to the relevant configuration sections
- Current default limits
- Specific steps to adjust these settings
Consider updating the callout with more detailed information:
<Callout type="info"> **Out of Memory and Timeout Errors** -Pipedream will not automatically retry if an execution fails due to an Out of Memory (OOM) error or a timeout. If you encounter these errors frequently, consider increasing the configuration settings for your workflow. +Pipedream will not automatically retry if an execution fails due to an Out of Memory (OOM) error or a timeout. If you encounter these errors frequently: + +- For OOM errors: Increase your workflow's [memory](#memory) from the default {process.env.MEMORY_LIMIT} (up to {process.env.MEMORY_ABSOLUTE_LIMIT}) +- For timeout errors: Extend the [execution timeout limit](#execution-timeout-limit) beyond the default limit </Callout>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs-v2/pages/workflows/settings.mdx(1 hunks)
🔇 Additional comments (2)
docs-v2/pages/workflows/settings.mdx (2)
48-52: LGTM! Well-placed callout.
The placement of this callout before the auto-retry section is logical and helps users understand important limitations before diving into the feature details.
48-52: Verify environment variable configuration.
Let's ensure the documentation renders correctly by verifying the environment variables used for memory and timeout limits.
✅ Verification successful
Documentation is consistent with memory and timeout configuration
The documentation accurately reflects the memory and timeout configuration. The environment variables are properly defined in docs-v2/next.config.js:
MEMORY_LIMIT: "256MB"(default memory)MEMORY_ABSOLUTE_LIMIT: "10GB"(maximum memory)
The documentation consistently references these limits throughout, particularly in:
- Workflow settings (
/workflows/settings.mdx) - Troubleshooting guide (
/troubleshooting.mdx) - Limits documentation (
/limits.mdx)
The documentation also correctly explains:
- The default memory configuration and its impact
- How to increase memory limits
- The relationship between memory and credits usage
- Proper handling of OOM and timeout errors
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for environment variable usage consistency in the documentation
# Search for environment variable references
echo "Checking environment variable usage:"
rg -i "process\.env\." --type mdx
# Check if the variables are defined in any configuration files
echo -e "\nChecking environment variable definitions:"
fd -e json -e js -e ts -e env . | xargs rg "MEMORY_LIMIT|MEMORY_ABSOLUTE_LIMIT"
Length of output: 437
Script:
#!/bin/bash
# Let's check for any mentions of memory limits, timeouts, and related configuration in the documentation
echo "Checking for memory and timeout related content:"
rg -i "memory|timeout|configuration settings" docs-v2/pages/
# Also check for any other callouts about errors or limits
echo -e "\nChecking for related error callouts:"
rg -A 3 -B 3 "<Callout.*error|limit" docs-v2/pages/
Length of output: 102038
2 participants
WHY
Summary by CodeRabbit