Type Alias RumErrorEvent

Type Declaration

• [k: string]: unknown

• Readonlyerror: {
      binary_images?: {
          arch?: string;
          is_system: boolean;
          load_address?: string;
          max_address?: string;
          name: string;
          uuid: string;
          [k: string]: unknown;
      }[];
      category?: | "ANR"
      | "App Hang"
      | "Exception"
      | "Watchdog Termination"
      | "Memory Warning"
      | "Network";
      causes?: {
          message: string;
          source: | "network"
          | "source"
          | "console"
          | "logger"
          | "agent"
          | "webview"
          | "custom"
          | "report";
          stack?: string;
          type?: string;
          [k: string]: unknown;
      }[];
      csp?: { disposition?: "enforce"
      | "report"; [k: string]: unknown };
      fingerprint?: string;
      handling?: "handled" | "unhandled";
      handling_stack?: string;
      id?: string;
      is_crash?: boolean;
      message: string;
      meta?: {
          code_type?: string;
          exception_codes?: string;
          exception_type?: string;
          incident_identifier?: string;
          parent_process?: string;
          path?: string;
          process?: string;
          [k: string]: unknown;
      };
      resource?: {
          method: | "POST"
          | "GET"
          | "HEAD"
          | "PUT"
          | "DELETE"
          | "PATCH"
          | "TRACE"
          | "OPTIONS"
          | "CONNECT";
          provider?: {
              domain?: string;
              name?: string;
              type?: | "ad"
              | "advertising"
              | "analytics"
              | "cdn"
              | "content"
              | "customer-success"
              | "first party"
              | "hosting"
              | "marketing"
              | "other"
              | "social"
              | "tag-manager"
              | "utility"
              | "video";
              [k: string]: unknown;
          };
          status_code: number;
          url: string;
          [k: string]: unknown;
      };
      source: | "network"
      | "source"
      | "console"
      | "logger"
      | "agent"
      | "webview"
      | "custom"
      | "report";
      source_type?: | "android"
      | "browser"
      | "ios"
      | "react-native"
      | "flutter"
      | "roku"
      | "ndk"
      | "ios+il2cpp"
      | "ndk+il2cpp";
      stack?: string;
      threads?: {
          crashed: boolean;
          name: string;
          stack: string;
          state?: string;
          [k: string]: unknown;
      }[];
      time_since_app_start?: number;
      type?: string;
      was_truncated?: boolean;
      [k: string]: unknown;
  }

  Error properties

  • Optional Readonlybinary_images?: {
        arch?: string;
        is_system: boolean;
        load_address?: string;
        max_address?: string;
        name: string;
        uuid: string;
        [k: string]: unknown;
    }[]

    Description of each binary image (native libraries; for Android: .so files) loaded or referenced by the process/application.

  • Optional Readonlycategory?:
        | "ANR"
        | "App Hang"
        | "Exception"
        | "Watchdog Termination"
        | "Memory Warning"
        | "Network"

    The specific category of the error. It provides a high-level grouping for different types of errors.

  • Optionalcauses?: {
        message: string;
        source:
            | "network"
            | "source"
            | "console"
            | "logger"
            | "agent"
            | "webview"
            | "custom"
            | "report";
        stack?: string;
        type?: string;
        [k: string]: unknown;
    }[]

    Causes of the error

  • Optional Readonlycsp?: { disposition?: "enforce" | "report"; [k: string]: unknown }

    Content Security Violation properties

    • Optional Readonlydisposition?: "enforce" | "report"

      In the context of CSP errors, indicates how the violated policy is configured to be treated by the user agent.

  • Optionalfingerprint?: string

    Fingerprint used for Error Tracking custom grouping

  • Optional Readonlyhandling?: "handled" | "unhandled"

    Whether the error has been handled manually in the source code or not

  • Optional Readonlyhandling_stack?: string

    Handling call stack

  • Optional Readonlyid?: string

    UUID of the error

  • Optional Readonlyis_crash?: boolean

    Whether this error crashed the host application

  • message: string

    Error message

  • Optional Readonlymeta?: {
        code_type?: string;
        exception_codes?: string;
        exception_type?: string;
        incident_identifier?: string;
        parent_process?: string;
        path?: string;
        process?: string;
        [k: string]: unknown;
    }

    Platform-specific metadata of the error event.

    • Optional Readonlycode_type?: string

      The CPU architecture of the process that crashed.

    • Optional Readonlyexception_codes?: string

      CPU specific information about the exception encoded into 64-bit hexadecimal number preceded by the signal code.

    • Optional Readonlyexception_type?: string

      The name of the corresponding BSD termination signal. (in case of iOS crash)

    • Optional Readonlyincident_identifier?: string

      A client-generated 16-byte UUID of the incident.

    • Optional Readonlyparent_process?: string

      Parent process information.

    • Optional Readonlypath?: string

      The location of the executable.

    • Optional Readonlyprocess?: string

      The name of the crashed process.

  • Optional Readonlyresource?: {
        method:
            | "POST"
            | "GET"
            | "HEAD"
            | "PUT"
            | "DELETE"
            | "PATCH"
            | "TRACE"
            | "OPTIONS"
            | "CONNECT";
        provider?: {
            domain?: string;
            name?: string;
            type?: | "ad"
            | "advertising"
            | "analytics"
            | "cdn"
            | "content"
            | "customer-success"
            | "first party"
            | "hosting"
            | "marketing"
            | "other"
            | "social"
            | "tag-manager"
            | "utility"
            | "video";
            [k: string]: unknown;
        };
        status_code: number;
        url: string;
        [k: string]: unknown;
    }

    Resource properties of the error

    • Readonlymethod:
          | "POST"
          | "GET"
          | "HEAD"
          | "PUT"
          | "DELETE"
          | "PATCH"
          | "TRACE"
          | "OPTIONS"
          | "CONNECT"

      HTTP method of the resource

    • Optional Readonlyprovider?: {
          domain?: string;
          name?: string;
          type?:
              | "ad"
              | "advertising"
              | "analytics"
              | "cdn"
              | "content"
              | "customer-success"
              | "first party"
              | "hosting"
              | "marketing"
              | "other"
              | "social"
              | "tag-manager"
              | "utility"
              | "video";
          [k: string]: unknown;
      }

      The provider for this resource

      • Optional Readonlydomain?: string

        The domain name of the provider

      • Optional Readonlyname?: string

        The user friendly name of the provider

      • Optional Readonlytype?:
            | "ad"
            | "advertising"
            | "analytics"
            | "cdn"
            | "content"
            | "customer-success"
            | "first party"
            | "hosting"
            | "marketing"
            | "other"
            | "social"
            | "tag-manager"
            | "utility"
            | "video"

        The type of provider

    • Readonlystatus_code: number

      HTTP Status code of the resource

    • url: string

      URL of the resource

  • Readonlysource:
        | "network"
        | "source"
        | "console"
        | "logger"
        | "agent"
        | "webview"
        | "custom"
        | "report"

    Source of the error

  • Optional Readonlysource_type?:
        | "android"
        | "browser"
        | "ios"
        | "react-native"
        | "flutter"
        | "roku"
        | "ndk"
        | "ios+il2cpp"
        | "ndk+il2cpp"

    Source type of the error (the language or platform impacting the error stacktrace format)

  • Optionalstack?: string

    Stacktrace of the error

  • Optionalthreads?: {
        crashed: boolean;
        name: string;
        stack: string;
        state?: string;
        [k: string]: unknown;
    }[]

    Description of each thread in the process when error happened.

  • Optional Readonlytime_since_app_start?: number

    Time since application start when error happened (in milliseconds)

  • Optional Readonlytype?: string

    The type of the error

  • Optional Readonlywas_truncated?: boolean

    A boolean value saying if any of the stack traces was truncated due to minification.

• Optional Readonlyfeature_flags?: { [k: string]: unknown }

  Feature flags properties

• Optional Readonlyfreeze?: { duration: number; [k: string]: unknown }

  Properties of App Hang and ANR errors

  • Readonlyduration: number

    Duration of the main thread freeze (in ns)

• Readonlytype: "error"

  RUM event type

• Readonlyview: { in_foreground?: boolean; [k: string]: unknown }

  View properties

  • Optional Readonlyin_foreground?: boolean

    Is the error starting in the foreground (focus in browser)