Environment Variables

Several aspects of RADICAL-Pilot (RP) behavior can/must be configured via environment variables. Those variables are exported in the shell from which you will launch your RP application. Usually, environment variables can be set using the export command.

Note

All the variables are optional. You can set them to change/enhance the behavior of RP, depending on your requirements.

Warning

Tables are large, scroll to the right to see the whole table.

End user

Name	Description	Default value
RADICAL_BASE	Root directory where to save temporary state files	$HOME/.radical/
RADICAL_UTILS_NTPHOST	NTP host used for profile syncing	0.pool.ntp.org
RADICAL_PILOT_BULK_CB	Enables bulk callbacks to boost performance. This changes the callback signature	FALSE
RADICAL_PILOT_STRICT_CANCEL	Limits task cancelation by not forcing the state “CANCELLED” on the Task Manager.	{NOT_SET}
RADICAL_DEFAULT_LOG_TGT	Log target	.
RADICAL_DEFAULT_LOG_DIR	Log directory	$PWD
RADICAL_DEFAULT_LOG_LVL	The default log level when not explicitly set	ERROR
RADICAL_DEFAULT_REPORT	Flag to turn reporting on [TRUE/1] or off [FALSE/0/OFF]	TRUE
RADICAL_DEFAULT_REPORT_TGT	List of comma separated targets [0/null, 1/stdout, 2/stderr, ./{report_name/path}]	stderr
RADICAL_DEFAULT_REPORT_DIR	Directory used by the reporter module	$PWD
RADICAL_DEFAULT_PROFILE	Flag to turn profiling/tracing on [TRUE/1] or off [FALSE/0/OFF]	TRUE
RADICAL_DEFAULT_PROFILE_DIR	Directory where to store profiles/traces	$PWD
RADICAL_PILOT_PROXY_URL	Proxy to facilitate communication between the client machine, i.e., the host where the application created this Session instance, and the target resource, i.e., the host where the pilot agent/s is/are running and where the workload is being executed.	{NOT_SET}

Logger

ru.Logger instances have a name and a name space.

Name	Description	Default value
<NS>_LOG_LVL	Logging level [“DEBUG”, “INFO”, “WARNING”, “ERROR”, “CRITICAL”]	Refer RADICAL_DEFAULT_*
<NS>_LOG_TGT	Used for the log targets	Refer RADICAL_DEFAULT_*

Note

The name space is used to derive environmental variable names for log levels and targets. If no name space is given, it is derived from the variable name. For example, the name radical.pilot becomes RADICAL_PILOT.

Note

<NS>_LOG_LVL controls the debug output for a corresponding namespace (NS), where NS can be applied as for a specific package (e.g., RADICAL_PILOT_LOG_LVL or RADICAL_UTILS_LOG_LVL) or for a whole stack (e.g., RADICAL_LOG_LVL).

Reporter

ru.Reporter instances are very similar to ru.Logger instances: same schema is used for names and name spaces.

Name	Description	Default value
<NS>_REPORT	Boolean to turn on and off Reporter	TRUE
<NS>_LOG_TGT	Where to report to.	{NOT_SET}

Note

<NS>_LOG_TGT is a list of comma separated targets [“0”/”null”, “1”/”stdout”, “2”/”stderr”, “.”/”<log_name>”] where to write the debug output for a corresponding namespace (NS).

Developers

Name	Description	Default value
RADICAL_UTILS_NO_ATFORK	Disables monkeypatching	{NOT_SET}
RADICAL_DEBUG	Enables scattered debug facilities. This will likely slow down and even destabilize the code	{NOT_SET}
RU_RAISE_ON_\*	Related to RADICAL_DEBUG, triggers specific exceptions	{NOT_SET}
RADICAL_DEBUG_HELPER	Related to RADICAL_DEBUG, enables a persistent debug helper class in the code and installs some signal handlers for extra debug output	{NOT_SET}
RADICAL_DEBUG_VERBOSE	Related to RADICAL_DEBUG, enables verbose messages for debugging. Controls “debug” module to collect stack traces. Verbose flag sets the level of details for output messages	{NOT_SET}
\*_PROFILE	Profiler is similar to Logger and Reporter	{NOT_SET}
RADICAL_PILOT_PRUN_VERBOSE	Increase verbosity of prun output	FALSE
UMS_OMPIX_PRRTE_DIR	Installation directory for PMIx/PRRTE used in RP LM PRTE (optional, to be obsolete)	{NOT_SET}
RADICAL_SAGA_SMT	Sets SMT settings on some resources. Usually configured via resource config options	1
RP_PROF_DEBUG	Enables additional debug messages on profile extraction	{NOT_SET}

SAGA

Name	Description	Default value
RADICAL_SAGA_PTY_SSH_PROMPT	Prompt Pattern. Use this regex to detect shell prompts	[\$#%>\]]\s*$
RADICAL_SAGA_PTY_SSH_COPYMODE	Use the specified protocol for pty-level file transfer	options: ‘sftp’, ‘scp’, ‘rsync+ssh’, ‘rsync’
RADICAL_SAGA_PTY_SSH_SHAREMODE	Use the specified mode as flag for the ssh ControlMaster	options: ‘auto’, ‘no’ (This should be set to “no” on CentOS)
RADICAL_SAGA_PTY_SSH_TIMEOUT	Connection timeout (in seconds) for the SAGA PTY layer. Connection timeout should be set to 60 or more	10.0
RADICAL_SAGA_PTY_CONN_POOL_SIZE	Maximum number of connections kept in a connection pool	10
RADICAL_SAGA_PTY_CONN_POOL_TTL	Minimum time a connection is kept alive in a connection pool	600
RADICAL_SAGA_PTY_CONN_POOL_WAIT	Maximum number of seconds to wait for any connection in the connection pool to become available before raising a timeout error	600

Deprecated

Name	Description
RP_ENABLE_OLD_DEFINES	Enables backward compatibility for old state defines