Documentation
    Preparing search index...
    RumVitalEvent: CommonProperties & ViewContainerSchema & {
        _dd?: {
            vital?: { computed_value?: boolean; [k: string]: unknown };
            [k: string]: unknown;
        };
        type: "vital";
        vital: {
            custom?: { [k: string]: number };
            description?: string;
            duration?: number;
            id: string;
            name?: string;
            type: "duration";
            [k: string]: unknown;
        };
        [k: string]: unknown;
    }

    Schema of all properties of a Vital event

    Type declaration

    • [k: string]: unknown
    • Optional Readonly_dd?: {
          vital?: { computed_value?: boolean; [k: string]: unknown };
          [k: string]: unknown;
      }

      Internal properties

      • Optional Readonlyvital?: { computed_value?: boolean; [k: string]: unknown }

        Internal vital properties

        • Optional Readonlycomputed_value?: boolean

          Whether the value of the vital is computed by the SDK (as opposed to directly provided by the customer)

    • Readonlytype: "vital"

      RUM event type

    • Readonlyvital: {
          custom?: { [k: string]: number };
          description?: string;
          duration?: number;
          id: string;
          name?: string;
          type: "duration";
          [k: string]: unknown;
      }

      Vital properties

      • Optional Readonlycustom?: { [k: string]: number }

        User custom vital.

      • Optional Readonlydescription?: string

        Description of the vital. It can be used as a secondary identifier (URL, React component name...)

      • Optional Readonlyduration?: number

        Duration of the vital in nanoseconds

      • Readonlyid: string

        UUID of the vital

      • Optional Readonlyname?: string

        Name of the vital, as it is also used as facet path for its value, it must contain only letters, digits, or the characters - _ . @ $

      • Readonlytype: "duration"

        Type of the vital