Load Testing API, gRPC: RegressionDashboardService.Create
- gRPC request
- CreateRegressionDashboardRequest
- Content
- Widget
- LayoutPosition
- ChartWidget
- Kpi
- KpiSelector
- ResponseTime
- Instances
- ImbalanceRps
- ProtocolCodesAbsolute
- ProtocolCodesRelative
- NetworkCodesAbsolute
- NetworkCodesRelative
- KpiThreshold
- TextWidget
- TitleWidget
- operation.Operation
- CreateRegressionDashboardMetadata
- Dashboard
- Content
- Widget
- LayoutPosition
- ChartWidget
- Kpi
- KpiSelector
- ResponseTime
- Instances
- ImbalanceRps
- ProtocolCodesAbsolute
- ProtocolCodesRelative
- NetworkCodesAbsolute
- NetworkCodesRelative
- KpiThreshold
- TextWidget
- TitleWidget
Creates a regression dashboard in the specified folder.
gRPC request
rpc Create (CreateRegressionDashboardRequest) returns (operation.Operation)
CreateRegressionDashboardRequest
{
"folderId": "string",
"name": "string",
"description": "string",
"content": {
"widgets": [
{
"position": {
"x": "int64",
"y": "int64",
"width": "int64",
"height": "int64"
},
// Includes only one of the fields `chart`, `text`, `title`
"chart": {
"id": "string",
"name": "string",
"description": "string",
"filterStr": "string",
"testCase": "string",
"kpis": [
{
"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"
}
}
]
},
"text": {
"text": "string"
},
"title": {
"text": "string",
"size": "TitleSize"
}
// end of the list of possible fields
}
]
}
}
Field |
Description |
folderId |
string Required field. ID of the folder to create a regression dashboard in. |
name |
string Name of the dashboard. |
description |
string Description of the dashboard. |
content |
Content of the dashboard. |
Content
Content of regression dashboard.
Field |
Description |
widgets[] |
Widgets. |
Widget
Regression dashboard widget.
Field |
Description |
position |
Widget position. |
chart |
Chart widget. Includes only one of the fields |
text |
Text widget. Includes only one of the fields |
title |
Title widget. Includes only one of the fields |
LayoutPosition
Widget position.
Field |
Description |
x |
int64 X. |
y |
int64 Y. |
width |
int64 Width. |
height |
int64 Height. |
ChartWidget
Regression chart.
Field |
Description |
id |
string ID of the chart. |
name |
string Name of the chart. |
description |
string Description of the chart. |
filterStr |
string Test filter selector to show KPI values for. |
testCase |
string Test case to show KPI values for. |
kpis[] |
KPIs to show. |
Kpi
KPI (Key Performance Indicator) represents some integral indicator measured during test.
Field |
Description |
selector |
Kind of KPI. |
threshold |
A condition that should be specified. |
KpiSelector
KPI selector.
Field |
Description |
responseTime |
Response time cummulative quantile (percentile). Includes only one of the fields |
instances |
A number of instances throughout the test. Includes only one of the fields |
imbalanceRps |
An RPS at the moment the test has been auto-stopped. Includes only one of the fields |
protocolCodesAbsolute |
A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
protocolCodesRelative |
A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
networkCodesAbsolute |
A total number of requests completed with certain network codes. Includes only one of the fields |
networkCodesRelative |
A percentage of requests completed with certain network codes. Includes only one of the fields |
ResponseTime
Response time.
Field |
Description |
quantile |
enum QuantileType Cummulative quantile (percentile).
|
Instances
Aggregated number of instances.
Field |
Description |
agg |
enum Aggregation Aggregation function.
|
ImbalanceRps
Imbalance RPS.
Field |
Description |
Empty |
ProtocolCodesAbsolute
Field |
Description |
codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
ProtocolCodesRelative
Field |
Description |
codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
NetworkCodesAbsolute
Field |
Description |
codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
NetworkCodesRelative
Field |
Description |
codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
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
|
TextWidget
Text widget.
Field |
Description |
text |
string Text string. |
TitleWidget
Title widget.
Field |
Description |
text |
string Title string. |
size |
enum TitleSize Title size.
|
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"dashboardId": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"name": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"updatedAt": "google.protobuf.Timestamp",
"createdBy": "string",
"updatedBy": "string",
"etag": "string",
"content": {
"widgets": [
{
"position": {
"x": "int64",
"y": "int64",
"width": "int64",
"height": "int64"
},
// Includes only one of the fields `chart`, `text`, `title`
"chart": {
"id": "string",
"name": "string",
"description": "string",
"filterStr": "string",
"testCase": "string",
"kpis": [
{
"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"
}
}
]
},
"text": {
"text": "string"
},
"title": {
"text": "string",
"size": "TitleSize"
}
// end of the list of possible fields
}
]
}
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
The time when the Operation resource was last modified. |
done |
bool If the value is |
metadata |
CreateRegressionDashboardMetadata Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateRegressionDashboardMetadata
Field |
Description |
dashboardId |
string ID of the dashboard that is being created. |
Dashboard
Regression dashboard.
Field |
Description |
id |
string ID of the dashboard. |
name |
string Name of the dashboard. |
description |
string Description of the dashboard. |
createdAt |
Creation timestamp. |
updatedAt |
Last update timestamp. |
createdBy |
string UA or SA that created the dashboard. |
updatedBy |
string UA or SA that updated the dashboard last time. |
etag |
string Etag of the dashboard. |
content |
Dashboard content. |
Content
Content of regression dashboard.
Field |
Description |
widgets[] |
Widgets. |
Widget
Regression dashboard widget.
Field |
Description |
position |
Widget position. |
chart |
Chart widget. Includes only one of the fields |
text |
Text widget. Includes only one of the fields |
title |
Title widget. Includes only one of the fields |
LayoutPosition
Widget position.
Field |
Description |
x |
int64 X. |
y |
int64 Y. |
width |
int64 Width. |
height |
int64 Height. |
ChartWidget
Regression chart.
Field |
Description |
id |
string ID of the chart. |
name |
string Name of the chart. |
description |
string Description of the chart. |
filterStr |
string Test filter selector to show KPI values for. |
testCase |
string Test case to show KPI values for. |
kpis[] |
KPIs to show. |
Kpi
KPI (Key Performance Indicator) represents some integral indicator measured during test.
Field |
Description |
selector |
Kind of KPI. |
threshold |
A condition that should be specified. |
KpiSelector
KPI selector.
Field |
Description |
responseTime |
Response time cummulative quantile (percentile). Includes only one of the fields |
instances |
A number of instances throughout the test. Includes only one of the fields |
imbalanceRps |
An RPS at the moment the test has been auto-stopped. Includes only one of the fields |
protocolCodesAbsolute |
A total number of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
protocolCodesRelative |
A percentage of requests completed with certain protocol (HTTP, GRPC, etc.) codes. Includes only one of the fields |
networkCodesAbsolute |
A total number of requests completed with certain network codes. Includes only one of the fields |
networkCodesRelative |
A percentage of requests completed with certain network codes. Includes only one of the fields |
ResponseTime
Response time.
Field |
Description |
quantile |
enum QuantileType Cummulative quantile (percentile).
|
Instances
Aggregated number of instances.
Field |
Description |
agg |
enum Aggregation Aggregation function.
|
ImbalanceRps
Imbalance RPS.
Field |
Description |
Empty |
ProtocolCodesAbsolute
Field |
Description |
codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
ProtocolCodesRelative
Field |
Description |
codesPatterns[] |
string Protocol (HTTP, GRPC) code patterns to match. All successful HTTP responses: ['2xx', '3xx']. |
NetworkCodesAbsolute
Field |
Description |
codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
NetworkCodesRelative
Field |
Description |
codesPatterns[] |
string Network code patterns to match. All successful network responses: ['0']. |
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
|
TextWidget
Text widget.
Field |
Description |
text |
string Text string. |
TitleWidget
Title widget.
Field |
Description |
text |
string Title string. |
size |
enum TitleSize Title size.
|