-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat(core): MCP server instrumentation without breaking Miniflare #16817
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
base: develop
Are you sure you want to change the base?
Conversation
…improved test isolation
…racing and monitoring
…r MCP server instrumentation
…ibute names to match OTEL draft semantic convention
…r improved instrumentation
…or stdio and SSE transports
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very nice, all good from my eyes in overall direction!
Thanks @AbhiPrasad! Will keep working on this and close the other PR using |
…duration. adds configuration, extraction, and transport utilities. Introduce span creation functions and improves method wrapping for improved telemetry.
… files for attribute extraction, correlation, and handler wrapping, removing deprecated utilities and configuration files. Improve transport instrumentation for better telemetry and span handling.
…n handling functions. Update type definitions and separate method wrapping for transport handlers.
… to remove sensitive data based on the sendDefaultPii setting.
- Introduced new attributes for tool result content count and error status. - Updated attribute extraction functions to utilize new constants for better maintainability. - Added error capturing utilities to handle tool execution errors and transport errors gracefully.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1st pass.
Before I review further, I'd like to see the develop docs PR so that I can make sure all the attributes are being added as we expect. Right now it's a bit hard to know if an attribute is missing or not.
I assume much of this is AI generated, which is fine, but let's make sure we clean the comments up (and expand the jsdoc string appropriately).
@@ -0,0 +1,166 @@ | |||
/** | |||
* types for MCP server instrumentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these vendored in from the mcp package? If so we need to put the mcp library license + sha we grabbed the types from in this file.
if (isJsonRpcRequest(jsonRpcMessage)) { | ||
const messageTyped = jsonRpcMessage as { method: string; id: string | number }; | ||
|
||
// Create isolation scope for this request (standard Sentry pattern) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
m: Instead of inline comments like this, I would prefer if we added notes in the jsdoc to document behaviour. Right now this comment is a bit redundant with the code.
Ditto with other instances of this.
|
||
// Use Object.fromEntries with filter for a more functional approach | ||
return Object.fromEntries( | ||
Object.entries(spanData).filter(([key]) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: I would prefer if we called reduce
on Object.entries(spanData)
to do this operation instead of calling filter
+ Object.fromEntries
on the constructed array.
|
||
captureException(error, { | ||
tags: { | ||
mcp_error_type: errorType || 'handler_execution', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sdk should not be setting tags by default. Tags are meant to be only set by users.
What we can instead do is set a mechanism: https://develop.sentry.dev/sdk/data-model/event-payloads/exception/#exception-mechanism.
* | ||
* Compatible with versions `^1.9.0` of the `@modelcontextprotocol/sdk` package. | ||
*/ | ||
export function wrapMcpServerWithSentry<S extends object>(mcpServerInstance: S): S { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add an example usage snippet to the jsdoc here.
@AbhiPrasad wdyt of this? Bugbot said that From what I’ve tested, fill works fine. the MCP server sets Do you think it makes sense to get lazy loading handlers? Not sure if it’s worthy adding more complexity for this. Cursor suggested something like a function wrapTransportProperty(obj, key, wrapFn) {
let current = obj[key];
let wrapped = false;
Object.defineProperty(obj, key, {
configurable: true,
enumerable: true,
get() {
return current;
},
set(newValue) {
if (typeof newValue === 'function' && !wrapped) {
current = wrapFn(newValue);
wrapped = true;
} else {
current = newValue;
wrapped = false;
}
}
});
// in case the property was already assigned before wrapping
if (typeof current === 'function') {
obj[key] = current;
}
} |
yeah as long as it exists when we wrap it I think we are fine. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Session ID Missing Causes Span Collisions
The requestIdToSpanMap
is now keyed solely by requestId
. Since requestId
s are only guaranteed to be unique per session and are frequently reused across different MCP sessions, this leads to collisions. When multiple concurrent sessions use the same requestId
, the second request overwrites the first session's span data. This results in:
- Incorrect span-to-handler correlation and attribute assignment.
- Premature termination or loss of spans from the original session.
- Unreliable tracing data in multi-session environments.
Additionally, cleanupAllPendingSpans()
, invoked when a single transport closes, clears the entire global map, prematurely ending and marking as error all spans, including those belonging to other still-active sessions. This is a regression from the previous implementation which used (sessionId, requestId)
for correlation, preventing these issues.
packages/core/src/integrations/mcp-server/correlation.ts#L15-L129
sentry-javascript/packages/core/src/integrations/mcp-server/correlation.ts
Lines 15 to 129 in 790f2b3
import { filterMcpPiiFromSpanData } from './piiFiltering'; | |
import type { RequestId, SessionId } from './types'; | |
// Simplified correlation system that works with or without sessionId | |
// Maps requestId directly to span data for stateless operation | |
const requestIdToSpanMap = new Map< | |
RequestId, | |
{ | |
span: Span; | |
method: string; | |
startTime: number; | |
} | |
>(); | |
/** | |
* Stores span context for later correlation with handler execution | |
*/ | |
export function storeSpanForRequest(requestId: RequestId, span: Span, method: string): void { | |
requestIdToSpanMap.set(requestId, { | |
span, | |
method, | |
startTime: Date.now(), | |
}); | |
} | |
/** | |
* Associates handler execution with the corresponding request span | |
*/ | |
export function associateContextWithRequestSpan<T>( | |
extraHandlerData: { sessionId?: SessionId; requestId: RequestId } | undefined, | |
cb: () => T, | |
): T { | |
if (extraHandlerData) { | |
const { requestId } = extraHandlerData; | |
const spanData = requestIdToSpanMap.get(requestId); | |
if (!spanData) { | |
return cb(); | |
} | |
// Keep span in map for response enrichment (don't delete yet) | |
return withActiveSpan(spanData.span, () => { | |
return cb(); | |
}); | |
} | |
return cb(); | |
} | |
/** | |
* Completes span with tool results and cleans up correlation | |
*/ | |
export function completeSpanWithResults(requestId: RequestId, result: unknown): void { | |
const spanData = requestIdToSpanMap.get(requestId); | |
if (spanData) { | |
const { span, method } = spanData; | |
const spanWithMethods = span as Span & { | |
setAttributes: (attrs: Record<string, unknown>) => void; | |
setStatus: (status: { code: number; message: string }) => void; | |
end: () => void; | |
}; | |
if (spanWithMethods.setAttributes && method === 'tools/call') { | |
// Add tool-specific attributes with PII filtering | |
const rawToolAttributes = extractToolResultAttributes(result); | |
const client = getClient(); | |
const sendDefaultPii = Boolean(client?.getOptions().sendDefaultPii); | |
const toolAttributes = filterMcpPiiFromSpanData(rawToolAttributes, sendDefaultPii); | |
spanWithMethods.setAttributes(toolAttributes); | |
const isToolError = rawToolAttributes[MCP_TOOL_RESULT_IS_ERROR_ATTRIBUTE] === true; | |
if (isToolError) { | |
spanWithMethods.setStatus({ | |
code: 2, // ERROR | |
message: 'Tool execution failed', | |
}); | |
captureError(new Error('Tool returned error result'), 'tool_execution'); | |
} | |
} | |
if (spanWithMethods.end) { | |
spanWithMethods.end(); | |
} | |
requestIdToSpanMap.delete(requestId); | |
} | |
} | |
/** | |
* Cleans up all pending spans (for transport close) | |
*/ | |
export function cleanupAllPendingSpans(): number { | |
const pendingCount = requestIdToSpanMap.size; | |
for (const [, spanData] of requestIdToSpanMap) { | |
const spanWithEnd = spanData.span as Span & { | |
end: () => void; | |
setStatus: (status: { code: number; message: string }) => void; | |
}; | |
if (spanWithEnd.setStatus && spanWithEnd.end) { | |
spanWithEnd.setStatus({ | |
code: 2, // ERROR | |
message: 'Transport closed before request completion', | |
}); | |
spanWithEnd.end(); | |
} | |
} | |
requestIdToSpanMap.clear(); | |
return pendingCount; | |
} |
Was this report helpful? Give feedback by reacting with 👍 or 👎
Closes #16826, #16654, #16666
Different approach from #16807 .
Using
Proxy
was causing issues in cloudflare #16182.Now using
fill
we shouldn't have those problems asfill
doesn't create a new wrapper object with a different identity, so now:fill
just replaces the method on the existing objecttransport.start()
runs and accesses private fields, this is still the original transport objectWeakMap
recognizes it as the same object that owns the private fieldsWhat's inside
mcpServerInstance.tool()
,mcpServerInstance.resource()
, etc.)Tracing
It follows OTEL semantic conventions for MCP and adds more attributes we thought are useful.
It also handles PII based on user setting of
sendDefaultPii
.Tracing flow
id: 2
)mcp.server
spanrequestIdToSpanMap[2] = { span, method: "tools/call", startTime }
requestId: 2
completeSpanWithToolResults(2, result)
enriches and completes spanError handling
errorCapture.ts
sendDefaultPii
settingshandlers.ts
isError: true
)transport.ts