Skip to content

Document Temporal Cloud Schedule metrics - #5134

Draft
dustin-temporal wants to merge 5 commits into
mainfrom
codex/docs-openmetrics-schedule-metrics
Draft

Document Temporal Cloud Schedule metrics#5134
dustin-temporal wants to merge 5 commits into
mainfrom
codex/docs-openmetrics-schedule-metrics

Conversation

@dustin-temporal

@dustin-temporal dustin-temporal commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Summary

  • update descriptions for the existing Temporal Cloud Schedule metrics
  • document the schedule overlap skip rate and its overlap-policy label
  • document metric release stages in the OpenMetrics descriptors API

Validation

  • vale --config .vale-ci.ini docs/cloud/metrics/openmetrics/api-reference.mdx docs/cloud/metrics/openmetrics/metrics-reference.mdx passes with zero findings
  • git diff --check passes
  • the Docusaurus build parses the updated pages and reaches static generation, then the local build fails on 12 unrelated AI Cookbook pages with missing generated metadata

┆Attachments: EDU-6981 Document Temporal Cloud Schedule metrics

Copilot AI balanced review requested due to automatic review settings August 18, 2026 19:56
@vercel

vercel Bot commented Aug 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview Aug 20, 2026 6:40pm

Request Review

Copilot AI left a comment

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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

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

### Metric Family
### Metric family

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?

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

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

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

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.

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?

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.

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