Align metrics tag/label terminology; refresh stale GitHub source links - #5010
Open
Duncanma wants to merge 5 commits into
Open
Align metrics tag/label terminology; refresh stale GitHub source links#5010Duncanma wants to merge 5 commits into
Duncanma wants to merge 5 commits into
Conversation
…OpenMetrics)
Our docs used three different words for the same metrics dimension in
different places: "tag" (SDK/self-hosted-Server docs, matching the real
Go/Java SDK APIs like WithTags/.tagged() and the Server's tags/excludeTags
config keys), "label" (Temporal Cloud's OpenMetrics docs, matching what
OpenMetrics/PromQL/Grafana actually call it - OpenMetrics never uses
"tag" at all), and even "key" in a few spots on the same reference page.
- docs/references/sdk-metrics.mdx: normalize the stray "key(s)" (4
places) and one stray "label" to "tag(s)", matching the page's
dominant convention and what bin/check-metrics-reference.js expects
in its "Tags:" line parsing (verified the check still passes).
- docs/design-patterns/retry-metrics.mdx: this page mixed both terms
in one section ("Add dimension labels" heading, "Add labels (tags)"
body, "adds default labels" prose) right next to Go/Java code
samples calling the literal WithTags/.tagged() API. Normalized to
"tags" throughout to match the code.
- docs/glossary.md: added a Tag entry bridging the two terms, since
no entry existed for either before.
- docs/cloud/metrics/openmetrics/api-reference.mdx: cross-linked the
Labels section back to the new glossary entry so the bridge works
from both directions.
Left docs/develop/java/activities/basics.mdx's "Prometheus may ignore
metrics with tags..." as-is per feedback - out of scope for this pass.
Short :::note near the top of both pages pointing to the new glossary entry, so a reader hits the terminology bridge before they get to the per-metric "Tags:" lines.
Two ::: admonitions back-to-back isn't the style here - merge the note into the page's existing top info block instead of stacking a second callout right after it.
…ic source links per SDK. - Move sdk-java temporal-opentracing and temporal-spring-ai README links to contrib/. - Replace renamed sdk-core repo with sdk-rust.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| For more information, see the Temporal [OpenTracing module](https://github.com/temporalio/sdk-java/blob/master/temporal-opentracing/README.md). | ||
| For more information, see the Temporal [OpenTracing module](https://github.com/temporalio/sdk-java/blob/main/contrib/temporal-opentracing/README.md). | ||
|
|
||
| ### Context Propagation Over Nexus Operation Calls |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Context Propagation Over Nexus Operation Calls' should use sentence-style capitalization.
| - [Rust SDK GitHub](https://github.com/temporalio/sdk-core/tree/master/crates/sdk) | ||
| - [Rust SDK GitHub](https://github.com/temporalio/sdk-rust/tree/main/crates/sdk) | ||
|
|
||
| ### Get Connected with the Temporal Rust Community |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Temporal.Headings] 'Get Connected with the Temporal Rust Community' should use sentence-style capitalization.
Contributor
📖 Docs PR preview links
|
Duncanma
enabled auto-merge (squash)
July 31, 2026 23:13
lennessyy
approved these changes
Jul 31, 2026
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.
Metrics terminology: tag vs. label
Prompted by comparing our metrics docs against the OpenMetrics spec, which exclusively uses "label" ("Metrics are defined by a unique LabelSet within a MetricFamily") and never says "tag."
Our docs had drifted into two internally-consistent but mutually-inconsistent islands, plus a couple of outright bugs:
WithTags,.tagged()) and the Server'stags/excludeTagsconfig keys — this is a real naming constraint, not just a word choice, so it's staying as "tag."WithTags/.tagged()API — normalized to "tags" to match the code.Changes:
Tagentry to glossary.md bridging the two terms, since neither had an entry before.### Labelssection so the bridge works in both directions.sdk-metrics.mdxandcluster-metrics.mdx.Left docs/develop/java/activities/basics.mdx's Prometheus/tags wording as-is — out of scope for this pass.
GitHub source link cleanup
Refreshed several stale
master-branch GitHub links tomain/trunk branches, replaced the renamedsdk-corerepo withsdk-rust, moved two Java SDK README links to their newcontrib/subdirectory, and consolidatedsdk-metrics.mdx's per-SDK metric source links into one clearer bullet list (Core/Go/Java).Testing
node bin/check-metrics-reference.jspasses (48 metrics consistent) — confirms the terminology normalization didn't break the SDK metrics reference's internal-consistency check.vale --config .vale-ci.inipasses with 0 errors/warnings across all changed files.yarn buildsucceeds — no broken links or anchors, including the new/glossary#taglinks.yarn testpasses except for one pre-existing, unrelated failure (ReleaseNoteHeader featureName overrides explicit type when mapped, referencing a staleserverlessWorkerskey that no longer exists insrc/constants/featureReleaseTypes.js) — already tracked separately.┆Attachments: EDU-6864 Align metrics tag/label terminology; refresh stale GitHub source links