Logging/Trace

All AE programs write information about their activities to logs. The use of particular settings facilitates the output of extended information in a trace. This is particularly useful when searching for and/or correcting an error.

Notes:

  • In Automic Automation on premises, all logging and trace settings are found in the INI file.

  • In Automic Automation Kubernetes Edition, if you want to set logging and traces, you can do so in the values.yaml file. If you want to change the trace level, you can do so in the ae-properties section of the configmap. For more information, see Configuring Container-Based Systems.

  • By default, log and trace files are overwritten every time the system is restarted. However, to keep older files for later use, you can specify the number of history files to be kept by using the logcount= and trccount= parameters. The file name must contain the ## string which is then replaced by 00 in the actual file name. The history files are named 01, 02, and so on, and are moved with every restart. The oldest file (with the highest number) is deleted and all other files are renamed (number is increased by 1).

  • The logging information is also stored in the AE database and can be retrieved by using statistics/logging.

INI File Settings

  • [GLOBAL]

    • logging=

      Name of the log file

      Required: Yes

    • logcount=

      Number of historical log files

      Required: No (00)

  • [Trace]

    • file=

      Name of the trace file

      Required: Yes

    • trccount=

      Number of historic trace files

      Required: No (00)

    • different parameters (such as tcp/ip=, database=, and so on)

      Control of the trace extent

      Required: No (0)

Log Files of Utilities

If the logging= parameter is not defined, the utilities create the following log files by default:

Windows: .\UCYBDBxx_LOG_##.TXT

UNIX: ./UCYBDBxx_LOG_##.TXT

xx stands for the abbreviation of a particular utility:

  • AR: AE DB Archive
  • CC: AE DB Client Copy
  • LD: AE DB Load
  • RE: AE DB Reorg
  • UN: AE DB Unload

The same is true if the INI file cannot be found because it does not exist in the specified folder. Hence a log file is even created if incorrect settings were made. For more information, see Start Parameters - Utilities.

Job States in Log Files

During the execution of jobs, messages providing information about job states are written to the logs. The following states exist:

  • A - Status ended

    Job ended with a return code that is not equal 0.

  • E - Status ended

    Job ended on status ENDED_OK.

  • R - Status running

    This status is written to the log file periodically while the job is being executed.

  • V - Status vanished

    This status only occurs when the agent cannot find a job anymore that it has started. For more information, see Stages of Job Processing.

  • W - Status waiting

    Job has not yet started and is in a waiting condition.

See also: