Skip to content

feat(telemetry): instrument context builder tool runs #327

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.

Sign up for GitHub

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

Open
cameroncooke wants to merge 1 commit into
base: cameroncooke/sentry-04-mcp-tool-telemetry
Choose a base branch
from
+213 −72
Open

feat(telemetry): instrument context builder tool runs #327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions Sources/RepoPrompt/Infrastructure/MCP/WindowTools/ContextBuilderSentryTelemetry.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
import Foundation

enum ContextBuilderSentryTelemetry {
static func recordStarted(tokenBudget: Int?) {
SentryTelemetryBootstrap.addBreadcrumb(
.contextBuilderAction,
action: .contextBuilderStarted,
attributes: attributes(phase: .discovery, outcome: .started, tokenBudget: tokenBudget)
)
}

static func recordCompleted(fileCount: Int, tokenBudget: Int?) {
SentryTelemetryBootstrap.addBreadcrumb(
.contextBuilderAction,
action: .contextBuilderCompleted,
attributes: attributes(
phase: .selectionCommit,
outcome: .completed,
fileCount: fileCount,
tokenBudget: tokenBudget
)
)
}

static func recordFailed(tokenBudget: Int?, errorKind: SentryTelemetryBootstrap.ErrorKind) {
SentryTelemetryBootstrap.addBreadcrumb(
.contextBuilderAction,
action: .contextBuilderFailed,
attributes: attributes(
phase: .discovery,
outcome: errorKind == .cancelled ? .cancelled : .failed,
tokenBudget: tokenBudget,
errorKind: errorKind
)
)
}

static func attributes(
phase: SentryTelemetryBootstrap.ContextBuilderPhase,
outcome: SentryTelemetryBootstrap.Outcome,
fileCount: Int? = nil,
tokenBudget: Int? = nil,
errorKind: SentryTelemetryBootstrap.ErrorKind? = nil
) -> [SentryTelemetryBootstrap.Attribute] {
var attributes: [SentryTelemetryBootstrap.Attribute] = [
.entrypoint(.mcp),
.clientClass(.externalAgent),
.toolName(.contextBuilder),
.toolDomain(.context),
.contextBuilderPhase(phase),
.outcome(outcome),
.tokenBudgetBucket(tokenBudgetBucket(for: tokenBudget))
]
if let fileCount {
attributes.append(.selectionFileCount(fileCount))
attributes.append(.resultCount(fileCount))
}
if let errorKind {
attributes.append(.errorKind(errorKind))
}
return attributes
}

private static func tokenBudgetBucket(for tokenBudget: Int?) -> SentryTelemetryBootstrap.TokenBudgetBucket {
guard let tokenBudget else { return .unknown }
return switch tokenBudget {
case ..<25000:
.under25K
case 25000 ..< 75000:
.k25To75
case 75000 ..< 150_000:
.k75To150
default:
.over150K
}
}
}
208 changes: 136 additions & 72 deletions Sources/RepoPrompt/Infrastructure/MCP/WindowTools/MCPContextBuilderToolProvider.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,9 @@ final class MCPContextBuilderToolProvider: MCPWindowToolProviding {
await progressTimeline.reportActivity(phase: phase, message: message)
}

