Element | Description |
file | Replace file with the name of the file that you want to be the log file. If you specify the name of a file that exists, the correlator overwrites it on Windows or appends to it on UNIX. Required. If you also specify ${START_TIME} and/or ${ROTATION_TIME} and/or ${ID} and/or ${PID}, the correlator prefixes the name you specify to the time the correlator was started and/or the time the log file was rotated (logging to a new file began) and/or an ID beginning with 001 and/or the process ID. Be sure to specify a location that allows fast access. |
${START_TIME} | Tag that indicates that you want the correlator to insert the date and time that it started into the log filename. Optional, however you probably want to always specify either this option or ${ROTATION_TIME} to avoid overwriting log files. |
${ROTATION_TIME} | Tag that indicates that you want the correlator to insert the date and time that it starts sending messages to a new log file into the log filename. Optional. If you specify ${ROTATION_TIME} and this log filename specification appears in a correlator start-up command then the name of the initial log file contains the time the correlator started. |
${ID} | Tag that indicates that you want the correlator to insert a three-digit ID into the log filename. The ID that the correlator inserts first is 001. Optional. The log ID increment is related only to rotation of log files. See
Rotating correlator log files and
Rotating an input log file. The ID allows you to create a sequence of log files. Each time the log file is rotated, the correlator increments the ID. A sequence of log files have the same name except for the ID. If you also specify ${ROTATION_TIME} then a sequence of log files have the same name except for the rotation time and the ID. Restarting the correlator always resets the ID portion of the log filename to 001. |
${PID} | Tag that indicates that you want the correlator to insert the process ID into the log file name. Optional. The process ID will be constant for the lifetime of the process. Therefore, if you start multiple processes with the same arguments, they get different file names. |