Load Testing API, gRPC: RegressionDashboardService
A set of methods for managing Load Testing Regression Dashboards.
Call | Description |
---|---|
Create | Creates a regression dashboard in the specified folder. |
Get | Returns the specified regression dashboard. |
List | Retrieves the list of regression dashboards in the specified folder. |
Delete | Deletes the specified regression dashboard. |
Update | Updates the specified regression dashboard. |
Calls RegressionDashboardService
Create
Creates a regression dashboard in the specified folder.
rpc Create (CreateRegressionDashboardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateRegressionDashboardMetadata
Operation.response:regression.Dashboard
CreateRegressionDashboardRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a regression dashboard in. The maximum string length in characters is 50. |
name | string Name of the dashboard. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string Description of the dashboard. The maximum string length in characters is 1024. |
content | regression.Dashboard.Content Content of the dashboard. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateRegressionDashboardMetadata
Field | Description |
---|---|
dashboard_id | string ID of the dashboard that is being created. |
Dashboard
Field | Description |
---|---|
id | string ID of the dashboard. |
name | string Name of the dashboard. |
description | string Description of the dashboard. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Last update timestamp. |
created_by | string UA or SA that created the dashboard. |
updated_by | string UA or SA that updated the dashboard last time. |
etag | string Etag of the dashboard. |
content | Content Dashboard content. |
Content
Field | Description |
---|---|
widgets[] | Widget Widgets. |
Widget
Field | Description |
---|---|
position | LayoutPosition Widget position. |
widget | oneof: chart , text or title |
chart | ChartWidget Chart widget. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 X. |
y | int64 Y. |
width | int64 Width. |
height | int64 Height. |
ChartWidget
Field | Description |
---|---|
id | string ID of the chart. |
name | string Name of the chart. |
description | string Description of the chart. |
filter_str | string Test filter selector to show KPI values for. |
test_case | string Test case to show KPI values for. |
kpis[] | report.Kpi KPIs to show. |
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
|
TextWidget
Field | Description |
---|---|
text | string Text string. |
TitleWidget
Field | Description |
---|---|
text | string Title string. |
size | enum TitleSize Title size.
|
Get
Returns the specified regression dashboard.
To get the list of all available regression dashboards, make a List request.
rpc Get (GetRegressionDashboardRequest) returns (regression.Dashboard)
GetRegressionDashboardRequest
Field | Description |
---|---|
dashboard_id | string Required. ID of the dashboard to return. The maximum string length in characters is 50. |
Dashboard
Field | Description |
---|---|
id | string ID of the dashboard. |
name | string Name of the dashboard. |
description | string Description of the dashboard. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Last update timestamp. |
created_by | string UA or SA that created the dashboard. |
updated_by | string UA or SA that updated the dashboard last time. |
etag | string Etag of the dashboard. |
content | Content Dashboard content. |
Content
Field | Description |
---|---|
widgets[] | Widget Widgets. |
Widget
Field | Description |
---|---|
position | LayoutPosition Widget position. |
widget | oneof: chart , text or title |
chart | ChartWidget Chart widget. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 X. |
y | int64 Y. |
width | int64 Width. |
height | int64 Height. |
ChartWidget
Field | Description |
---|---|
id | string ID of the chart. |
name | string Name of the chart. |
description | string Description of the chart. |
filter_str | string Test filter selector to show KPI values for. |
test_case | string Test case to show KPI values for. |
kpis[] | report.Kpi KPIs to show. |
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
|
TextWidget
Field | Description |
---|---|
text | string Text string. |
TitleWidget
Field | Description |
---|---|
text | string Title string. |
size | enum TitleSize Title size.
|
List
Retrieves the list of regression dashboards in the specified folder.
rpc List (ListRegressionDashboardsRequest) returns (ListRegressionDashboardsResponse)
ListRegressionDashboardsRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list dashboards in. The maximum string length in characters is 50. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListRegressionDashboardsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000. |
page_token | string Page token. To get the next page of results, set page_token to the ListRegressionDashboardsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100. |
filter | string A filter expression that filters dashboards listed in the response. The filter expression may contain multiple field expressions joined by AND . The field expression must specify:
Currently supported fields:
Examples:
|
ListRegressionDashboardsResponse
Field | Description |
---|---|
dashboards[] | regression.Dashboard List of dashboards in the specified folder. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListRegressionDashboardsRequest.page_size, use next_page_token as the value for the ListRegressionDashboardsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. The maximum string length in characters is 100. |
Dashboard
Field | Description |
---|---|
id | string ID of the dashboard. |
name | string Name of the dashboard. |
description | string Description of the dashboard. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Last update timestamp. |
created_by | string UA or SA that created the dashboard. |
updated_by | string UA or SA that updated the dashboard last time. |
etag | string Etag of the dashboard. |
content | Content Dashboard content. |
Content
Field | Description |
---|---|
widgets[] | Widget Widgets. |
Widget
Field | Description |
---|---|
position | LayoutPosition Widget position. |
widget | oneof: chart , text or title |
chart | ChartWidget Chart widget. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 X. |
y | int64 Y. |
width | int64 Width. |
height | int64 Height. |
ChartWidget
Field | Description |
---|---|
id | string ID of the chart. |
name | string Name of the chart. |
description | string Description of the chart. |
filter_str | string Test filter selector to show KPI values for. |
test_case | string Test case to show KPI values for. |
kpis[] | report.Kpi KPIs to show. |
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
|
TextWidget
Field | Description |
---|---|
text | string Text string. |
TitleWidget
Field | Description |
---|---|
text | string Title string. |
size | enum TitleSize Title size.
|
Delete
Deletes the specified regression dashboard.
rpc Delete (DeleteRegressionDashboardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteRegressionDashboardMetadata
Operation.response:google.protobuf.Empty
DeleteRegressionDashboardRequest
Field | Description |
---|---|
dashboard_id | string Required. ID of the dashboard to delete. The maximum string length in characters is 50. |
etag | string The current etag of the dashboard. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteRegressionDashboardMetadata
Field | Description |
---|---|
dashboard_id | string ID of the dashboard that is being deleted. |
Update
Updates the specified regression dashboard.
rpc Update (UpdateRegressionDashboardRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateRegressionDashboardMetadata
Operation.response:regression.Dashboard
UpdateRegressionDashboardRequest
Field | Description |
---|---|
dashboard_id | string Required. ID of the dashboards to update. |
etag | string The current etag of the dashboard. |
update_mask | google.protobuf.FieldMask Field mask that specifies which attributes of the dashboard are going to be updated. |
name | string New name of the dashboard. Value must match the regular expression |[a-z][-a-z0-9]{1,61}[a-z0-9] . |
description | string New description of the dashboard. The maximum string length in characters is 1024. |
content | regression.Dashboard.Content New content of the dashboard. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateRegressionDashboardMetadata
Field | Description |
---|---|
dashboard_id | string ID of the dashboard that is being updated. |
Dashboard
Field | Description |
---|---|
id | string ID of the dashboard. |
name | string Name of the dashboard. |
description | string Description of the dashboard. |
created_at | google.protobuf.Timestamp Creation timestamp. |
updated_at | google.protobuf.Timestamp Last update timestamp. |
created_by | string UA or SA that created the dashboard. |
updated_by | string UA or SA that updated the dashboard last time. |
etag | string Etag of the dashboard. |
content | Content Dashboard content. |
Content
Field | Description |
---|---|
widgets[] | Widget Widgets. |
Widget
Field | Description |
---|---|
position | LayoutPosition Widget position. |
widget | oneof: chart , text or title |
chart | ChartWidget Chart widget. |
text | TextWidget Text widget. |
title | TitleWidget Title widget. |
LayoutPosition
Field | Description |
---|---|
x | int64 X. |
y | int64 Y. |
width | int64 Width. |
height | int64 Height. |
ChartWidget
Field | Description |
---|---|
id | string ID of the chart. |
name | string Name of the chart. |
description | string Description of the chart. |
filter_str | string Test filter selector to show KPI values for. |
test_case | string Test case to show KPI values for. |
kpis[] | report.Kpi KPIs to show. |
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
|
TextWidget
Field | Description |
---|---|
text | string Text string. |
TitleWidget
Field | Description |
---|---|
text | string Title string. |
size | enum TitleSize Title size.
|