Parameters of a Simple Template File

MySQL

**Table 1** Parameters in the **task_MySQL.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, MySQL.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Names of the parameter group involved in tuning, for example, MySQL.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed.
app/version	Application version.
app/mysql_username	MySQL user name.
app/mysql_exe_path	Path to the MySQL executable file.
app/mysqld_exe_path	Path to the mysqld executable file.
app/config_file_path	Path to the MySQL configuration file.
app/test_tool/name	Name of the performance test tool.
app/test_tool/host_name	Name of the server where the performance test tool is located.
app/test_tool/tool_path	Path to the performance test tool.
app/test_tool/version	Version of the performance test tool.
app/test_tool/case_name	Name of the test case used by the performance test tool.
app/test_tool/case_path	Path to the test case used by the performance test tool.
app/test_tool/database_name	Name of the database used in the performance test tool.
app/test_tool/exec_duration	Execution duration of the performance test tool, which defaults to 60 seconds.
app/test_tool/thread_number	Number of threads used by the performance test tool, which defaults to 32.
app/test_tool/oltp_tables_count	Number of OLTP tables used by the performance test tool, which defaults to 10.
app/test_tool/oltp_table_size	Size of OLTP tables used by the performance test tool, which defaults to 1,000.
app/test_tool/tune_metric	Performance metric used by the performance test tool, which defaults to tps.
app/data_dir	MySQL data directory.
app/socket	Path to the MySQL socket file.
app/port	Port used by the MySQL database, which defaults to 3306.
app/host_ip	IP address of the active MySQL node.

openGauss

**Table 2** Parameters in the **task_Opengauss.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Opengauss.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Opengauss.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/version	Application version.
app/host_name	Name of the application server.
app/system_username	Name of the OS user who runs the application.
app/data_node_path	Data node directory of the application.
app/test_tool/test_tool_name	Name of the performance test tool, which defaults to benchmarksql.
app/test_tool/test_tool_version	Version of the performance test tool, which defaults to 5.0.
app/test_tool/host_name	Name of the server where the performance test tool is located.
app/test_tool/config_path	Path to the configuration file of the performance test tool.
app/test_tool/script_path	Path to the test script of the performance test tool.

Vastbase

**Table 3** Parameters in the **task_Vastbase.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Vastbase.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Vastbase.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/version	Application version, which defaults to G100.
app/host_name	Name of the server on which the application is to be executed.
app/system_username	Name of the OS user who runs the application.
app/data_node_path	Path to the application data node.
app/test_tool/test_tool_name	Name of the performance test tool, which defaults to benchmarksql.
app/test_tool/test_tool_version	Version of the performance test tool, which defaults to 5.0.
app/test_tool/host_name	Name of the server where the performance test tool is located.
app/test_tool/config_path	Path to the configuration file of the performance test tool.
app/test_tool/script_path	Path to the script file of the performance test tool.

RocksDB

**Table 4** Parameters in the **task_Rocksdb.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Rocksdb.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Rocksdb.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed.
app/version	Application version.
app/database_dir	Path to the database used by the application.
app/test_tool/name	Name of the performance test tool, which defaults to rocksdb_dbbench.
app/test_tool/benchmarksql_list	List of performance test cases, which defaults to fillseq.
app/test_tool/key_size	Key size of the performance test case, which defaults to 10.
app/test_tool/value_size	Value size of the performance test case, which defaults to 830.
app/test_tool/num	Number of key-value pairs stored in the RocksDB database during the performance test, which defaults to 10,000.
app/test_tool/thread_number	Number of threads used by the performance test tool, which defaults to 16.
app/test_tool/cache_size	Size of the cache used by the performance test tool, which defaults to 16,777,216 KB.
app/test_tool/exec_duration	Performance test duration.
app/test_tool/test_tool_path	Path to the performance test tool.

PostgreSQL

**Table 5** Parameters in the **task_Postgresql.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Postgresql.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Postgresql.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/version	Application version.
app/host_name	Name of the server on which the application is to be executed.
app/system_username	Name of the OS user who runs the application.
app/app_exe_path	Path to the application folder.
app/data_node_path	Path to the application data node.
app/test_tool/host_name	Name of the server where the performance test tool is located.
app/test_tool/test_tool_name	Name of the performance test tool, which defaults to benchmarksql.
app/test_tool/test_tool_version	Version of the performance test tool, which defaults to 5.0.
app/test_tool/config_path	Path to the configuration file of the performance test tool.
app/test_tool/script_path	Path to the script file of the performance test tool.

Redis

