Skip to content

feat(observability): added section for using global tags across SDKs - #5270

Draft
flippedcoder wants to merge 3 commits into
mainfrom
mm/global-tags
Draft

feat(observability): added section for using global tags across SDKs#5270
flippedcoder wants to merge 3 commits into
mainfrom
mm/global-tags

Conversation

@flippedcoder

Copy link
Copy Markdown
Contributor

What does this PR do?

This adds a section on each SDK's observability page to describe globalTags.

Notes to reviewers

Copilot AI balanced review requested due to automatic review settings September 8, 2026 18:39
@vercel

vercel Bot commented Sep 8, 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 9, 2026 6:21pm UTC

Request Review

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

📖 Docs PR preview links

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.

🟡 Changes recommended

The documentation scope, placement, title, and incident narrative need revision before approval.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Adds Python SDK documentation for applying low-cardinality global tags to emitted metrics.

Changes:

  • Documents TelemetryConfig.global_tags with an example.
  • Adds tag-selection and diagnostic guidance.
  • Updates the page title and table-of-contents depth.
File summaries
File Description
docs/develop/python/platform/observability.mdx Adds global-tag guidance. Retain the Python title qualifier, align the stated cross-SDK scope, move shared policy to Best practices, and tighten the incident narrative.
Review details

Suppressed comments (1)

docs/develop/python/platform/observability.mdx:75

  • This organization-wide tag taxonomy and the incident/cost-allocation discussion below are SDK-independent prescriptive guidance. The information architecture says Develop pages should stay focused on accomplishing a task in a specific language, while organizational standards belong under Best practices (readme/INFORMATION-ARCHITECTURE.md:21-29,71-75). Move this shared guidance to a Best practices page and link to it here, leaving only the Python API and example on this page; otherwise the same policy will be duplicated across every SDK page.
#### Choose a tag set

Tags group metrics only when every Worker across your organization emits the same keys, so decide on the set before teams adopt it.
These five suit most organizations:
  • Files reviewed: 1/1 changed files
  • Comments generated: 3
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/develop/python/platform/observability.mdx
Comment thread docs/develop/python/platform/observability.mdx
Comment thread docs/develop/python/platform/observability.mdx Outdated
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.

2 participants