Add troubleshooting guide for missed Schedule Actions#4471
Open
dustin-temporal wants to merge 1 commit intomainfrom
Open
Add troubleshooting guide for missed Schedule Actions#4471dustin-temporal wants to merge 1 commit intomainfrom
dustin-temporal wants to merge 1 commit intomainfrom
Conversation
Documents the workflow for diagnosing why a Schedule did not fire: alert on the missed catchup window metric (temporal_cloud_v1 for Cloud, schedule_missed_catchup_window for self-hosted), enumerate Schedules with ListSchedules, then inspect DescribeSchedule.info.missedCatchupWindow per Schedule to identify the affected one. Includes root-cause cross-checks against rate-limit and buffer-overrun metrics, plus remediation guidance. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links |
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
1 participant
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.
Summary
Adds
docs/troubleshooting/schedule-missed-actions.mdxdocumenting the workflow for diagnosing why a Schedule did not fire:temporal_cloud_v1_schedule_missed_catchup_window_countfor Cloud,schedule_missed_catchup_windowfor self-hosted) grouped by Namespace.temporal schedule listto produce candidate Schedule Ids.temporal schedule describeper Schedule and look for non-zeroinfo.missedCatchupWindowto identify the affected Schedule.The metric is Namespace-scoped with no per-Schedule label, so the list + describe fan-out is currently the only path from alert to affected Schedule.
Why
The existing docs describe the Catchup Window as a Schedule Spec option and document the metrics individually, but there is no page that ties them together into an investigation workflow. Users receiving an alert on
...missed_catchup_window_counthave no guided path to find out which Schedule was affected.Changes
docs/troubleshooting/schedule-missed-actions.mdxdocs/troubleshooting/index.mdx(added link to the new page)sidebars.js(added the new page under Troubleshooting)Checklist
IdnotID)sidebars.jsupdatedyarn buildpasses (not yet run - draft)🤖 Generated with Claude Code
┆Attachments: EDU-6249 Add troubleshooting guide for missed Schedule Actions