The directory in which the Job Scheduler writes its log files is specified using the
-log-dir
option.
Entries are numbered - see »Messages«
Main Log Files
All log files are summarized in the main log file.
The name of the main log file is made up from the scheduler id, the date and the time thus:
scheduler-2004-08-24-104111.log.
Job Protocols
The Job Scheduler records a job log file containing the task start information and the orders processed -
for example: job.my_job.log
The Job Scheduler changes characters in job names, which cannot be used in file names, into "_".
Task Protocols
A task log file is written for every task the scheduler starts.
The name of the task log file is made up of the job name and, should more than one task be allowed at once, the task id.
E.g. task.my_job.log and task.a_job.1234.log.
Note that task log files with a task-id are deleted after completion of the task.
Order Protocols
The Job Scheduler compiles an order log file containing the results
of all tasks processed in the course of an order.
The name of this log file is made up from the name of the job chain and the order id -
e.g.: order.my_job_chain.9876.log.
Order log files are deleted after individual orders are completed.
scheduler.log
The Job Scheduler can write the scheduler.log as a debugging aid.
The name of this log file is set using the
factory.ini
(section [spooler],
entry log=
…) parameter.
"factory.ini" is used in this documentation for the file name entered here.
For further information see the List of Log Categories.
The detail with which log files are noted (error, warn, info, debug to debug9) can be set using
-log-level
and
Log.level
Messages are allocated codes, such as SCHEDULER-900.
All codes can be found in the List of Job Scheduler Message Codes .
An error occurs when insufficient disc space is available when a log file is opened. Should it not be possible to open the main log file then the scheduler aborts.
The scheduler stops should insufficient disc space be available to continue writing a log file. However, it will still respond to TCP, UDP or HTTP commands
In this situation, the
<modify_spooler>
command will only be carried out to a limited extent.
The scheduler can be made to continue using the <modify_scheduler cmd="continue"/>, once disc space has been made available.
The above procedure does not apply to the scheduler.log file, for which errors are ignored.
The Job Scheduler can store task and order log files in the history under the following conditions:
factory.ini
(section [spooler],
entry history=
…)), setting,
factory.ini
(section [spooler],
entry history_with_log=
…)
setting for the Task Protocol,
factory.ini
(section [job],
entry history_with_log=
…)
for distinct jobs,
factory.ini
(section [spooler],
entry order_history_with_log=
…)
setting for the Order Protocol.
The log files and settings available are set using the
Log
class.
Task log files can be sent per e-mail. Further details can be found in e-mail.
See the
<show_state>
,
<show_task>
and
<show_history>
commands.
Protocols can be viewed real-time when the Job Scheduler HTTP-Server is called up using a web browser.