@dash0/sdk-web/src/utils/otel/error.ts

Dash0's Web SDK to collect telemetry from end-users' web browsers

import { addSpanEvent, InProgressSpan } from "./span";
import { addAttribute } from "./attributes";
import {
  SPAN_EVENT_NAME_EXCEPTION,
  EXCEPTION_MESSAGE,
  EXCEPTION_STACKTRACE,
  EXCEPTION_TYPE,
  SPAN_STATUS_ERROR,
} from "../../semantic-conventions";
import { KeyValue, SpanStatus } from "../../types/otlp";

interface ExceptionWithCode {
  code: string | number;
  name?: string;
  message?: string;
  stack?: string;
}

interface ExceptionWithMessage {
  code?: string | number;
  message: string;
  name?: string;
  stack?: string;
}

interface ExceptionWithName {
  code?: string | number;
  message?: string;
  name: string;
  stack?: string;
}

export type Exception = ExceptionWithCode | ExceptionWithMessage | ExceptionWithName | string;

export function recordException(span: InProgressSpan, exception: Exception) {
  const attributes: KeyValue[] = [];

  if (typeof exception === "string") {
    addAttribute(attributes, EXCEPTION_MESSAGE, exception);
  } else if (exception) {
    if (exception.code) {
      addAttribute(attributes, EXCEPTION_TYPE, exception.code.toString());
    } else if (exception.name) {
      addAttribute(attributes, EXCEPTION_TYPE, exception.name);
    }

    if (exception.message) {
      addAttribute(attributes, EXCEPTION_MESSAGE, exception.message);
    }
    if (exception.stack) {
      addAttribute(attributes, EXCEPTION_STACKTRACE, exception.stack);
    }

    addSpanEvent(span, SPAN_EVENT_NAME_EXCEPTION, attributes);
  }
}

export function errorToSpanStatus(e: Exception): SpanStatus {
  return {
    code: SPAN_STATUS_ERROR,
    message: e && typeof e === "object" && "message" in e ? (e.message as string) : String(e),
  };
}