Add pluggable instrumentation interface and request_id logging#1693
Uh oh!
There was an error while loading. Please reload this page.
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 pluggable instrumentation interface with a token-based API for the MCP Python SDK, enabling OpenTelemetry and other observability integrations as requested in #421.
Key Innovation: Token-Based API
The instrumentation interface uses a token-based approach that solves a critical design problem:
This design enables instrumenters to maintain state (like OpenTelemetry spans) without external storage or side-channels, addressing feedback from the community on API design best practices.
Changes
Core Interface
Instrumenterprotocol with token-based hooksNoOpInstrumenteras default implementation with minimal overheadIntegration
instrumenterparameter toServerSessionandClientSessionconstructorsServer._handle_request()to track:request_idto loggingextrafields for correlationOpenTelemetry Example
OpenTelemetryInstrumenterimplementation inexamples/opentelemetry_instrumentation.pyTesting
request_idis consistent across lifecycleDocumentation
docs/instrumentation.mdwith:Benefits
spans ={}dictionariesFollow-up Work
pip install mcp[opentelemetry])params._meta.traceparentpropagationFixes#421