Implement planned topic: 0022-opentelemetry-plugins#243
Merged
Conversation
skill-temporal-developer-updater
Bot
requested a review
from a team
as a code owner
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Both observability.md files advertised "tracing" but had no tracing section and never linked to the OTel integration docs. Add a concise Distributed Tracing (OpenTelemetry) section to each, surface the trace/log/metric correlation, and cross-link so the OTel <-> observability relationship is bidirectional. Deep API stays canonical in integrations/opentelemetry.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Mirror the lean, example-driven style now used in the Python OTel doc: fold the Public API / Constructor options / Span names tables into inline comments and prose, compress propagator customization to a one-liner, and keep the log/metric correlation tie-in. Update the observability.md pointer so it no longer promises tables that were removed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Reduce both OTel rows to a purpose-only description, dropping mechanism detail (plugin names, interceptors, sinks, propagation specifics). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The TypeScript material needs more work, so split it out (now on branch feat/ts-otel). This leaves PR #243 scoped to the Python OpenTelemetry integration only: removes the TS integration reference, reverts the TS observability tracing section, and drops the TS row from the catalog. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Donald Pinckney <donald_pinckney@icloud.com>
| @@ -0,0 +1,76 @@ | |||
| # Temporal OpenTelemetry Integration (Python) | |||
Collaborator
There was a problem hiding this comment.
This file provides very little value over what is added to observability.md. Consider just deleting it?
Collaborator
There was a problem hiding this comment.
Decided to cut this file and move it just into observability.md
tconley1428
reviewed
Jun 5, 2026
| ## Common mistakes | ||
|
|
||
| - **Registering the same plugin on both Client and Worker.** Register on the Client only; Workers inherit. | ||
| - **Calling `Client.connect` before `opentelemetry.trace.set_tracer_provider(provider)`.** With `OpenTelemetryPlugin`, the workflow interceptor factory raises `ValueError("When using OpenTelemetryPlugin, the global trace provider must be a ReplaySafeTracerProvider. Use init_tracer_provider to create one.")`. |
There was a problem hiding this comment.
"init_tracer_provider" is actually a bug in the error message. It got renamed.
tconley1428
reviewed
Jun 5, 2026
| - **Registering the same plugin on both Client and Worker.** Register on the Client only; Workers inherit. | ||
| - **Calling `Client.connect` before `opentelemetry.trace.set_tracer_provider(provider)`.** With `OpenTelemetryPlugin`, the workflow interceptor factory raises `ValueError("When using OpenTelemetryPlugin, the global trace provider must be a ReplaySafeTracerProvider. Use init_tracer_provider to create one.")`. | ||
| - **Building a plain `opentelemetry.sdk.trace.TracerProvider` and passing it to `set_tracer_provider`.** `OpenTelemetryPlugin` requires `ReplaySafeTracerProvider` — build it via `create_tracer_provider(...)`. | ||
| - **Adding `with_passthrough_modules("opentelemetry")` to a `SandboxedWorkflowRunner` manually.** The plugin already does this. |
There was a problem hiding this comment.
Doesn't hurt though, so not sure it qualifies as a common mistake.
Remove the standalone references/python/integrations/opentelemetry.md file and fold its unique content (Common mistakes, workflow custom-span example) into the Distributed Tracing section of observability.md. Repoint the integrations catalog row at the observability section. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Adds support for Python's OpenTelemetryPlugin. Only does Python for now, because designs are kinda all different between languages. Need to think more about what the approach should be for those.