Load Testing API, gRPC: ReportService.CalculateKpiValues

Статья создана

Yandex Cloud

Обновлена 17 октября 2024 г.

gRPC request
CalculateReportKpiValuesRequest
Kpi
KpiSelector
ResponseTime
Instances
ImbalanceRps
ProtocolCodesAbsolute
ProtocolCodesRelative
NetworkCodesAbsolute
NetworkCodesRelative
KpiThreshold
CalculateReportKpiValuesResponse
KpiValue

Returns a list of KPI values for tests matching the specified filter.

gRPC request

rpc CalculateKpiValues (CalculateReportKpiValuesRequest) returns (CalculateReportKpiValuesResponse)

CalculateReportKpiValuesRequest

{
  "folderId": "string",
  "testFilter": "string",
  "testCase": "string",
  "kpi": {
    "selector": {
      // Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`
      "responseTime": {
        "quantile": "QuantileType"
      },
      "instances": {
        "agg": "Aggregation"
      },
      "imbalanceRps": "ImbalanceRps",
      "protocolCodesAbsolute": {
        "codesPatterns": [
          "string"
        ]
      },
      "protocolCodesRelative": {
        "codesPatterns": [
          "string"
        ]
      },
      "networkCodesAbsolute": {
        "codesPatterns": [
          "string"
        ]
      },
      "networkCodesRelative": {
        "codesPatterns": [
          "string"
        ]
      }
      // end of the list of possible fields
    },
    "threshold": {
      "value": "double",
      "comparison": "Comparison"
    }
  }
}

Field	Description
folderId	string Required field. ID of the folder containing tests.
testFilter	string Required field. Test filter selector to calculate KPI values for.
testCase	string Test case to calculate KPI values for. If not specified, KPI values will be calculated for 'overall' case.
kpi	Kpi Required field. KPI to be calculated.

Kpi

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

Field

Description

selector

KpiSelector

Kind of KPI.

threshold

KpiThreshold

A condition that should be specified.

KpiSelector

KPI selector.

Field	Description
responseTime	ResponseTime Response time cummulative quantile (percentile). Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
instances	Instances A number of instances throughout the test. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
imbalanceRps	ImbalanceRps An RPS at the moment the test has been auto-stopped. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesAbsolute	ProtocolCodesAbsolute A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
protocolCodesRelative	ProtocolCodesRelative A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesAbsolute	NetworkCodesAbsolute A total number of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.
networkCodesRelative	NetworkCodesRelative A percentage of requests completed with certain network codes. Includes only one of the fields `responseTime`, `instances`, `imbalanceRps`, `protocolCodesAbsolute`, `protocolCodesRelative`, `networkCodesAbsolute`, `networkCodesRelative`.

ResponseTime

Response time.

Field

Description

quantile

enum QuantileType

Cummulative quantile (percentile).

QUANTILE_TYPE_UNSPECIFIED: Unspecified percentile.
QUANTILE_TYPE_50: 50 percentile (median).
QUANTILE_TYPE_75: 75 percentile.
QUANTILE_TYPE_80: 80 percentile.
QUANTILE_TYPE_85: 85 percentile.
QUANTILE_TYPE_90: 90 percentile.
QUANTILE_TYPE_95: 95 percentile.
QUANTILE_TYPE_98: 98 percentile.
QUANTILE_TYPE_99: 99 percentile.
QUANTILE_TYPE_100: 100 percentile (maximum or minimum).

Instances

Aggregated number of instances.

Field

Description

agg

enum Aggregation

Aggregation function.

AGGREGATION_UNSPECIFIED: Unspecified.
AGGREGATION_MIN: Minimum.
AGGREGATION_MAX: Maximum.
AGGREGATION_AVG: Average.
AGGREGATION_MEDIAN: Median.
AGGREGATION_STD_DEV: Standard deviation.

ImbalanceRps

Imbalance RPS.

Field	Description
Empty

ProtocolCodesAbsolute

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

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

ProtocolCodesRelative

Field

Description

codesPatterns[]

string

Protocol (HTTP, GRPC) code patterns to match.

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

NetworkCodesAbsolute

Field

Description

codesPatterns[]

string

Network code patterns to match.

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

NetworkCodesRelative

Field

Description

codesPatterns[]

string

Network code patterns to match.

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

KpiThreshold

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

Field

Description

value

double

Value for comparison with an actual KPI value.

comparison

enum Comparison

Comparison operator for comparing actual with the threshold value.

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

COMPARISON_UNSPECIFIED: Unspecified.
COMPARISON_LT: Less than the specified value.
COMPARISON_LTE: Less than or equal to the specified value.
COMPARISON_GT: Greater than the specified value.
COMPARISON_GTE: Greater than or equal to the specified value.

CalculateReportKpiValuesResponse

{
  "folderId": "string",
  "values": [
    {
      "testId": "string",
      "value": "double",
      "isOk": "bool"
    }
  ]
}

Field

Description

folderId

string

ID of the folder.

values[]

KpiValue

Actual KPI values.

KpiValue

An actual value of test's KPI.

Field	Description
testId	string ID of a test.
value	double Value of KPI.
isOk	bool A flag indicating whether the value satisfies KPI threshold condition.

Load Testing API, gRPC: ReportService.CalculateKpiValues

gRPC requestgRPC request

CalculateReportKpiValuesRequestCalculateReportKpiValuesRequest

KpiKpi

KpiSelectorKpiSelector

ResponseTimeResponseTime

InstancesInstances

ImbalanceRpsImbalanceRps

ProtocolCodesAbsoluteProtocolCodesAbsolute

ProtocolCodesRelativeProtocolCodesRelative

NetworkCodesAbsoluteNetworkCodesAbsolute

NetworkCodesRelativeNetworkCodesRelative

KpiThresholdKpiThreshold

CalculateReportKpiValuesResponseCalculateReportKpiValuesResponse

KpiValueKpiValue

Была ли статья полезна?

gRPC request

CalculateReportKpiValuesRequest

Kpi

KpiSelector

ResponseTime

Instances

ImbalanceRps

ProtocolCodesAbsolute

ProtocolCodesRelative

NetworkCodesAbsolute

NetworkCodesRelative

KpiThreshold

CalculateReportKpiValuesResponse

KpiValue