Skip to main content

types

Kpi​

KPI (Key Performance Indicator) represents some integral indicator measured during test.

selector : KpiSelector​

Kind of KPI.

threshold : KpiThreshold​

A condition that should be specified.

KpiSelector​

KPI selector.

ResponseTime​

Response time.

quantile : common.QuantileType​

Cummulative quantile (percentile).

Instances​

Aggregated number of instances.

agg : Aggregation​

Aggregation function.

ImbalanceRps​

Imbalance RPS.

ProtocolCodesAbsolute​

codesPatterns : string​

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: '2xx', '3xx'. All failed HTTP responses: ['0', '4xx', '5xx'][2].

ProtocolCodesRelative​

codesPatterns : string​

Protocol (HTTP, GRPC) code patterns to match.

All successful HTTP responses: '2xx', '3xx'. All failed HTTP responses: ['0', '4xx', '5xx'][4].

NetworkCodesAbsolute​

codesPatterns : string​

Network code patterns to match.

All successful network responses: '0'. All failed network responses: 'xx', 'xxx'.

NetworkCodesRelative​

codesPatterns : string​

Network code patterns to match.

All successful network responses: '0'. All failed network responses: 'xx', 'xxx'.

One of kind​

  • responseTime : ResponseTime​

    Response time cummulative quantile (percentile).

  • instances : Instances​

    A number of instances throughout the test.

  • imbalanceRps : ImbalanceRps​

    An RPS at the moment the test has been auto-stopped.

  • protocolCodesAbsolute : ProtocolCodesAbsolute​

    A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes.

  • protocolCodesRelative : ProtocolCodesRelative​

    A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes.

  • networkCodesAbsolute : NetworkCodesAbsolute​

    A total number of requests completed with certain network codes.

  • networkCodesRelative : NetworkCodesRelative​

    A percentage of requests completed with certain network codes.

KpiThreshold​

KPI threshold represents a condition that an actual value of test's KPI should satisfy.

value : double​

Value for comparison with an actual KPI value.

comparison : Comparison​

Comparison operator for comparing actual with the threshold value.

Rule: actual (</<=/>/>=) reference

KpiValue​

An actual value of test's KPI.

testId : string​

ID of a test.

value : double​

Value of KPI.

isOk : bool​

A flag indicating whether the value satisfies KPI threshold condition.

[2]: #protocolcodesrelative'0', '4xx', '5xx'

[4]: #protocolcodesrelative'0', '4xx', '5xx'