Load Testing API, gRPC: TestService
A set of methods for managing tests.
Call | Description |
---|---|
Create | Creates (runs) a test in the specified folder. |
Get | Returns the specified test. |
Stop | Stops the specified test. |
Delete | Deletes specified tests. |
List | Retrieves the list of test in the specified folder. |
Calls TestService
Create
Creates (runs) a test in the specified folder.
rpc Create (CreateTestRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateTestMetadata
Operation.response:test.Test
CreateTestRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a test in. The maximum string length in characters is 50. |
configurations[] | test.SingleAgentConfiguration Test configuration associated with agents on which they will be executed. In case of multiple configurations, a multitest will be created. |
test_details | test.Details Test details. Name, tags etc. |
SingleAgentConfiguration
Field | Description |
---|---|
config_id | string ID of the config. |
agent_selector | AgentSelector Agent selection criterion. |
files | map<string,FilePointer> Additional files to be used during test execution, represented as rel_path:file pairs. rel_path can be either a simple file name, a relative path, or absolute path. Files are downloaded by the agent to appropriate location. Use cases include:
|
AgentSelector
Field | Description |
---|---|
agent | oneof: agent_id , match_by_filter or anonymous_agent |
agent_id | string Selection by agent ID. |
match_by_filter | string Selection by filter string. |
anonymous_agent | bool Select anonymoud (i.e. not registered) agents. |
Details
Field | Description |
---|---|
name | string Name of the test. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the test. The maximum string length in characters is 256. |
tags[] | common.Tag Tags assigned to the test. |
logging_log_group_id | string ID of the logging group to which test artifacts are uploaded. |
artifact_settings | ArtifactSettings Settings which define where to upload test artifacts and which files should be included. |
Tag
Field | Description |
---|---|
key | string Key of the tag. |
value | string Value of the tag. |
ArtifactSettings
Field | Description |
---|---|
upload_to | oneof: object_storage_bucket |
object_storage_bucket | string Name of output object storage bucket in test's folder. |
is_archive | bool Setting which defines whether artifact files should be archived prior to uploading. |
filter_include[] | string Filter strings defining which files should be included to artifacts. GLOB format. Example:
|
filter_exclude[] | string Filter strings defining which files should be excluded from artifacts. GLOB format. Example:
|
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. |
CreateTestMetadata
Field | Description |
---|---|
test_id | string ID of the test that is being created. |
Test
Field | Description |
---|---|
id | string ID of the test. Generated at creation time. |
configurations[] | SingleAgentConfiguration Configuration of the test. A test can have multiple configurations if it can be executed on multiple agents simultaneously. For more information, see Load testing using multiple agents. |
details | Details Test meta information. Name, description, etc. |
summary | Summary Test execution information. |
folder_id | string ID of the folder that the test belongs to. |
SingleAgentConfiguration
Field | Description |
---|---|
config_id | string ID of the config. |
agent_selector | AgentSelector Agent selection criterion. |
files | map<string,FilePointer> Additional files to be used during test execution, represented as rel_path:file pairs. rel_path can be either a simple file name, a relative path, or absolute path. Files are downloaded by the agent to appropriate location. Use cases include:
|
Details
Field | Description |
---|---|
name | string Name of the test. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the test. The maximum string length in characters is 256. |
tags[] | common.Tag Tags assigned to the test. |
logging_log_group_id | string ID of the logging group to which test artifacts are uploaded. |
artifact_settings | ArtifactSettings Settings which define where to upload test artifacts and which files should be included. |
Summary
Field | Description |
---|---|
status | enum Status Status of the test.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string UA or SA that created the test. |
started_at | google.protobuf.Timestamp Test start timestamp. Empty if the test has not been started yet. |
finished_at | google.protobuf.Timestamp Test finish timestamp. Empty if the test has not been finished yet. |
is_finished | bool Indicates whether the test is finished. |
error | string Error message. |
imbalance_point | ImbalancePoint Detected imbalance point. Contains information about a state at the moment it has been auto-stopped. Empty if no auto-stop occured. |
assigned_agent_id | string ID of the agent that executed the test. |
artifacts | FilePointer Test output artifacts. Link to the artifacts output target containing .log and other files collected during test execution. |
ImbalancePoint
Field | Description |
---|---|
at | google.protobuf.Timestamp Imbalance moment timestamp. |
rps | int64 Imbalance moment RPS. |
comment | string Imbalance reason comment. |
FilePointer
Field | Description |
---|---|
file_pointer | oneof: object_storage |
object_storage | ObjectStorage Reference to a file in Object Storage. |
ObjectStorage
Field | Description |
---|---|
bucket | string Bucket name. |
name | string File name. |
Get
Returns the specified test.
To get the list of all available tests, make a List request.
rpc Get (GetTestRequest) returns (test.Test)
GetTestRequest
Field | Description |
---|---|
test_id | string Required. ID of the test to return. |
Test
Field | Description |
---|---|
id | string ID of the test. Generated at creation time. |
configurations[] | SingleAgentConfiguration Configuration of the test. A test can have multiple configurations if it can be executed on multiple agents simultaneously. For more information, see Load testing using multiple agents. |
details | Details Test meta information. Name, description, etc. |
summary | Summary Test execution information. |
folder_id | string ID of the folder that the test belongs to. |
SingleAgentConfiguration
Field | Description |
---|---|
config_id | string ID of the config. |
agent_selector | AgentSelector Agent selection criterion. |
files | map<string,FilePointer> Additional files to be used during test execution, represented as rel_path:file pairs. rel_path can be either a simple file name, a relative path, or absolute path. Files are downloaded by the agent to appropriate location. Use cases include:
|
AgentSelector
Field | Description |
---|---|
agent | oneof: agent_id , match_by_filter or anonymous_agent |
agent_id | string Selection by agent ID. |
match_by_filter | string Selection by filter string. |
anonymous_agent | bool Select anonymoud (i.e. not registered) agents. |
Details
Field | Description |
---|---|
name | string Name of the test. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the test. The maximum string length in characters is 256. |
tags[] | common.Tag Tags assigned to the test. |
logging_log_group_id | string ID of the logging group to which test artifacts are uploaded. |
artifact_settings | ArtifactSettings Settings which define where to upload test artifacts and which files should be included. |
Tag
Field | Description |
---|---|
key | string Key of the tag. |
value | string Value of the tag. |
ArtifactSettings
Field | Description |
---|---|
upload_to | oneof: object_storage_bucket |
object_storage_bucket | string Name of output object storage bucket in test's folder. |
is_archive | bool Setting which defines whether artifact files should be archived prior to uploading. |
filter_include[] | string Filter strings defining which files should be included to artifacts. GLOB format. Example:
|
filter_exclude[] | string Filter strings defining which files should be excluded from artifacts. GLOB format. Example:
|
Summary
Field | Description |
---|---|
status | enum Status Status of the test.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string UA or SA that created the test. |
started_at | google.protobuf.Timestamp Test start timestamp. Empty if the test has not been started yet. |
finished_at | google.protobuf.Timestamp Test finish timestamp. Empty if the test has not been finished yet. |
is_finished | bool Indicates whether the test is finished. |
error | string Error message. |
imbalance_point | ImbalancePoint Detected imbalance point. Contains information about a state at the moment it has been auto-stopped. Empty if no auto-stop occured. |
assigned_agent_id | string ID of the agent that executed the test. |
artifacts | FilePointer Test output artifacts. Link to the artifacts output target containing .log and other files collected during test execution. |
ImbalancePoint
Field | Description |
---|---|
at | google.protobuf.Timestamp Imbalance moment timestamp. |
rps | int64 Imbalance moment RPS. |
comment | string Imbalance reason comment. |
FilePointer
Field | Description |
---|---|
file_pointer | oneof: object_storage |
object_storage | ObjectStorage Reference to a file in Object Storage. |
ObjectStorage
Field | Description |
---|---|
bucket | string Bucket name. |
name | string File name. |
Stop
Stops the specified test.
rpc Stop (StopTestRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:StopTestMetadata
Operation.response:test.Test
StopTestRequest
Field | Description |
---|---|
test_id | string ID of the test to stop. |
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. |
StopTestMetadata
Field | Description |
---|---|
test_id | string ID of the test that is being stopped. |
Test
Field | Description |
---|---|
id | string ID of the test. Generated at creation time. |
configurations[] | SingleAgentConfiguration Configuration of the test. A test can have multiple configurations if it can be executed on multiple agents simultaneously. For more information, see Load testing using multiple agents. |
details | Details Test meta information. Name, description, etc. |
summary | Summary Test execution information. |
folder_id | string ID of the folder that the test belongs to. |
SingleAgentConfiguration
Field | Description |
---|---|
config_id | string ID of the config. |
agent_selector | AgentSelector Agent selection criterion. |
files | map<string,FilePointer> Additional files to be used during test execution, represented as rel_path:file pairs. rel_path can be either a simple file name, a relative path, or absolute path. Files are downloaded by the agent to appropriate location. Use cases include:
|
AgentSelector
Field | Description |
---|---|
agent | oneof: agent_id , match_by_filter or anonymous_agent |
agent_id | string Selection by agent ID. |
match_by_filter | string Selection by filter string. |
anonymous_agent | bool Select anonymoud (i.e. not registered) agents. |
Details
Field | Description |
---|---|
name | string Name of the test. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the test. The maximum string length in characters is 256. |
tags[] | common.Tag Tags assigned to the test. |
logging_log_group_id | string ID of the logging group to which test artifacts are uploaded. |
artifact_settings | ArtifactSettings Settings which define where to upload test artifacts and which files should be included. |
Tag
Field | Description |
---|---|
key | string Key of the tag. |
value | string Value of the tag. |
ArtifactSettings
Field | Description |
---|---|
upload_to | oneof: object_storage_bucket |
object_storage_bucket | string Name of output object storage bucket in test's folder. |
is_archive | bool Setting which defines whether artifact files should be archived prior to uploading. |
filter_include[] | string Filter strings defining which files should be included to artifacts. GLOB format. Example:
|
filter_exclude[] | string Filter strings defining which files should be excluded from artifacts. GLOB format. Example:
|
Summary
Field | Description |
---|---|
status | enum Status Status of the test.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string UA or SA that created the test. |
started_at | google.protobuf.Timestamp Test start timestamp. Empty if the test has not been started yet. |
finished_at | google.protobuf.Timestamp Test finish timestamp. Empty if the test has not been finished yet. |
is_finished | bool Indicates whether the test is finished. |
error | string Error message. |
imbalance_point | ImbalancePoint Detected imbalance point. Contains information about a state at the moment it has been auto-stopped. Empty if no auto-stop occured. |
assigned_agent_id | string ID of the agent that executed the test. |
artifacts | FilePointer Test output artifacts. Link to the artifacts output target containing .log and other files collected during test execution. |
ImbalancePoint
Field | Description |
---|---|
at | google.protobuf.Timestamp Imbalance moment timestamp. |
rps | int64 Imbalance moment RPS. |
comment | string Imbalance reason comment. |
FilePointer
Field | Description |
---|---|
file_pointer | oneof: object_storage |
object_storage | ObjectStorage Reference to a file in Object Storage. |
ObjectStorage
Field | Description |
---|---|
bucket | string Bucket name. |
name | string File name. |
Delete
Deletes specified tests.
rpc Delete (DeleteTestRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteTestMetadata
Operation.response:google.protobuf.Empty
DeleteTestRequest
Field | Description |
---|---|
test_id | string ID of the test to delete. |
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. |
DeleteTestMetadata
Field | Description |
---|---|
test_id | string ID of the test that is being deleted. |
List
Retrieves the list of test in the specified folder.
rpc List (ListTestsRequest) returns (ListTestsResponse)
ListTestsRequest
Field | Description |
---|---|
folder_id | string ID of the folder to list tests in. |
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 ListTestsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. |
page_token | string Page token. To get the next page of results, set page_token to the ListTestsResponse.next_page_token returned by a previous list request. |
filter | string A filter expression that filters tests listed in the response. The filter expression may contain multiple field expressions joined by AND . The field expression must specify:
Currently supported fields:
Examples:
|
ListTestsResponse
Field | Description |
---|---|
tests[] | test.Test List of tests 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 ListTestsRequest.page_size, use next_page_token as the value for the ListTestsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Test
Field | Description |
---|---|
id | string ID of the test. Generated at creation time. |
configurations[] | SingleAgentConfiguration Configuration of the test. A test can have multiple configurations if it can be executed on multiple agents simultaneously. For more information, see Load testing using multiple agents. |
details | Details Test meta information. Name, description, etc. |
summary | Summary Test execution information. |
folder_id | string ID of the folder that the test belongs to. |
SingleAgentConfiguration
Field | Description |
---|---|
config_id | string ID of the config. |
agent_selector | AgentSelector Agent selection criterion. |
files | map<string,FilePointer> Additional files to be used during test execution, represented as rel_path:file pairs. rel_path can be either a simple file name, a relative path, or absolute path. Files are downloaded by the agent to appropriate location. Use cases include:
|
AgentSelector
Field | Description |
---|---|
agent | oneof: agent_id , match_by_filter or anonymous_agent |
agent_id | string Selection by agent ID. |
match_by_filter | string Selection by filter string. |
anonymous_agent | bool Select anonymoud (i.e. not registered) agents. |
Details
Field | Description |
---|---|
name | string Name of the test. Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])? . |
description | string Description of the test. The maximum string length in characters is 256. |
tags[] | common.Tag Tags assigned to the test. |
logging_log_group_id | string ID of the logging group to which test artifacts are uploaded. |
artifact_settings | ArtifactSettings Settings which define where to upload test artifacts and which files should be included. |
Tag
Field | Description |
---|---|
key | string Key of the tag. |
value | string Value of the tag. |
ArtifactSettings
Field | Description |
---|---|
upload_to | oneof: object_storage_bucket |
object_storage_bucket | string Name of output object storage bucket in test's folder. |
is_archive | bool Setting which defines whether artifact files should be archived prior to uploading. |
filter_include[] | string Filter strings defining which files should be included to artifacts. GLOB format. Example:
|
filter_exclude[] | string Filter strings defining which files should be excluded from artifacts. GLOB format. Example:
|
Summary
Field | Description |
---|---|
status | enum Status Status of the test.
|
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string UA or SA that created the test. |
started_at | google.protobuf.Timestamp Test start timestamp. Empty if the test has not been started yet. |
finished_at | google.protobuf.Timestamp Test finish timestamp. Empty if the test has not been finished yet. |
is_finished | bool Indicates whether the test is finished. |
error | string Error message. |
imbalance_point | ImbalancePoint Detected imbalance point. Contains information about a state at the moment it has been auto-stopped. Empty if no auto-stop occured. |
assigned_agent_id | string ID of the agent that executed the test. |
artifacts | FilePointer Test output artifacts. Link to the artifacts output target containing .log and other files collected during test execution. |
ImbalancePoint
Field | Description |
---|---|
at | google.protobuf.Timestamp Imbalance moment timestamp. |
rps | int64 Imbalance moment RPS. |
comment | string Imbalance reason comment. |
FilePointer
Field | Description |
---|---|
file_pointer | oneof: object_storage |
object_storage | ObjectStorage Reference to a file in Object Storage. |
ObjectStorage
Field | Description |
---|---|
bucket | string Bucket name. |
name | string File name. |