-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Slim ServerMiddleware to (ctx, call_next) and add OpenTelemetryMiddleware
#2941
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| from __future__ import annotations | ||
|
|
||
| from typing import Any | ||
|
|
||
| from opentelemetry.trace import SpanKind, StatusCode | ||
| from pydantic import ValidationError | ||
|
|
||
| from mcp.server.context import CallNext, HandlerResult, ServerMiddleware, ServerRequestContext | ||
| from mcp.shared._otel import extract_trace_context, otel_span | ||
| from mcp.shared.exceptions import MCPError | ||
|
|
||
|
|
||
| class OpenTelemetryMiddleware(ServerMiddleware[Any]): | ||
| """Context-tier middleware that wraps each inbound message in an OpenTelemetry span. | ||
|
|
||
| Span name `"MCP handle <method> [<target>]"`, `mcp.method.name` attribute, W3C | ||
| trace context extracted from `params._meta` (SEP-414), and an ERROR status if | ||
| the handler raises. Requests and notifications both get a span; | ||
| `jsonrpc.request.id` is set only when `ctx.request_id` is present (notifications | ||
| have none). | ||
| """ | ||
|
|
||
| async def __call__(self, ctx: ServerRequestContext[Any, Any], call_next: CallNext) -> HandlerResult: | ||
| name = ctx.params.get("name") if ctx.params else None | ||
| target = name if isinstance(name, str) else None | ||
|
|
||
| attributes: dict[str, Any] = {"mcp.method.name": ctx.method} | ||
| if ctx.request_id is not None: | ||
| attributes["jsonrpc.request.id"] = str(ctx.request_id) | ||
|
|
||
| with otel_span( | ||
| name=f"MCP handle {ctx.method}{f' {target}' if target else ''}", | ||
| kind=SpanKind.SERVER, | ||
| attributes=attributes, | ||
| context=extract_trace_context(ctx.meta), | ||
| record_exception=False, | ||
| set_status_on_exception=False, | ||
| ) as span: | ||
| try: | ||
| return await call_next(ctx) | ||
| except MCPError as e: | ||
| span.set_status(StatusCode.ERROR, e.error.message) | ||
| raise | ||
| except ValidationError: | ||
| # Mirror the sanitized wire response; pydantic messages carry client input. | ||
| span.set_status(StatusCode.ERROR, "Invalid request parameters") | ||
| raise | ||
| except Exception as e: | ||
| span.record_exception(e) | ||
| span.set_status(StatusCode.ERROR, str(e)) | ||
| raise | ||
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 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 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 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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.