PassFailMetric interface

Package:

@azure-rest/load-testing

Pass fail metric

Properties

action	Action taken after the threshold is met. Default is ‘continue’.
actualValue	The actual value of the client metric for the test run.
aggregate	The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests
clientMetric	The client metric on which the criteria should be applied.
condition	The comparison operator. Supported types ‘>’, ‘<’
requestName	Request name for which the Pass fail criteria has to be applied
result	Outcome of the test run.
value	The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.

Property Details

action

Action taken after the threshold is met. Default is ‘continue’.

action?: "stop" | "continue"

Property Value

"stop" | "continue"

actualValue

The actual value of the client metric for the test run.

actualValue?: number

Property Value

number

aggregate

The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests

aggregate?: "count" | "percentage" | "avg" | "p50" | "p90" | "p95" | "p99" | "min" | "max"

Property Value

"count" | "percentage" | "avg" | "p50" | "p90" | "p95" | "p99" | "min" | "max"

clientMetric

The client metric on which the criteria should be applied.

clientMetric?: "response_time_ms" | "latency" | "error" | "requests" | "requests_per_sec"

Property Value

"response_time_ms" | "latency" | "error" | "requests" | "requests_per_sec"

condition

The comparison operator. Supported types ‘>’, ‘<’

condition?: string

Property Value

string

requestName

Request name for which the Pass fail criteria has to be applied

requestName?: string

Property Value

string

result

Outcome of the test run.

result?: "passed" | "undetermined" | "failed"

Property Value

"passed" | "undetermined" | "failed"

value

The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.

value?: number

Property Value

number