func runContextBuilderAndPlan() async throws -> ContextBuilderToolResult {
func runContextBuilderAndPlan(
parentSpan: SentryTelemetryBootstrap.TraceSpan
) async throws -> ContextBuilderToolResult {
await dependencies.sendStageProgress(
connectionID,
MCPWindowToolName.contextBuilder,
Expand All @@ -331,28 +333,38 @@ final class MCPContextBuilderToolProvider: MCPWindowToolProviding {
"discovering",
"Running Context Builder agent..."
)
let snapshot = try await withTimelinePhaseCompletion(progressTimeline) {
try await withHeartbeat(
connectionID: connectionID,
tool: MCPWindowToolName.contextBuilder,
stage: "discovering",
message: "Still building context...",
timeline: progressTimeline
) {
try await contextBuilderVM.runContextBuilderForMCP(
tabID: finalTabID,
instructionsOverride: instructions.isEmpty ? nil : instructions,
tokenBudgetOverride: tokenBudgetOverride,
persistTokenBudget: false,
enhancementModeOverride: .fullRewrite,
agentOverride: preferredAgent,
modelOverrideRaw: preferredModelRaw,
responseType: responseType?.rawValue,
planModelName: planModelName,
workspaceContext: workspaceContext,
mcpControlToken: mcpControlToken,
progressReporter: progressReporter
)
let snapshot = try await SentryTelemetryBootstrap.childSpanAsync(
parent: parentSpan,
operation: .contextBuilderDiscovery,
attributes: ContextBuilderSentryTelemetry.attributes(
phase: .discovery,
outcome: .started,
tokenBudget: contextBuilderTokenBudget
)
) {
try await withTimelinePhaseCompletion(progressTimeline) {
try await withHeartbeat(
connectionID: connectionID,
tool: MCPWindowToolName.contextBuilder,
stage: "discovering",
message: "Still building context...",
timeline: progressTimeline
) {
try await contextBuilderVM.runContextBuilderForMCP(
tabID: finalTabID,
instructionsOverride: instructions.isEmpty ? nil : instructions,
tokenBudgetOverride: tokenBudgetOverride,
persistTokenBudget: false,
enhancementModeOverride: .fullRewrite,
agentOverride: preferredAgent,
modelOverrideRaw: preferredModelRaw,
responseType: responseType?.rawValue,
planModelName: planModelName,
workspaceContext: workspaceContext,
mcpControlToken: mcpControlToken,
progressReporter: progressReporter
)
}
}
}

Expand Down Expand Up @@ -424,14 +436,25 @@ final class MCPContextBuilderToolProvider: MCPWindowToolProviding {
let sel = resultTab.selection
let fileCount = sel.selectedPaths.count + sel.autoCodemapPaths.count

let selectionReply = try await dependencies.buildTabSelectionReply(
sel,
false,
.relative,
.auto,
lookupContext,
tabResolution.reviewGitContext
)
let selectionReply = try await SentryTelemetryBootstrap.childSpanAsync(
parent: parentSpan,
operation: .contextBuilderSelectionCommit,
attributes: ContextBuilderSentryTelemetry.attributes(
phase: .selectionCommit,
outcome: .started,
fileCount: fileCount,
tokenBudget: contextBuilderTokenBudget
)
) {
try await dependencies.buildTabSelectionReply(
sel,
false,
.relative,
.auto,
lookupContext,
tabResolution.reviewGitContext
)
}
let formattedSelection = ToolOutputFormatter.formatSelectionReplyToString(selectionReply)

var planReply: ChatSendReply? = nil
Expand Down Expand Up @@ -528,28 +551,39 @@ final class MCPContextBuilderToolProvider: MCPWindowToolProviding {
"Generating \(modeLabel)..."
)

let reply = try await withTimelinePhaseCompletion(progressTimeline) {
try await withHeartbeat(
connectionID: connectionID,
tool: MCPWindowToolName.contextBuilder,
stage: "generating",
message: "Still generating \(modeLabel)...",
timeline: progressTimeline
) {
try await dependencies.runMCPPlanOrQuestion(
contextBuilderVM,
resultTab.id,
tabResolution.agentModeSessionID,
tabResolution.agentModeRunID,
mode,
effectivePrompt,
sel,
lookupContext,
tabResolution.reviewGitContext,
finalReviewAuthorization,
progressReporter,
activityReporter
)
let reply = try await SentryTelemetryBootstrap.childSpanAsync(
parent: parentSpan,
operation: .contextBuilderOracleResponse,
attributes: ContextBuilderSentryTelemetry.attributes(
phase: .oracleResponse,
outcome: .started,
fileCount: fileCount,
tokenBudget: contextBuilderTokenBudget
)
) {
try await withTimelinePhaseCompletion(progressTimeline) {
try await withHeartbeat(
connectionID: connectionID,
tool: MCPWindowToolName.contextBuilder,
stage: "generating",
message: "Still generating \(modeLabel)...",
timeline: progressTimeline
) {
try await dependencies.runMCPPlanOrQuestion(
contextBuilderVM,
resultTab.id,
tabResolution.agentModeSessionID,
tabResolution.agentModeRunID,
mode,
effectivePrompt,
sel,
lookupContext,
tabResolution.reviewGitContext,
finalReviewAuthorization,
progressReporter,
activityReporter
)
}
}
}

Expand Down Expand Up @@ -617,33 +651,63 @@ final class MCPContextBuilderToolProvider: MCPWindowToolProviding {
}
}
.joined(separator: "\n")
let exportMode = responseType?.rawValue ?? planReply?.mode ?? reviewReply?.mode ?? "response"
let chatID = planReply?.shortId ?? reviewReply?.shortId
guard let capturedOracleExportDestination else {
throw MCPError.internalError("Missing captured Oracle export destination for context_builder export.")
oracleExportFile = try await SentryTelemetryBootstrap.childSpanAsync(
parent: parentSpan,
operation: .contextBuilderExport,
attributes: ContextBuilderSentryTelemetry.attributes(
phase: .export,
outcome: .started,
fileCount: fileCount,
tokenBudget: contextBuilderTokenBudget
)
) {
let exportMode = responseType?.rawValue ?? planReply?.mode ?? reviewReply?.mode ?? "response"
let chatID = planReply?.shortId ?? reviewReply?.shortId
guard let capturedOracleExportDestination else {
throw MCPError.internalError("Missing captured Oracle export destination for context_builder export.")
}
let exportPath = try await dependencies.resolveDefaultOracleExportPath(
exportMode,
chatID,
capturedOracleExportDestination
)
let resolvedPath = try await dependencies.writeGeneratedOracleExportFile(
exportPath,
markdown,
capturedOracleExportDestination
)
return OracleExportFile(
path: resolvedPath,
instruction: AgentOracleExport.instruction(path: resolvedPath)
)
}
let exportPath = try await dependencies.resolveDefaultOracleExportPath(
exportMode,
chatID,
capturedOracleExportDestination
)
let resolvedPath = try await dependencies.writeGeneratedOracleExportFile(
exportPath,
markdown,
capturedOracleExportDestination
)
oracleExportFile = OracleExportFile(
path: resolvedPath,
instruction: AgentOracleExport.instruction(path: resolvedPath)
)
}

ContextBuilderSentryTelemetry.recordCompleted(fileCount: fileCount, tokenBudget: contextBuilderTokenBudget)
return makeResult(
oracleExportPath: oracleExportFile?.path,
oracleExportInstruction: oracleExportFile?.instruction
)
}
return try await runContextBuilderAndPlan()
return try await SentryTelemetryBootstrap.traceAsync(
.contextBuilderRun,
attributes: ContextBuilderSentryTelemetry.attributes(
phase: .discovery,
outcome: .started,
tokenBudget: contextBuilderTokenBudget
)
) { parentSpan in
ContextBuilderSentryTelemetry.recordStarted(tokenBudget: contextBuilderTokenBudget)
do {
return try await runContextBuilderAndPlan(parentSpan: parentSpan)
} catch {
ContextBuilderSentryTelemetry.recordFailed(
tokenBudget: contextBuilderTokenBudget,
errorKind: error is CancellationError ? .cancelled : .error
)
throw error
}
}
}
}

Expand Down
Loading