Functions | Variables
performance.loadtest_config Namespace Reference

Functions

None clear_empty_fields (Dict[str, Any] config)
 
str component_name (Iterable[str] elements)
 
Type[yaml.SafeDumper] config_dumper (str header_comment)
 
str default_prefix ()
 
Iterable[Dict[str, Any]] gen_loadtest_configs (Mapping[str, Any] base_config, Iterable[Mapping[str, Any]] base_config_clients, Iterable[Mapping[str, Any]] base_config_servers, str scenario_name_regex, scenario_config_exporter.LanguageConfig language_config, str loadtest_name_prefix, Iterable[str] uniquifier_elements, Mapping[str, str] annotations, int instances_per_client=1, int runs_per_test=1, Callable[[Iterable[Mapping[str, Any]]], List[Dict[str, Any]]] scenario_transform=lambda s:s)
 
Iterable[str] gen_run_indices (int runs_per_test)
 
str loadtest_base_name (str scenario_name, Iterable[str] uniquifier_elements)
 
str loadtest_name (str prefix, str scenario_name, Iterable[str] uniquifier_elements)
 
None main ()
 
str now_string ()
 
Dict[str, str] parse_key_value_args (Optional[Iterable[str]] args)
 
str safe_name (str language)
 
def scenario_name (str base_name, Optional[int] client_channels, Optional[int] server_threads, Optional[int] offered_load)
 
Optional[Callable[[Iterable[Mapping[str, Any]]], Iterable[Mapping[str, Any]]]] scenario_transform_function (Optional[int] client_channels, Optional[int] server_threads, Optional[Iterable[int]] offered_loads)
 
None validate_annotations (Dict[str, str] annotations)
 
None validate_loadtest_name (str name)
 

Variables

string CONFIGURATION_FILE_HEADER_COMMENT
 

Function Documentation

◆ clear_empty_fields()

None performance.loadtest_config.clear_empty_fields ( Dict[str, Any config)
Clears fields set to empty values by string substitution.

Definition at line 319 of file loadtest_config.py.

◆ component_name()

str performance.loadtest_config.component_name ( Iterable[str]  elements)
Constructs a component name from possibly empty elements.

Definition at line 95 of file loadtest_config.py.

◆ config_dumper()

Type[yaml.SafeDumper] performance.loadtest_config.config_dumper ( str  header_comment)
Returns a custom dumper to dump configurations in the expected format.

Definition at line 342 of file loadtest_config.py.

◆ default_prefix()

str performance.loadtest_config.default_prefix ( )
Constructs and returns a default prefix for LoadTest names.

Definition at line 53 of file loadtest_config.py.

◆ gen_loadtest_configs()

Iterable[Dict[str, Any]] performance.loadtest_config.gen_loadtest_configs ( Mapping[str, Any base_config,
Iterable[Mapping[str, Any]]  base_config_clients,
Iterable[Mapping[str, Any]]  base_config_servers,
str  scenario_name_regex,
scenario_config_exporter.LanguageConfig  language_config,
str  loadtest_name_prefix,
Iterable[str]  uniquifier_elements,
Mapping[str, str]  annotations,
int   instances_per_client = 1,
int   runs_per_test = 1,
Callable[[Iterable[Mapping[str, Any]]], List[Dict[str, Any]]]   scenario_transform = lambda s: s 
)
Generates LoadTest configurations for a given language config.

The LoadTest configurations are generated as YAML objects.

Definition at line 180 of file loadtest_config.py.

◆ gen_run_indices()

Iterable[str] performance.loadtest_config.gen_run_indices ( int  runs_per_test)
Generates run indices for multiple runs, as formatted strings.

Definition at line 110 of file loadtest_config.py.

◆ loadtest_base_name()

str performance.loadtest_config.loadtest_base_name ( str  scenario_name,
Iterable[str]  uniquifier_elements 
)
Constructs and returns the base name for a LoadTest resource.

Definition at line 74 of file loadtest_config.py.

◆ loadtest_name()

str performance.loadtest_config.loadtest_name ( str  prefix,
str  scenario_name,
Iterable[str]  uniquifier_elements 
)
Constructs and returns a valid name for a LoadTest resource.

Definition at line 82 of file loadtest_config.py.

◆ main()

None performance.loadtest_config.main ( )

Definition at line 365 of file loadtest_config.py.

◆ now_string()

str performance.loadtest_config.now_string ( )
Returns the current date and time in string format.

Definition at line 58 of file loadtest_config.py.

◆ parse_key_value_args()

Dict[str, str] performance.loadtest_config.parse_key_value_args ( Optional[Iterable[str]]  args)
Parses arguments in the form key=value into a dictionary.

Definition at line 306 of file loadtest_config.py.

◆ safe_name()

str performance.loadtest_config.safe_name ( str  language)
Returns a name that is safe to use in labels and file names.

Definition at line 48 of file loadtest_config.py.

◆ scenario_name()

def performance.loadtest_config.scenario_name ( str  base_name,
Optional[int client_channels,
Optional[int server_threads,
Optional[int offered_load 
)
Constructs scenario name from base name and modifiers.

Definition at line 121 of file loadtest_config.py.

◆ scenario_transform_function()

Optional[Callable[[Iterable[Mapping[str, Any]]], Iterable[Mapping[str, Any]]]] performance.loadtest_config.scenario_transform_function ( Optional[int client_channels,
Optional[int server_threads,
Optional[Iterable[int]]   offered_loads 
)
Returns a transform to be applied to a list of scenarios.

Definition at line 135 of file loadtest_config.py.

◆ validate_annotations()

None performance.loadtest_config.validate_annotations ( Dict[str, str]  annotations)
Validates that annotations do not contain reserved names.

These names are automatically added by the config generator.

Definition at line 100 of file loadtest_config.py.

◆ validate_loadtest_name()

None performance.loadtest_config.validate_loadtest_name ( str  name)
Validates that a LoadTest name is in the expected format.

Definition at line 63 of file loadtest_config.py.

Variable Documentation

◆ CONFIGURATION_FILE_HEADER_COMMENT

string performance.loadtest_config.CONFIGURATION_FILE_HEADER_COMMENT
Initial value:
1 = """
2 # Load test configurations generated from a template by loadtest_config.py.
3 # See documentation below:
4 # https://github.com/grpc/grpc/blob/master/tools/run_tests/performance/README.md#grpc-oss-benchmarks
5 """

Definition at line 41 of file loadtest_config.py.



grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:41