Batchlet Configuration Details

Top-level configuration schema

Key	Description	Type	Default	Required	Nullable
command	List containing the command and its arguments.	list		Yes	No
dask_params	Configuration options for the Dask cluster. If null, batchlet does not start the dask cluster, and runs the command directly as a subprocess.	object	null	No	Yes
monitor	Configuration options for monitoring. If null, monitoring is disabled.	object	null	No	Yes
generate_reports_on_failure	Whether to generate performance/monitoring reports even if the command fails for any reason. If set to false and if the command subprocess fails, batchlet will clear reports generated by it.	boolean	true	No	No

dask_params schema

Key	Description	Type	Default	Required	Nullable
dask_cli_option	The cli option of the command which takes dask scheduler ip as input. If not given, batchlet does not spin up a dask cluster, and runs the command directly as a subprocess.	string	null	No	Yes
dask_report_dir	Enable Dask performance tracking and store the report at the specified path, if it is valid.	string	null	No	Yes

Rest of the allowed keys are same as the parameters accepted by the batchlet managed dask clusters:

1. DaskSlurmCluster API.

2. DaskLocalCluster API.

monitor schema

Key	Description	Type	Default	Required	Nullable
resources	Configuration for starting hardware resource monitoring using benchmon.	dict	{}	No	Yes
logs	Configuration for starting log monitoring using batchlet plugins.	dict	{}	No	Yes

resources schema

Key	Description	Type	Default	Required	Nullable
level	Monitoring level. Supported values: 0, 1, or 2	integer	0	No	No
save_dir	Directory path where monitoring output is saved. This is also the path which acts as current_working_directory for all monitor related processes.	string	"./benchmon-work-dir"	No	No

logs schema

Key	Description	Type	Default	Required	Nullable
filter_plugins	List of filter plugins with their configuration	list of dictionary	null	Yes	No
consumer_plugins	List of consumer plugins with their configuration	list of dictionary	null	Yes	No

Each filter or consumer plugin may contain following keys:

Key	Description	Type	Default	Required	Nullable
name	The plugin class. An instance of this class will be created by log monitor.	string		Yes	No
kwargs	Dictionary of arguments to pass to the plugin (specific to the plugin).	dictionary		No	No
path	Optional path to the plugin module file from which the plugin class will be imported by log monitor	string		No	No