Add Cloud metrics Quickstart and clarify integration setup#4577
Open
dustin-temporal wants to merge 4 commits into
Open
Add Cloud metrics Quickstart and clarify integration setup#4577dustin-temporal wants to merge 4 commits into
dustin-temporal wants to merge 4 commits into
Conversation
- Add a top-of-page Quickstart to /cloud/metrics/openmetrics/ that walks users through Service Account creation, API key generation, endpoint verification, and tool selection in 4 numbered steps. Calls out the Account Owner / Global Admin requirement for granting the Metrics Read-Only role. - Add a callout explaining that metrics.temporal.io is for scrapers, not browsers, since visiting the URL directly returns 'Jwt is missing'. - Point /cloud/metrics/ root page directly at the Quickstart so new users reach actionable steps in one click instead of two. - Inline the Grafana Cloud setup steps (API key, allowed hosts) so users no longer ping-pong between Temporal and Grafana docs to find the basics. - Add a direct deep link to https://app.datadoghq.com/integrations and the Datadog setup steps (search integration, paste API key, optional namespace filter) so users do not have to hunt for the integration tile in DD. - Update the API key authentication section to link to the new Quickstart instead of the migration guide, so first-time users no longer have to read a v0-to-v1 migration document to get started.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links |
ClickStack and New Relic previously had only a one-line description and a link to the vendor's docs. Add concrete numbered steps so users can configure both without bouncing between docs sites, matching the pattern now used for Datadog and Grafana Cloud. - ClickStack: keep existing intro paragraph; add 5 steps covering the temporal.key file, OTel collector config, Docker Compose mounts, HyperDX verification, and pre-built dashboard import. - New Relic: add 4 steps covering infrastructure-agent install, nri-flex config file placement and API key substitution, agent restart, and pre-built dashboard install. Includes a callout noting the integration needs a host running the New Relic infrastructure agent.
Based on feedback from Kevin Woo: the existing Detecting Resource Exhaustion section covers the concept but is hard to reach from the metrics reference, and it does not make clear that account-limit throttling is the more important signal to monitor. - Rewrite the Detecting Resource Exhaustion section in service-health.mdx to explain that exhaustion is a burst signal (gracefully retried), call out the operation label as the investigation hook now that resource_exhausted_cause is gone, and cross-link to Monitoring Trends Against Limits. - Add a lead-in paragraph to Monitoring Trends Against Limits explaining it is the more important throttling signal and contrasting it with resource exhaustion. - Update the temporal_cloud_v1_resource_exhausted_error_count entry in the metrics reference to point users at both the throttle metrics and the service-health guidance. - Add a one-line pointer to Monitoring Trends Against Limits from the three throttle metric entries (service_request_throttled_count, total_action_throttled_count, operations_throttled_count) so a user who first sees throttling in a dashboard can reach the alerting guidance.
kevinawoo
approved these changes
May 16, 2026
Member
kevinawoo
left a comment
kevinawoo
left a comment
There was a problem hiding this comment.
LGTM! Thanks for adding the resource exhausted vs hitting limits
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
2 participants
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
Updates
/cloud/metrics/and/cloud/metrics/openmetrics/based on feedback from a PM hands-on testing session with the OpenMetrics endpoint and Datadog/Grafana integrations.Changes:
/cloud/metrics/openmetrics/with four numbered steps (create Service Account → generate API key → verify endpoint → configure tool).metrics.temporal.iois a scrape endpoint, not a browser URL. Explains theJwt is missingerror testers hit when they opened it directly./cloud/metrics/root page now links directly to the Quickstart from the top, so first-time users reach actionable steps in one click.metrics-integrations.mdxnow documents the API key field and themetrics.temporal.ioallowed-hosts step inline, instead of bouncing users to Grafana docs that don't cover it.https://app.datadoghq.com/integrationsand concrete setup steps (search the catalog, paste API key, optional namespace filter).Why
PMs hands-on-tested the full flow and surfaced these issues:
Out of scope (filed separately or deferred)
https://metrics.temporal.io/(docs) andhttps://metrics.temporal.io/v1/metrics(Cloud UI) - deferred until we canonicalize one form.Checklist
/cloud/metrics/openmetrics,#quickstart,#prometheus-grafana){#prometheus-grafana}anchor on the heading the Quickstart links toyarn build(skipped here; opening as draft for review)┆Attachments: EDU-6372 Add Cloud metrics Quickstart and clarify integration setup