Skip to content

Conversation

@js07
Copy link
Collaborator

@js07 js07 commented Nov 15, 2024

This pull request includes a small update to the docs-v2/pages/troubleshooting.mdx file. The change adds a new section to the troubleshooting documentation to explain why a trigger might be paused and how to resolve it.

Documentation update:

  • docs-v2/pages/troubleshooting.mdx: Added a new section titled "Why is my trigger paused?" explaining the automatic disabling of sources with a 100% error rate on the Free tier and providing troubleshooting steps.

Summary by CodeRabbit

  • New Features

    • Introduced a new troubleshooting section titled "Why is my trigger paused?" to assist users in understanding and resolving issues related to paused triggers on the Free tier.
  • Documentation

    • Enhanced the troubleshooting document's comprehensiveness by providing guidance on checking source logs and reconnecting accounts to resolve trigger issues.

@vercel
Copy link

vercel bot commented Nov 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 15, 2024 11:20pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
pipedream-docs ⬜️ Ignored (Inspect) Nov 15, 2024 11:20pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Nov 15, 2024 11:20pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The pull request introduces a new section titled "Why is my trigger paused?" to the troubleshooting.mdx document. This section addresses the automatic disabling of sources on the Free tier due to a 100% error rate over five days. It offers troubleshooting guidance, including checking source logs and suggestions for reconnecting accounts to resolve issues. The overall structure of the document remains unchanged, with no deletions or significant reordering of existing content.

Changes

File Change Summary
docs-v2/pages/troubleshooting.mdx Added a new section "Why is my trigger paused?" addressing error rates and troubleshooting steps.

Possibly related PRs

  • Tips to reduce latency #13996: This PR adds a new section to the same troubleshooting.mdx file, providing users with tips to enhance workflow performance, which is related to troubleshooting user issues similar to the new section added in the main PR.
  • Add $.flow.trigger #13997: This PR also updates troubleshooting.mdx by adding a section on invoking another workflow, which is relevant as it addresses user queries related to workflow management, similar to the troubleshooting focus of the main PR.

Suggested reviewers

  • dylburger

Poem

In the land of code where rabbits play,
A new section blooms, brightening the day.
"Why is my trigger paused?" it does say,
With tips and logs to guide the way.
Hop along, dear users, don’t delay!
Troubleshooting’s now a hop, skip, and sway! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c543ef3 and f64fbdc.

📒 Files selected for processing (1)
  • docs-v2/pages/troubleshooting.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs-v2/pages/troubleshooting.mdx

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
docs-v2/pages/troubleshooting.mdx (1)

81-85: LGTM! Consider enhancing the section with more details.

The new section effectively communicates the trigger pause policy and basic troubleshooting steps. However, consider the following enhancements for better user experience:

 ## Why is my trigger paused?
 
-On the Free tier, Pipedream automatically disables sources with a 100% error rate in the past 5 days.
+<Callout type="warning">
+On the Free tier, Pipedream automatically disables sources that experience a 100% error rate over the past 5 days. This helps prevent unnecessary resource usage from continuously failing workflows.
+</Callout>
 
-To troubleshoot, you can look at the errors in the [source](/sources/) logs, and may need to reconnect your account and reenable the source for it to run again.
+To troubleshoot:
+1. Check the errors in your [source](/sources/) logs to identify the root cause
+2. Common fixes include:
+   - Reconnecting your account if authentication has expired
+   - Updating API keys if they're invalid
+   - Verifying the connected account has necessary permissions
+3. After addressing the issue, re-enable the source to resume operation
+
+Consider upgrading to a [paid tier](https://pipedream.com/pricing) for additional reliability features and support.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 973f4f2 and 3cbf01b.

📒 Files selected for processing (1)
  • docs-v2/pages/troubleshooting.mdx (1 hunks)

Copy link
Contributor

@malexanderlim malexanderlim left a comment

Choose a reason for hiding this comment

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

"Pipedream automatically disables sources with a 100% error rate in the past 5 days for accounts on the Free plan.

To troubleshoot, you can look at the errors in the source logs, and may need to reconnect your account and re-enable the source for it to run again. If the issue persists, please reach out in the community."

@js07 js07 merged commit c5eb625 into master Nov 20, 2024
7 checks passed
@js07 js07 deleted the docs-trigger-paused branch November 20, 2024 20:51
@coderabbitai coderabbitai bot mentioned this pull request Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants