feat(core): Default span status to ok in transaction mode

Author: mydea

packages/core/src/types/span.ts

@@ -85,7 +85,7 @@ export interface SpanJSON {
   parent_span_id?: string;
   span_id: string;
   start_timestamp: number;
-  status?: string;
+  status: string;
   timestamp?: number;
   trace_id: string;
   origin?: SpanOrigin;

packages/core/src/utils/spanUtils.ts

@@ -204,6 +204,7 @@ export function spanToJSON(span: Span): SpanJSON {
     span_id,
     trace_id,
     start_timestamp: 0,
+    status: 'ok',
     data: {},
   };
 }
@@ -317,9 +318,9 @@ export function spanIsSampled(span: Span): boolean {
 }
 
 /** Get the status message to use for a JSON representation of a span. */
-export function getStatusMessage(status: SpanStatus | undefined): string | undefined {
+export function getStatusMessage(status: SpanStatus | undefined): string {
   if (!status || status.code === SPAN_STATUS_UNSET) {
-    return undefined;
+    return 'ok';
   }
 
   if (status.code === SPAN_STATUS_OK) {

packages/core/src/utils/transactionEvent.ts

@@ -15,7 +15,7 @@ export function convertTransactionEventToSpanJson(event: TransactionEvent): Span
     parent_span_id,
     span_id: span_id ?? '',
     start_timestamp: event.start_timestamp ?? 0,
-    status,
+    status: status ?? 'ok',
     timestamp: event.timestamp,
     trace_id: trace_id ?? '',
     origin,

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

@@ -245,8 +245,8 @@ export class GraphQLInstrumentation extends InstrumentationBase<GraphQLInstrumen
    */
   private _updateSpanFromResult(span: Span, result: ExecutionResult): void {
     // We want to ensure spans are marked as errored if there are errors in the result
-    // We only do that if the span is not already marked with a status
-    if (result.errors?.length && !spanToJSON(span).status) {
+    // We only do that if the span is not already marked with another error status
+    if (result.errors?.length && spanToJSON(span).status === 'ok') {
       span.setStatus({ code: SPAN_STATUS_ERROR });
     }
 

packages/opentelemetry/src/trace.ts

@@ -78,7 +78,7 @@ function _startSpan<T>(options: OpenTelemetrySpanContext, callback: (span: Span)
               () => callback(span),
               () => {
                 // Only set the span status to ERROR when there wasn't any status set before, in order to avoid stomping useful span statuses
-                if (spanToJSON(span).status === undefined) {
+                if (spanToJSON(span).status === 'ok') {
                   span.setStatus({ code: SpanStatusCode.ERROR });
                 }
               },
@@ -95,7 +95,7 @@ function _startSpan<T>(options: OpenTelemetrySpanContext, callback: (span: Span)
         () => callback(span),
         () => {
           // Only set the span status to ERROR when there wasn't any status set before, in order to avoid stomping useful span statuses
-          if (spanToJSON(span).status === undefined) {
+          if (spanToJSON(span).status === 'ok') {
             span.setStatus({ code: SpanStatusCode.ERROR });
           }
         },