Worker Versioning GA Docs Edits #4148
Draft
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
- Add new `worker-tuning-reference.mdx` with SDK defaults organized by resource type (compute, memory, IO) and metrics reference - Add to sidebar navigation after worker-performance - Add cross-references from worker-performance.mdx and workers.mdx This provides a quick reference companion to the comprehensive worker-performance guide, making it easy to look up SDK-specific defaults and relevant metrics by resource category. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
|
|
||
| ## How a Worker works | ||
|
|
||
| Workers poll a [Task Queue](/workers#task-queues) in Temporal Cloud or a self-hosted Temporal Service, execute Tasks, and respond with the result. |
Contributor
There was a problem hiding this comment.
Suggested change
| Workers poll a [Task Queue](/workers#task-queues) in Temporal Cloud or a self-hosted Temporal Service, execute Tasks, and respond with the result. | |
| Workers poll a [Task Queue](/task-queue) in Temporal Cloud or a self-hosted Temporal Service, execute Tasks, and respond with the result. |
| Workers poll a [Task Queue](/workers#task-queues) in Temporal Cloud or a self-hosted Temporal Service, execute Tasks, and respond with the result. | ||
|
|
||
| ``` | ||
| ┌─────────────────┐ Poll for Tasks ┌─────────────────┐ |
Contributor
There was a problem hiding this comment.
Suggested change
| ┌─────────────────┐ Poll for Tasks ┌─────────────────┐ | |
| ┌─────────────────┐ Poll for Tasks ┌──────────────────┐ |
|
|
||
| ``` | ||
| ┌─────────────────┐ Poll for Tasks ┌─────────────────┐ | ||
| │ Worker │ ◄─────────────────────── │ Temporal Service│ |
Contributor
There was a problem hiding this comment.
Suggested change
| │ Worker │ ◄─────────────────────── │ Temporal Service│ | |
| │ - Worker │ ◄─────────────────────── │ Temporal Service │ |
| ┌─────────────────┐ Poll for Tasks ┌─────────────────┐ | ||
| │ Worker │ ◄─────────────────────── │ Temporal Service│ | ||
| │ - Workflows │ │ │ | ||
| │ - Activities │ ─────────────────────► │ │ |
Contributor
There was a problem hiding this comment.
Suggested change
| │ - Activities │ ─────────────────────► │ │ | |
| │ - Activities │ ───────────────────────► │ │ |
| │ Worker │ ◄─────────────────────── │ Temporal Service│ | ||
| │ - Workflows │ │ │ | ||
| │ - Activities │ ─────────────────────► │ │ | ||
| └─────────────────┘ Respond with results └─────────────────┘ |
Contributor
There was a problem hiding this comment.
Suggested change
| └─────────────────┘ Respond with results └─────────────────┘ | |
| └─────────────────┘ Respond with results └──────────────────┘ |
| | Metric | Description | | ||
| |--------|-------------| | ||
| | `poll_success_sync_count` | Sync match rate (Tasks immediately assigned to Workers) | | ||
| | `approximate_backlog_count` | Approximate number of Tasks in a Task Queue | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `approximate_backlog_count` | Approximate number of Tasks in a Task Queue | | |
| | [`approximate_backlog_count`](/cloud/metrics/openmetrics/metrics-reference#temporal_cloud_v1_approximate_backlog_count) | Approximate number of Tasks in a Task Queue | |
Contributor
There was a problem hiding this comment.
Take a look and make sure I'm linking to the same thing you're describing here.
|
|
||
| | Metric | Description | | ||
| |--------|-------------| | ||
| | `long_request_failure` | Failures for long-running operations (polling, history retrieval) | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `long_request_failure` | Failures for long-running operations (polling, history retrieval) | | |
| | [`long_request_failure`](/references/sdk-metrics#long_request_failure) | Failures for long-running operations (polling, history retrieval) | |
| | Metric | Description | | ||
| |--------|-------------| | ||
| | `long_request_failure` | Failures for long-running operations (polling, history retrieval) | | ||
| | `request_failure` | Failures for standard operations (Task completion responses) | |
Contributor
There was a problem hiding this comment.
Suggested change
| | `request_failure` | Failures for standard operations (Task completion responses) | | |
| | [`request_failure`](/references/sdk-metrics#request_failure) | Failures for standard operations (Task completion responses) | |
|
|
||
| The right versioning behavior depends on how long your Workflows run relative to your deployment frequency. | ||
|
|
||
| ### Decision guide {#decision-guide} |
Contributor
There was a problem hiding this comment.
This section is great!
|
|
||
| :::caution Current Limitations | ||
|
|
||
| - **Lazy moving only:** Workflows must wake up naturally to receive the Continue-as-New suggestion. |
Contributor
There was a problem hiding this comment.
What does "wake up naturally" mean here?
Contributor
Author
There was a problem hiding this comment.
Good question, they have to be actually invoked by the workflow executing a step, the point is that the continue as new signal itself won't wake up a sleeping workflow
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.
This PR Contains 3 changes:
Workflow use-case specific versioning guidance
Introducing Upgrade-on-Continue as New Public Preview
Adds "Worker Tuning" high level guidance