Function startCopilotOtelRoot

apps/sim/lib/copilot/request/otel.ts:432–497

(
  scope: CopilotOtelScope
)

}

export function startCopilotOtelRoot(
  scope: CopilotOtelScope
): CopilotOtelRoot & { requestId: string } {
  // TRUE root — don't inherit from Next's HTTP handler span (the
  // sampler drops those; we'd orphan the whole mothership tree).
  const parentContext = ROOT_CONTEXT
  // Start with a placeholder `requestId`, then overwrite using the
  // span's actual trace ID so the UI copy-button value pastes
  // directly into Grafana.
  const span = getTracer().startSpan(
    TraceSpan.GenAiAgentExecute,
    { attributes: buildAgentSpanAttributes({ ...scope, requestId: '' }) },
    parentContext
  )
  const carrierSpan = isValidSpanContext(span.spanContext())
    ? span
    : trace.wrapSpanContext(createFallbackSpanContext())
  const spanContext = carrierSpan.spanContext()
  const requestId =
    scope.requestId ??
    (spanContext.traceId && spanContext.traceId.length === 32 ? spanContext.traceId : '')
  span.setAttribute(TraceAttr.RequestId, requestId)
  span.setAttribute(TraceAttr.SimRequestId, requestId)
  const rootContext = trace.setSpan(parentContext, carrierSpan)

  let finished = false
  const finish: CopilotOtelRoot['finish'] = (outcome, error, cancelReason) => {
    if (finished) return
    finished = true
    const resolvedOutcome = outcome ?? RequestTraceV1Outcome.success
    span.setAttribute(TraceAttr.CopilotRequestOutcome, resolvedOutcome)
    // Policy: `explicit_stop` is the ONLY cancellation we treat as
    // expected (status unset → dashboards see it as OK). Everything
    // else — client_disconnect, unknown reason, bug-case cancels —
    // escalates to ERROR so it shows up on error panels.
    const isExplicitStop = cancelReason === CopilotRequestCancelReason.ExplicitStop
    if (error) {
      markSpanForError(span, error)
      if (isExplicitStop || isExplicitUserStopError(error)) {
        span.setStatus({ code: SpanStatusCode.OK })
      }
    } else if (resolvedOutcome === RequestTraceV1Outcome.success) {
      span.setStatus({ code: SpanStatusCode.OK })
    } else if (resolvedOutcome === RequestTraceV1Outcome.cancelled) {
      if (isExplicitStop) {
        span.setStatus({ code: SpanStatusCode.OK })
      } else {
        span.setStatus({
          code: SpanStatusCode.ERROR,
          message: `cancelled: ${cancelReason ?? 'unknown'}`,
        })
      }
    }
    span.end()
  }

  return {
    span,