Skip to content

Document Metrics Read-Only role permissions - #5345

Draft
dustin-temporal wants to merge 2 commits into
mainfrom
codex/docs-metrics-read-only-role
Draft

dustin-temporal wants to merge 2 commits into
mainfrom
codex/docs-metrics-read-only-role

Conversation

@dustin-temporal

@dustin-temporal dustin-temporal commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • add the Metrics Read-Only role to the account-level role overview and permissions reference
  • make the OpenMetrics guide the canonical source for the role scope and API key requirements
  • link the permissions reference, Service Accounts page, and API key rotation guidance to that canonical section
  • clarify that the role grants OpenMetrics read access but no other permissions

Why

Internal feedback identified customer confusion: the API key documentation said every Service Account could rotate its own keys regardless of permissions, while the core role pages did not mention Metrics Read-Only or its narrower authorization model.

Validation

  • vale --config .vale-ci.ini reports no errors or warnings for all five changed files
  • the only new Vale suggestion is a false positive on the official Metrics Read-Only role name in a heading
  • npm run build reached Docusaurus but the existing local dependency installation is missing @temporalio-web/consent-banner; no MDX-specific error was reported

@vercel

vercel Bot commented Sep 16, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
temporal-documentation Ready Ready Preview Sep 16, 2026 3:03pm UTC

Request Review

@github-actions

github-actions Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links


Temporal Cloud's [OpenMetrics](https://openmetrics.io/) endpoint provides operational metrics for your Temporal Cloud workloads in industry-standard Prometheus format, enabling comprehensive monitoring across Namespaces, Workflows, and Task Queues with your existing observability stack.

## Metrics Read-Only role {/* #metrics-read-only-role */}

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.

📝 [vale] <Temporal.Headings> reported by reviewdog 🐶
'Metrics Read-Only role *******************************' should use sentence-style capitalization.

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.

1 participant