10. Environment variables

Althouth Extrae is configured through an XML file (which is pointed by EXTRAE_CONFIG_FILE), it also supports minimal configuration via environment variables for those systems that do not have the library responsible for parsing the XML files (i.e., libxml2).

This appendix presents the environment variables Extrae package uses if EXTRAE_CONFIG_FILE is not set and their description. For those environment variables that refer to XML enabled attributes (i.e., that can be set to “yes” or “no”) are considered to be enabled if their value is defined to 1.

EXTRAE_BUFFER_SIZE

Sets the number of records that the instrumentation buffer can hold before flushing them.

EXTRAE_COUNTERS

See section Processor performance counters. Just one set can be defined. Counters (in PAPI) groups (in PMAPI) are given separated by commas.

EXTRAE_CONTROL_FILE

The instrumentation will be enabled only when the pointed file exists.

EXTRAE_CONTROL_GLOPS

Starts the instrumentation when the specified number of global collectives have been executed.

EXTRAE_CONTROL_TIME

Checks the file pointed by EXTRAE_CONTROL_FILE at this period.

EXTRAE_DIR

Specifies where temporal files will be created during instrumentation.

EXTRAE_DISABLE_MPI

Disables MPI instrumentation.

EXTRAE_DISABLE_OMP

Disables OpenMP instrumentation.

EXTRAE_DISABLE_PTHREAD

Disables pthread instrumentation.

EXTRAE_FILE_SIZE

Sets the maximum size (in Mbytes) for the intermediate trace file.

EXTRAE_FUNCTIONS

List of routines to be instrumented, as described in section XML Section: User functions, using the GNU C compiler -fininstrument-funtions option, or the IBM XL compiler -qdebug=function_trace option at compile and link time.

EXTRAE_FUNCTIONS_COUNTERS_ON

Specifies if the performance counters should be collected when a user function event is emitted.

EXTRAE_FINAL_DIR

Specifies where files will be stored when the application ends.

EXTRAE_GATHER_MPITS

Gathers intermediate trace files into a single directory. Only available when instrumenting MPI applications.

EXTRAE_HOME

Points where Extrae is installed.

EXTRAE_INITIAL_MODE

Chooses whether the instrumentation runs in detail or in bursts mode.

EXTRAE_BURST_THRESHOLD

Specifies the threshold time to filter running bursts.

EXTRAE_MINIMUM_TIME

Specifies the minimum amount of instrumentation time.

EXTRAE_MPI_CALLER

Chooses which MPI calling routines should be dumped to the tracefile.

EXTRAE_MPI_COUNTERS_ON

Set to 1 if MPI must report performance counter values.

EXTRAE_MPI_STATISTICS

Set to 1 if basic MPI statistics must be collected in burst mode. Only available in systems with Myrinet GM/MX networks.

EXTRAE_NETWORK_COUNTERS

Set to 1 to dump network performance counters values.

EXTRAE_PTHREAD_COUNTERS_ON

Set to 1 if pthread must report performance counters values.

EXTRAE_OMP_COUNTERS_ON

Set to 1 if OpenMP must report performance counters values.

EXTRAE_PTHREAD_LOCKS

Set to 1 if pthread locks have to be instrumented.

EXTRAE_OMP_LOCKS

Set to 1 if OpenMP locks have to be instrumented.

EXTRAE_ON

Enables instrumentation.

EXTRAE_PROGRAM_NAME

Specifies the prefix of the resulting intermediate trace files.

EXTRAE_SAMPLING_CALLER

Determines the callstack segment stored through time-sampling capabilities.

EXTRAE_SAMPLING_CLOCKTYPE

Determines domain for sampling clock. Options are: DEFAULT, REAL, VIRTUAL and PROF.

EXTRAE_SAMPLING_PERIOD

Enables time-sampling capabilities with the indicated period.

EXTRAE_SAMPLING_VARIABILITY

Adds some variability to the sampling period.

EXTRAE_RUSAGE

Instrumentation emits resource usage at flush points if set to 1.

EXTRAE_SKIP_AUTO_LIBRARY_INITIALIZE

Do not init instrumentation automatically in the main symbol.

EXTRAE_TRACE_TYPE

Chooses whether the resulting tracefiles are intended for Paraver or Dimemas.