Diagnostics Command Reference

Use the diagnostics tool to log resource usage on a Duckietown device and push the results to the cloud for analysis.

Syntax

dts diagnostics run \
    [-H ROBOT]                 \   # where the tool itself runs
    -G EXPERIMENT              \   # experiment name
    -d SECONDS                 \   # capture length
    [OPTIONS]

Legacy options

Table 11 Options available to the command dts diagnostics run

Argument	Default	Description
-H --machine	unix:///var/run/docker.sock	Docker socket or hostname where to run the diagnostics image. This is not the monitored target.
-T --target	unix:///var/run/docker.sock	Docker endpoint to monitor.
--type	auto	Specify a device type (e.g., duckiebot, watchtower).
--app-id	Automatic	ID of the API App used to authenticate the upload to the server. Must have access to the data/set API endpoint.
--app-secret	Automatic	Secret of the API App used to authenticate the upload to the server.
-D --database	db_log_default	Name of the logging database. Must be an existing database.
-G --group	Required	Name of the experiment (e.g., new_fan).
-S --subgroup	default	Name of the test within the experiment (e.g., fan_model_X).
-d --duration	Required	Length of the analysis in seconds. Use -1 for an indefinite duration.
-F --filter	[]	Specify regular expressions used to filter the monitored containers.
--system	False	Log system processes as well.
-m --notes	(empty)	Custom notes to attach to the log.
--no-pull	False	Do not pull the diagnostics image before running the experiment.
--debug	False	Run in debug mode.
--vv --verbose	False	Run in verbose mode.
--no-upload	False	Do not upload the statistics to the Duckietown server.