Skip to content

Document Temporal Cloud Schedule metrics #5134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dustin-temporal wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Document Temporal Cloud Schedule metrics #5134

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00a581d
Document Temporal Cloud Schedule metrics
dustin-temporal Aug 18, 2026
cd5a618
drop action delay latency metrics for now
dustin-temporal Aug 19, 2026
3eb0b93
clarify rate limit metric role/future
dustin-temporal Aug 20, 2026
74ed0f0
schedule buffer action description generalization
dustin-temporal Aug 20, 2026
606979a
Document metric release stages
dustin-temporal Aug 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/cloud/metrics/openmetrics/api-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ Common labels include:

Each metric has its own set of applicable labels. See the Metrics Reference for complete details.

### Metric Family
### Metric family

@kepe-temporal kepe-temporal Aug 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

family is lowercase?

@dustin-temporal dustin-temporal Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah that's a change to match the docs style guide


A [Metric Family](https://github.com/prometheus/OpenMetrics/blob/main/specification/OpenMetrics.md#metricfamily) may have zero or more metrics. The set of metrics returned will vary based on actual system activity. Metrics only appear in a Metric Family if they were reported during the aggregation window.

Expand Down Expand Up @@ -220,7 +220,15 @@ temporal_cloud_v1_approximate_backlog_count{temporal_namespace="production",temp

`GET /v1/descriptors`

Lists all metric descriptors including metadata, data types, and available dimensions (a.k.a. labels).
Lists all metric descriptors, including help text, available dimensions (labels), and release stages.

Each descriptor includes a `release_stage` field that reports the metric's lifecycle status. The supported values are:

| Value | Description |
| ----- | ----- |
| `public-preview` | The metric is in [Public Preview](/evaluate/development-production-features/release-stages#public-preview) |
| `general-availability` | The metric is in [General Availability](/evaluate/development-production-features/release-stages#general-availability) |
| `deprecated` | The metric is deprecated |

#### Query parameters

Expand Down Expand Up @@ -258,7 +266,8 @@ Response:
"temporal_workflow_type",
"temporal_task_queue",
"region"
]
],
"release_stage": "general-availability"
}
]
}
Expand Down
19 changes: 14 additions & 5 deletions docs/cloud/metrics/openmetrics/metrics-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,25 +667,35 @@ Operations throttled due to rate limits per second. See [Monitoring Trends Again

#### temporal\_cloud\_v1\_schedule\_action\_success\_count

Successfully executed scheduled workflows per second.
Successful scheduled executions per second.

@kepe-temporal kepe-temporal Aug 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The source is from https://github.com/temporalio/temporal/blob/767162845ef95cb5e4f7157fb980f9c5ce4cbf12/common/metrics/metric_defs.go#L1530, in my opinion this sort of implies successful scheduled actions but its more successful start workflow executions. might be minor and not matter.

@dustin-temporal dustin-temporal Aug 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
Successful scheduled executions per second.
Successful scheduled start Workflow executions per second.

@kepe-temporal what do you think of this?

@kepe-temporal kepe-temporal Aug 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry, after thinking about it more, I would like to retract my comment and have it be more general, I think Successful scheduled executions per second. is better.


**Type**: Rate

#### temporal\_cloud\_v1\_schedule\_buffer\_overruns\_count

The rate of schedule buffer overruns when using `BUFFER_ALL` overlap policy.
Scheduled executions dropped per second because the Schedule's internal Action buffer is full.

**Type**: Rate

#### temporal\_cloud\_v1\_schedule\_missed\_catchup\_window\_count

The rate of missed schedule executions outside the catchup window.
Scheduled executions permanently dropped per second because they fell outside the Catchup Window. This metric is not emitted for backfills.

**Type**: Rate

#### temporal\_cloud\_v1\_schedule\_rate\_limited\_count

The rate of scheduled workflows delayed due to rate limiting.
[DEPRECATED] Scheduled executions delayed per second due to rate limiting. This metric is in the process of being replaced by standard request per second rate limit monitoring with dynamic scaling. This metric will be removed when this change is rolled out to all of Temporal Cloud.

**Type**: Rate

#### temporal\_cloud\_v1\_schedule\_overlap\_skipped\_count

Schedule executions dropped per second due to the overlap policy. This metric is emitted for `SKIP` when another execution is running or already selected, and for `BUFFER_ONE` when its single buffered slot is occupied. It can also be emitted during backfills that use `SKIP` or `BUFFER_ONE`. A sustained rate can indicate that executions are generated faster than they complete.

| Label | Description |
| ----- | ----- |
| `schedule_overlap_policy` | The overlap policy that caused the execution to be dropped |

**Type**: Rate

Expand Down Expand Up @@ -782,4 +792,3 @@ Does not include the `region` label. Provisioned capacity is scoped to the Names
:::

**Type**: Value