feat(core): Streamline SpanJSON type

Author: mydea

packages/core/src/types-hoist/span.ts

@@ -44,7 +44,7 @@ export type SpanTimeInput = HrTime | number | Date;
 
 /** A JSON representation of a span. */
 export interface SpanJSON {
-  data?: { [key: string]: any };
+  data: SpanAttributes;
   description?: string;
   op?: string;
   parent_span_id?: string;

packages/core/src/utils/spanUtils.ts

@@ -112,42 +112,41 @@ function ensureTimestampInSeconds(timestamp: number): number {
 // Note: Because of this, we currently have a circular type dependency (which we opted out of in package.json).
 // This is not avoidable as we need `spanToJSON` in `spanUtils.ts`, which in turn is needed by `span.ts` for backwards compatibility.
 // And `spanToJSON` needs the Span class from `span.ts` to check here.
-export function spanToJSON(span: Span): Partial<SpanJSON> {
+export function spanToJSON(span: Span): SpanJSON {
   if (spanIsSentrySpan(span)) {
     return span.getSpanJSON();
   }
 
-  try {
-    const { spanId: span_id, traceId: trace_id } = span.spanContext();
-
-    // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
-    if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
-      const { attributes, startTime, name, endTime, parentSpanId, status } = span;
-
-      return dropUndefinedKeys({
-        span_id,
-        trace_id,
-        data: attributes,
-        description: name,
-        parent_span_id: parentSpanId,
-        start_timestamp: spanTimeInputToSeconds(startTime),
-        // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
-        timestamp: spanTimeInputToSeconds(endTime) || undefined,
-        status: getStatusMessage(status),
-        op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
-        origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
-        _metrics_summary: getMetricSummaryJsonForSpan(span),
-      });
-    }
+  const { spanId: span_id, traceId: trace_id } = span.spanContext();
 
-    // Finally, at least we have `spanContext()`....
-    return {
+  // Handle a span from @opentelemetry/sdk-base-trace's `Span` class
+  if (spanIsOpenTelemetrySdkTraceBaseSpan(span)) {
+    const { attributes, startTime, name, endTime, parentSpanId, status } = span;
+
+    return dropUndefinedKeys({
       span_id,
       trace_id,
-    };
-  } catch {
-    return {};
+      data: attributes,
+      description: name,
+      parent_span_id: parentSpanId,
+      start_timestamp: spanTimeInputToSeconds(startTime),
+      // This is [0,0] by default in OTEL, in which case we want to interpret this as no end time
+      timestamp: spanTimeInputToSeconds(endTime) || undefined,
+      status: getStatusMessage(status),
+      op: attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP],
+      origin: attributes[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN] as SpanOrigin | undefined,
+      _metrics_summary: getMetricSummaryJsonForSpan(span),
+    });
   }
+
+  // Finally, at least we have `spanContext()`....
+  // This should not actually happen in reality, but we need to handle it for type safety.
+  return {
+    span_id,
+    trace_id,
+    start_timestamp: timestampInSeconds(),
+    data: {},
+  };
 }
 
 function spanIsOpenTelemetrySdkTraceBaseSpan(span: Span): span is OpenTelemetrySdkTraceBaseSpan {

packages/node/src/integrations/tracing/graphql.ts

@@ -67,9 +67,9 @@ export const instrumentGraphql = generateInstrumentOnce<GraphqlOptions>(
           // We keep track of each operation on the root span
           // This can either be a string, or an array of strings (if there are multiple operations)
           if (Array.isArray(existingOperations)) {
-            existingOperations.push(newOperation);
+            (existingOperations as string[]).push(newOperation);
             rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, existingOperations);
-          } else if (existingOperations) {
+          } else if (typeof existingOperations === 'string') {
             rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, [existingOperations, newOperation]);
           } else {
             rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_GRAPHQL_OPERATION, newOperation);

packages/node/src/integrations/tracing/vercelai/index.ts

@@ -32,8 +32,8 @@ const _vercelAIIntegration = (() => {
             span.data['ai.prompt_tokens.used'] = attributes['ai.usage.promptTokens'];
           }
           if (
-            attributes['ai.usage.completionTokens'] != undefined &&
-            attributes['ai.usage.promptTokens'] != undefined
+            typeof attributes['ai.usage.completionTokens'] == 'number' &&
+            typeof attributes['ai.usage.promptTokens'] == 'number'
           ) {
             span.data['ai.total_tokens.used'] =
               attributes['ai.usage.completionTokens'] + attributes['ai.usage.promptTokens'];
@@ -56,13 +56,13 @@ const _vercelAIIntegration = (() => {
         }
 
         // The id of the model
-        const aiModelId: string | undefined = attributes['ai.model.id'];
+        const aiModelId = attributes['ai.model.id'];
 
         // the provider of the model
-        const aiModelProvider: string | undefined = attributes['ai.model.provider'];
+        const aiModelProvider = attributes['ai.model.provider'];
 
         // both of these must be defined for the integration to work
-        if (!aiModelId || !aiModelProvider) {
+        if (typeof aiModelId !== 'string' || typeof aiModelProvider !== 'string' || !aiModelId || !aiModelProvider) {
           return;
         }
 
@@ -137,9 +137,10 @@ const _vercelAIIntegration = (() => {
         span.updateName(nameWthoutAi);
 
         // If a Telemetry name is set and it is a pipeline span, use that as the operation name
-        if (attributes['ai.telemetry.functionId'] && isPipelineSpan) {
-          span.updateName(attributes['ai.telemetry.functionId']);
-          span.setAttribute('ai.pipeline.name', attributes['ai.telemetry.functionId']);
+        const functionId = attributes['ai.telemetry.functionId'];
+        if (functionId && typeof functionId === 'string' && isPipelineSpan) {
+          span.updateName(functionId);
+          span.setAttribute('ai.pipeline.name', functionId);
         }
 
         if (attributes['ai.prompt']) {

packages/opentelemetry/src/propagator.ts

@@ -316,7 +316,7 @@ function getCurrentURL(span: Span): string | undefined {
   // `ATTR_URL_FULL` is the new attribute, but we still support the old one, `SEMATTRS_HTTP_URL`, for now.
   // eslint-disable-next-line deprecation/deprecation
   const urlAttribute = spanData?.[SEMATTRS_HTTP_URL] || spanData?.[ATTR_URL_FULL];
-  if (urlAttribute) {
+  if (typeof urlAttribute === 'string') {
     return urlAttribute;
   }