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 |
---|---|---|
|
Root directory where to save temporary state files |
$HOME/.radical/ |
|
NTP host used for profile syncing |
0.pool.ntp.org |
|
Enables bulk callbacks to boost performance. This changes the callback signature |
FALSE |
|
Log target |
. |
|
Log directory |
$PWD |
|
The default log level when not explicitly set |
ERROR |
|
Flag to turn reporting on [TRUE/1] or off [FALSE/0/OFF] |
TRUE |
|
List of comma separated targets [0/null, 1/stdout, 2/stderr, ./{report_name/path}] |
stderr |
|
Directory used by the reporter module |
$PWD |
|
Flag to turn profiling/tracing on [TRUE/1] or off [FALSE/0/OFF] |
TRUE |
|
Directory where to store profiles/traces |
$PWD |
|
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 |
---|---|---|
|
Logging level [“DEBUG”, “INFO”, “WARNING”, “ERROR”, “CRITICAL”] |
Refer RADICAL_DEFAULT_* |
|
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 |
---|---|---|
|
Boolean to turn on and off Reporter |
TRUE |
|
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 |
---|---|---|
|
Disables monkeypatching |
{NOT_SET} |
|
Enables scattered debug facilities. This will likely slow down and even destabilize the code |
{NOT_SET} |
|
Related to |
{NOT_SET} |
|
Related to |
{NOT_SET} |
|
Related to |
{NOT_SET} |
|
Profiler is similar to Logger and Reporter |
{NOT_SET} |
|
Increase verbosity of prun output |
FALSE |
|
Installation directory for PMIx/PRRTE used in RP LM PRTE (optional, to be obsolete) |
{NOT_SET} |
|
Sets SMT settings on some resources. Usually configured via resource config options |
1 |
|
Enables additional debug messages on profile extraction |
{NOT_SET} |
SAGA
Name |
Description |
Default value |
---|---|---|
|
Prompt Pattern. Use this regex to detect shell prompts |
[\$#%>\]]\s*$ |
|
Use the specified protocol for pty-level file transfer |
options: ‘sftp’, ‘scp’, ‘rsync+ssh’, ‘rsync’ |
|
Use the specified mode as flag for the ssh ControlMaster |
options: ‘auto’, ‘no’ (This should be set to “no” on CentOS) |
|
Connection timeout (in seconds) for the SAGA PTY layer. Connection timeout should be set to 60 or more |
10.0 |
|
Maximum number of connections kept in a connection pool |
10 |
|
Minimum time a connection is kept alive in a connection pool |
600 |
|
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 |
---|---|
|
Enables backward compatibility for old state defines |