Type Alias LoadPerformanceMetric

Represents performance data captured for a load processed by the gateway.

type LoadPerformanceMetric = {
    appId?: string | null;
    approximateMaxConnectorThroughput?: number;
    benchmarkingReload?: boolean;
    concurrentReloads?: number;
    connectorLatency?: number;
    connectorUrl?: string | null;
    dataSourceId?: string | null;
    dataSourceName?: string | null;
    dataTransmissionEndTime?: string | null;
    dataTransmissionStartTime?: string | null;
    metricId?: string | null;
    name?: string | null;
    reloadId?: string | null;
    sessionAppLoad?: boolean;
    statement?: string | null;
    status?: string | null;
    throughput?: number;
    totalBytesTransferred?: number;
}
Index
appId? approximateMaxConnectorThroughput? benchmarkingReload? concurrentReloads? connectorLatency? connectorUrl? dataSourceId? dataSourceName? dataTransmissionEndTime? dataTransmissionStartTime? metricId? name? reloadId? sessionAppLoad? statement? status? throughput? totalBytesTransferred?
appId?: string | null

The app id associated with the reload

approximateMaxConnectorThroughput?: number

Approximation of the maximum connector throughput in KB/s, excluding downstream write time

benchmarkingReload?: boolean

A flag indicating whether this load is part of a benchmarking reload or not.

concurrentReloads?: number

Number of concurrent benchmarks/reloads observed when this load was started

connectorLatency?: number

The connector latency in ms measured during data transmission

connectorUrl?: string | null

The url of the connector

dataSourceId?: string | null

The data source id

dataSourceName?: string | null

The data source name

dataTransmissionEndTime?: string | null

The ISO 8601 formatted timestamp when data transmission completed

dataTransmissionStartTime?: string | null

The ISO 8601 formatted timestamp when data transmission started

metricId?: string | null

A unique identifier generated for this metric

name?: string | null

The name of the load performance metric, typically in the format "reload-YYYY-MM-DDTHH:mm:ssK"

reloadId?: string | null

The reload id that this load is a part of

sessionAppLoad?: boolean

A flag indicating whether this load is part of a session app load or not.

statement?: string | null

The load script statement for the load

status?: string | null

The status of the load, e.g. "Completed", "Failed", "Cancelled"

throughput?: number

The data throughput in KB/s measured during data transmission

totalBytesTransferred?: number

The total bytes transferred during the load

Settings
Member Visibility

On This Page
Properties