Type Alias RumResourceEvent

Type Declaration

• [k: string]: unknown

• Optional Readonly_dd?: {
      discarded?: boolean;
      parent_span_id?: string;
      rule_psr?: number;
      span_id?: string;
      trace_id?: string;
      [k: string]: unknown;
  }

  Internal properties

  • Optional Readonlydiscarded?: boolean

    Whether the resource should be discarded or indexed

  • Optional Readonlyparent_span_id?: string

    parent span identifier in decimal format

  • Optional Readonlyrule_psr?: number

    trace sample rate in decimal format

  • Optional Readonlyspan_id?: string

    span identifier in decimal format

  • Optional Readonlytrace_id?: string

    trace identifier, either a 64 bit decimal number or a 128 bit hexadecimal number padded with 0s

• Readonlyresource: {
      connect?: { duration: number; start: number; [k: string]: unknown };
      decoded_body_size?: number;
      delivery_type?: "cache" | "navigational-prefetch" | "other";
      dns?: { duration: number; start: number; [k: string]: unknown };
      download?: { duration: number; start: number; [k: string]: unknown };
      duration?: number;
      encoded_body_size?: number;
      first_byte?: { duration: number; start: number; [k: string]: unknown };
      graphql?: {
          error_count?: number;
          errors?: {
              code?: string;
              locations?: { column: number; line: number; [k: string]: unknown }[];
              message: string;
              path?: (string | number)[];
              [k: string]: unknown;
          }[];
          operationName?: string;
          operationType: "query"
          | "mutation"
          | "subscription";
          payload?: string;
          variables?: string;
          [k: string]: unknown;
      };
      id?: string;
      method?: | "POST"
      | "GET"
      | "HEAD"
      | "PUT"
      | "DELETE"
      | "PATCH"
      | "TRACE"
      | "OPTIONS"
      | "CONNECT";
      protocol?: string;
      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;
      };
      redirect?: { duration: number; start: number; [k: string]: unknown };
      render_blocking_status?: "blocking" | "non-blocking";
      size?: number;
      ssl?: { duration: number; start: number; [k: string]: unknown };
      status_code?: number;
      transfer_size?: number;
      type:
          | "document"
          | "xhr"
          | "beacon"
          | "fetch"
          | "css"
          | "js"
          | "image"
          | "font"
          | "media"
          | "other"
          | "native";
      url: string;
      worker?: { duration: number; start: number; [k: string]: unknown };
      [k: string]: unknown;
  }

  Resource properties

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

    Connect phase properties

    • Readonlyduration: number

      Duration in ns of the resource connect phase

    • Readonlystart: number

      Duration in ns between start of the request and start of the connect phase

  • Optional Readonlydecoded_body_size?: number

    Size in octet of the resource after removing any applied encoding

  • Optional Readonlydelivery_type?: "cache" | "navigational-prefetch" | "other"

    Delivery type of the resource

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

    DNS phase properties

    • Readonlyduration: number

      Duration in ns of the resource dns phase

    • Readonlystart: number

      Duration in ns between start of the request and start of the dns phase

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

    Download phase properties

    • Readonlyduration: number

      Duration in ns of the resource download phase

    • Readonlystart: number

      Duration in ns between start of the request and start of the download phase

  • Optional Readonlyduration?: number

    Duration of the resource

  • Optional Readonlyencoded_body_size?: number

    Size in octet of the resource before removing any applied content encodings

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

    First Byte phase properties

    • Readonlyduration: number

      Duration in ns of the resource first byte phase

    • Readonlystart: number

      Duration in ns between start of the request and start of the first byte phase

  • Optional Readonlygraphql?: {
        error_count?: number;
        errors?: {
            code?: string;
            locations?: { column: number; line: number; [k: string]: unknown }[];
            message: string;
            path?: (string | number)[];
            [k: string]: unknown;
        }[];
        operationName?: string;
        operationType: "query"
        | "mutation"
        | "subscription";
        payload?: string;
        variables?: string;
        [k: string]: unknown;
    }

    GraphQL requests parameters

    • Optional Readonlyerror_count?: number

      Number of GraphQL errors in the response

    • Optional Readonlyerrors?: {
          code?: string;
          locations?: { column: number; line: number; [k: string]: unknown }[];
          message: string;
          path?: (string | number)[];
          [k: string]: unknown;
      }[]

      Array of GraphQL errors from the response

    • Optional ReadonlyoperationName?: string

      Name of the GraphQL operation

    • ReadonlyoperationType: "query" | "mutation" | "subscription"

      Type of the GraphQL operation

    • Optionalpayload?: string

      Content of the GraphQL operation

    • Optionalvariables?: string

      String representation of the operation variables

  • Optional Readonlyid?: string

    UUID of the resource

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

    HTTP method of the resource

  • Optional Readonlyprotocol?: string

    Network protocol used to fetch the resource (e.g., 'http/1.1', 'h2')

  • 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

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

    Redirect phase properties

    • Readonlyduration: number

      Duration in ns of the resource redirect phase

    • Readonlystart: number

      Duration in ns between start of the request and start of the redirect phase

  • Optional Readonlyrender_blocking_status?: "blocking" | "non-blocking"

    Render blocking status of the resource

  • Optional Readonlysize?: number

    Size in octet of the resource response body

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

    SSL phase properties

    • Readonlyduration: number

      Duration in ns of the resource ssl phase

    • Readonlystart: number

      Duration in ns between start of the request and start of the ssl phase

  • Optional Readonlystatus_code?: number

    HTTP status code of the resource

  • Optional Readonlytransfer_size?: number

    Size in octet of the fetched resource

  • Readonlytype:
        | "document"
        | "xhr"
        | "beacon"
        | "fetch"
        | "css"
        | "js"
        | "image"
        | "font"
        | "media"
        | "other"
        | "native"

    Resource type

  • url: string

    URL of the resource

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

    Worker phase properties

    • Readonlyduration: number

      Duration in nanoseconds of the resource worker phase

    • Readonlystart: number

      Duration in nanoseconds between start of the request and start of the worker phase

• Readonlytype: "resource"

  RUM event type

• view: { [k: string]: unknown }