Add OpenTelemetry v2 integration with enhanced features and comprehensive testing #1314
Conversation
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
This commit adds a new OpenTelemetry interceptor (opentelemetryv2) with enhanced capabilities for Temporal workflow integration: Features: - Deterministic ID generation for spans/traces in workflows using TemporalIdGenerator - Context propagation across workflow and activity boundaries - Support for workflow-level span creation via workflow.start_as_current_span - Enhanced interceptor with context propagation to activities and nexus operations - Compatible with existing opentelemetry module while providing additional functionality Implementation: - New TemporalIdGenerator uses workflow.random() for deterministic IDs in workflows - TracingInterceptor handles client, worker, activity, workflow, and nexus operations - Workflow-safe span creation context manager in workflow module - Comprehensive test coverage for trace propagation scenarios This is separate from the OpenAI agents OTEL integration and provides general-purpose OpenTelemetry improvements for Temporal workflows. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
…inting fixes This commit significantly improves the OpenTelemetry v2 integration for the Temporal SDK with the following enhancements: ## Core Features Added: - **Comprehensive test coverage**: Added `test_opentelemetryv2_comprehensive_tracing` covering all workflow operations including activities, local activities, child workflows, timers, signals, updates, queries, and Nexus operations - **Read-only mode detection**: Implemented `workflow.unsafe.is_read_only()` to prevent span ID generation errors during queries and update validators - **Test isolation**: Added pytest fixture to reset OpenTelemetry tracer provider state between test runs - **Span hierarchy validation**: Refactored tests to use `dump_spans()` hierarchy validation for better maintainability ## Linting and Documentation: - Fixed all import path issues for OpenTelemetry ID generators - Added comprehensive docstrings for all public classes and methods - Fixed type annotations and null handling throughout the codebase - Resolved Nexus headers access issues with proper type protocols - Achieved complete pydocstyle compliance ## Technical Improvements: - Enhanced `TemporalSpanProcessor` with proper replay handling - Improved `TemporalIdGenerator` with deterministic workflow-safe random generation - Updated span parenting validation to ensure proper trace relationships - Added max_cached_workflows=0 to all test workers for deterministic behavior 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
cretz
reviewed
Feb 6, 2026
cretz
reviewed
Feb 9, 2026
| def __init__( # type: ignore[reportMissingSuperCall] | ||
| self, | ||
| tracer: opentelemetry.trace.Tracer, | ||
| add_temporal_spans: bool = False, |
Member
There was a problem hiding this comment.
Bump, I think we're losing the functionality of "only create spans if there is a parent". We should either have that functionality (opt-in or opt-out), or document somewhere that if the outbound caller (i.e. client/workflow) didn't start a parent span for, the spans created by the inbound handler (i.e. workflow/activity) will be orphans. This is especially common for schedule-started or CLI-started workflows.
| | None = None, | ||
| id_generator: IdGenerator | None = None, | ||
| span_limits: SpanLimits | None = None, | ||
| ) -> ReplaySafeTracerProvider: |
Member
There was a problem hiding this comment.
Since ReplaySafeTracerProvider is not exported from this opentelemetry module for now, I'd be ok if this just returned TracerProvider
…rovider in a workflow will use a replay safe version. Care should still be taken if creating one from scratch inside a workflow
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
This PR introduces a new OpenTelemetry v2 integration for the Temporal Python SDK with significant enhancements over the existing OpenTelemetry support. The integration provides deterministic tracing, comprehensive test coverage, and improved maintainability.
Key Features Added:
SimplePluginbase classtemporalio.contrib.opentelemetryv2.workflow.start_as_current_span()for user workflow tracingArchitecture Improvements:
TemporalSpanProcessorskips span export during workflow replay to prevent duplicate telemetryworkflow.unsafe.is_read_only()to handle queries and update validators safelyTracingInterceptorcovering all client and worker operationsTesting & Quality:
test_opentelemetryv2_comprehensive_tracingcovering all workflow operations with proper span hierarchy validationdump_spans()for maintainable hierarchy validation similar to existing OpenTelemetry testsTest plan
add_temporal_spans=False) and comprehensive tracing (add_temporal_spans=True)🤖 Generated with Claude Code