**Table 6** Parameters in the **task_Redis.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Redis.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Redis.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed. If this parameter is not set, the task is executed on the local server by default.
app/version	Application version.
app/app_bind_cpu	IDs of the CPU cores bound to run the application.
app/app_exe_path	Path to the application executable file.
app/app_port	Port used by the application, which defaults to 6379.
app/app_config_path	Path to the application configuration files.
app/app_data_path	Path to the application data files.
app/test_tool/bind_cpu	IDs of the CPU cores bound to run the performance test tool.
app/test_tool/clients	Number of client connections for the performance test, which defaults to 50.
app/test_tool/requests_number	Number of requests processed during the performance test, which defaults to 100,000.
app/test_tool/data_size	Data size for the performance test, which defaults to 3.
app/test_tool/dbnum	ID of the database used for the performance test, which defaults to 0.
app/test_tool/keyspacelen	Random key length within the specified range hit during a performance test. The default value is 100000.
app/test_tool/testtype	List of pressure test types during a performance test, which defaults to set.

Hive

**Table 7** Parameters in the **task_Hive.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Hive.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Hive.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed.
app/version	Application version.
app/app_exe_path	Path to the application folder.
app/test_tool/name	Name of the performance test tool, which defaults to hive_tpcds.
app/test_tool/tpcds_sql_index_list	List of the performance test cases, which defaults to [ 1 ].
app/test_tool/database_name	Name of the database used in the performance test.

Flink

**Table 8** Parameters in the **task_Flink_hibench.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Flink.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Names of the parameter groups involved in tuning, for example, Flink and hibench.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed.
app/version	Application version.
app/exe_path	Path to the application executable file, which defaults to /path/flink/bin.
app/master_type	Application running mode, which is yarn (default) or standalone.
app/startup_params	Application startup parameter.
app/test_tool/name	Name of the performance test tool, which defaults to /path/HiBench.
app/test_tool/host_name	Name of the server where the performance test tool is located.
app/test_tool/exec_duration	Performance test duration, which defaults to 180 seconds.
app/test_tool/test_tool_path	Path to the performance test tool.
app/test_tool/hibench_datagen_throughput	Data throughput of the performance test tool, which defaults to 600K.
app/test_tool/version	Version of the performance test tool, which defaults to 7.0.
app/test_tool/case_name	Name of the performance test case, which defaults to identity.
app/test_tool/tune_metric	Performance test metric, which defaults to latency.
app/test_tool/kafka_broker_list	Kafka broker list for the performance test, which defaults to localhost:9092.
app/test_tool/kafka_topic_partitions	Kafka topic partition for the performance test, which default to 1.
app/test_tool/kafka_topic_sh_path	Path to the script used by Kafka to execute topics during the performance test, which defaults to /path/kafka/bin/kafka-topics.sh.

Kafka

**Table 9** Parameters in the **task_Kafka.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Kafka.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Kafka.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed.
app/version	Application version.
app/exe_path	Path to the application folder.
app/config_path	Path to the application configuration files.
app/test_tool/name	Name of the performance test tool, which defaults to kafka_perf.
app/test_tool/broker_list	Broker list for the performance test, which defaults to localhost:9092.
app/test_tool/testtopic	Topic name for the performance test, which default to testtopic.
app/test_tool/num_records	Total number of messages generated during the performance test, which defaults to 1,000,000.
app/test_tool/record_size	Size of each message generated during the performance test, which defaults to 1,024 bytes.
app/test_tool/throughput	Throughput for the performance test, which defaults to a maximum of 300,000 messages per second.
app/test_tool/partitions	Number of partitions used in the performance test, which defaults to 72.
app/test_tool/replication_factor	Number of replicas used in the performance test, which defaults to 1.

Spark

**Table 10** Parameters in the **task_Spark.json** template file
Parameter	Description
template_type	Name of the application to be tuned, for example, Spark.
hosts_list	List of servers involved in the task. If this parameter is not set, the task is executed on the local server by default.
hosts_list/name	Server name.
hosts_list/ip	Server IP address.
hosts_list/username	User who executes the task.
hosts_list/port	Port used for a remote connection, which defaults to 22.
configs/rounds	Total number of tuning rounds, which defaults to 50.
configs/max_failure	Total allowed number of failed rounds during tuning, which defaults to 10.
assign_params/name	Name of the parameter group involved in tuning, which defaults to Spark.
assign_params/enable	Indicates whether to tune the parameter group, which defaults to true.
app/host_name	Name of the server on which the application is to be executed.
app/version	Application version.
app/app_exe_path	Path to the application folder.
app/omni_home_dir	OmniOperator directory.
app/master	Master node of the application cluster.
app/master_type	Application deployment mode, which is yarn or standalone.
app/test_tool/name	Name of the performance test tool, which defaults to spark_tpcds.
app/test_tool/tpcds_sql_index_list	List of performance test cases.
app/test_tool/database_name	Name of the database used in the performance test.

Parent topic: Generating a Template File