Load Testing API, gRPC: ReportService
Written by
Updated at September 4, 2024
A set of methods for managing test reports.
Call | Description |
---|---|
GetTable | Returns a report table for the specified test. |
CalculateKpiValues | Returns a list of KPI values for tests matching the specified filter. |
Calls ReportService
GetTable
Returns a report table for the specified test.
rpc GetTable (GetTableReportRequest) returns (GetTableReportResponse)
GetTableReportRequest
Field | Description |
---|---|
test_id | string Required. ID of the test for which report table will be returned. |
GetTableReportResponse
Field | Description |
---|---|
status | enum report.Status Status of report table.
|
overall | report.table.Report Result for all test cases combined ("overall" test case). |
cases | map<string,report.table.Report> Results for individual test cases, mapped as case_name:report . |
Report
Field | Description |
---|---|
http_codes | map<int64,int64> Total count of HTTP responses, grouped by HTTP response code. |
net_codes | map<int64,int64> Total count of network responses, grouped by response code. |
quantiles | common.Quantiles Response time statistics, aggregated by quantiles. |
Quantiles
Field | Description |
---|---|
q50 | double 50 percentile (median). |
q75 | double 75 percentile. |
q80 | double 80 percentile. |
q85 | double 85 percentile. |
q90 | double 90 percentile. |
q95 | double 95 percentile. |
q98 | double 98 percentile. |
q99 | double 99 percentile. |
q100 | double 100 percentile (maximum or minimum). |
CalculateKpiValues
Returns a list of KPI values for tests matching the specified filter.
rpc CalculateKpiValues (CalculateReportKpiValuesRequest) returns (CalculateReportKpiValuesResponse)
CalculateReportKpiValuesRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder containing tests. The maximum string length in characters is 50. |
test_filter | string Required. Test filter selector to calculate KPI values for. The maximum string length in characters is 1000. |
test_case | string Test case to calculate KPI values for. If not specified, KPI values will be calculated for 'overall' case. The maximum string length in characters is 100. |
kpi | report.Kpi Required. KPI to be calculated. |
Kpi
Field | Description |
---|---|
selector | KpiSelector Kind of KPI. |
threshold | KpiThreshold A condition that should be specified. |
KpiSelector
Field | Description |
---|---|
kind | oneof: response_time , instances , imbalance_rps , protocol_codes_absolute , protocol_codes_relative , network_codes_absolute or network_codes_relative Imbalance RPS. |
response_time | ResponseTime Response time cummulative quantile (percentile). |
instances | Instances A number of instances throughout the test. |
imbalance_rps | ImbalanceRps An RPS at the moment the test has been auto-stopped. |
protocol_codes_absolute | ProtocolCodesAbsolute A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. |
protocol_codes_relative | ProtocolCodesRelative A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. |
network_codes_absolute | NetworkCodesAbsolute A total number of requests completed with certain network codes. |
network_codes_relative | NetworkCodesRelative A percentage of requests completed with certain network codes. |
ResponseTime
Field | Description |
---|---|
quantile | enum common.QuantileType Cummulative quantile (percentile).
|
Instances
Field | Description |
---|---|
agg | enum Aggregation Aggregation function.
|
ImbalanceRps
Empty.
ProtocolCodesAbsolute
Field | Description |
---|---|
codes_patterns[] | string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. All failed HTTP responses: ['0', '4xx', '5xx']. |
ProtocolCodesRelative
Field | Description |
---|---|
codes_patterns[] | string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. All failed HTTP responses: ['0', '4xx', '5xx']. |
NetworkCodesAbsolute
Field | Description |
---|---|
codes_patterns[] | string Network code patterns to match. All successful network responses: ['0']. All failed network responses: ['xx', 'xxx']. |
NetworkCodesRelative
Field | Description |
---|---|
codes_patterns[] | string Network code patterns to match. All successful network responses: ['0']. All failed network responses: ['xx', 'xxx']. |
KpiThreshold
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
|
CalculateReportKpiValuesResponse
Field | Description |
---|---|
folder_id | string ID of the folder. |
values[] | report.KpiValue Actual KPI values. |
KpiValue
Field | Description |
---|---|
test_id | string ID of a test. |
value | double Value of KPI. |
is_ok | bool A flag indicating whether the value satisfies KPI threshold condition. |