Page History

...

• The location of the the log files is specified by the log_dir parameter in the ${SCHEDULER_DATA}/config/factory.ini file where ${SCHEDULER_DATA} is the JobScheduler data directory that has been specified during installation. The default location is the ${SCHEDULER_DATA}/logs folder. This setting should remain unchanged otherwise JOC Cockpit doesn't find the logs. If another directory is desired, then a symlink should be created (see next chapter).

Custom Log File Location

• Administrators are free to specify an alternative location for the JobScheduler log files. In this situation, to ensure that the JOC Cockpit is able to find the alternative log file location, we recommend that administrators do not change the log_dir parameter in the factory.ini file but create a SymLink pointing to the new log directory in place of the default folder specified by the log_dir parameter. The JOC cockpit will then look at the default log file location and follow the SymLink to the new location.
• To Configure a Custom Log File location:
  • Stop the JobScheduler Master (to allow the original logs folder to be moved/deleted/renamed)
  • Move/delete/rename the original logs folder
  • On Window: Open a command prompt window (with elevated Administrator rights)
    
    • Navigate to the current location of the logs folder
    • Enter: mklink /D logs Target
      • where Target is the new name/location (absolute or relative) of the logs directory
  • On Linux: Open a shell
    
    • Navigate to the current location of the logs folder
    • Enter: ln -s "Target" logs
      • where Target is the new name/location (absolute or relative) of the logs directory
  • Start the JobScheduler Master

...

JobScheduler Log Files

JobScheduler Master Log Files

JobScheduler Agent Log Files

Feature Availability - features introduced with release 1.10

...

JobScheduler Master Log Files in Detail

Anchor
debug debug

1. Debug Log: scheduler.log

The Debug Log is created:

...

• Column 1: Starts with "." if demo version, Day of Month
• Column 2: Time (with ms)
• Column 3: application name (Windows) - empty otherwise
• Column 4: elapsed time in ms
• Column 5: Process ID, ".", Thread ID (hex)
• Column 6: Used memory in MB (Windows) - empty otherwise
• Column 7: Log text

Anchor
main main

2. Main Log: scheduler-<yyyy-mm-dd-hhmmss>.<scheduler-id>.log

The Main Log is created:

• during JobScheduler startup.
• when log rotation is performed.
• by all types of JobScheduler instances, i.e. Standalone, Active Cluster, Passive Cluster, Agent, not applicable for new JobScheduler Universal Agent .
• with the file name scheduler-<yyyy-mm-dd-hhmmss>.<scheduler-id>.log where
  • <yyyy-mm-dd-hhmmss> states the timestamp when the log was started.
  • <scheduler-id> states the JobScheduler instance identification that has been specified during installation. If multiple JobScheduler instances store log files to a common log folder then this is helpful to identify the log file of a specific JobScheduler instance.

...

• has information about processes being executed by JobScheduler and other high level information of JobScheduler operation.
• is subject to log rotation which creates a new log file with a new timestamp by the house keeping job sos/housekeeping/scheduler_rotate_log  
• is stored on the file system (the default location is ${SCHEDULER_DATA}/logs/).

Anchor
job job

3. Job Log: job.<job_chain_name>,<job_name>.log

A Job Log is created:

• during start of JobScheduler for each job. Any job start will append an existing Job Log.

• when a job is added to a scheduling environment while the JobScheduler is running.
• with the file name job.<job_chain_name>,<job_name>.log where
  • <job_chain_name> is the name of the job chain that the job is executed for, i.e. the <job_chain_name> part of a <job_chain_name>.job_chain.xml job chain file.
  • <job_name> is the name of the job, i.e. the <job_name> part in a <job_name>.job.xml job file.

...

• is stored on the file system (the default location is ${SCHEDULER_DATA}/logs/).

Anchor
task task

4. Task Log: task.<job_chain_location>,<job_chain_name>,<job_name>.log

The Task Log is created:

• during execution of individual tasks (processes) for jobs. Any job start with a subsequent task will overwrite an existing Task Log.
• with the file name task.<job_chain_location>,<job_chain_name>,<job_name>.log where
  • <job_chain_location> is the folder name where the job chain is located.
  • <job_chain_name> is the name of the job chain that the job is executed for, i.e. the <job_chain_name> part of a <job_chain_name>.job_chain.xml job chain file.
  • <job_name> is the name of the job, i.e. the <job_name> part in a <job_name>.job.xml job file.

...

• contains all information about the execution of job instances, e.g. parameters, output to stdout and stderr of the script or application that is executed..
• is stored in the file system and - after execution - is saved to the database.

Anchor
order order

5. Order Log: order.<job_chain_location>,<job_chain_name>,<order_id>.log

The Order Log is created:

...

The central Log Level settings will be applied to all the JobScheduler objects, e.g. jobs, job chains, orders etc.

...

References

Change Management References

Anchor
joc_cockpit joc_cockpit

Viewing JobScheduler Log Files in the JOC Cockpit

In Addition to being read from the file System, a number of JobScheduler log files can be viewed by JOC Cockpit users:

• The debug and main logs for a JobScheduler Master (scheduler.log and scheduler-<yyyy-mm-dd-hhmmss>.<scheduler-id>.log respectively) can be downloaded from the JOC Cockpit's Dashboard view by JOC Cockpit users with permissions to view the JobScheduler Status widget in the Dashboard.
• Log files for individual Orders, Jobs and Tasks can be read in the relevant JOC Cockpit view by users with the necessary permissions. Permissions are described in detail in the Authentication and Authorization - Permissions for the JOC Cockpit Web Service article.

Note that log files can only be accessed via the JOC Cockpit when the JobScheduler Master in question does not have the status unreachable.

See the JOC Cockpit - Logging article for more Information.

References

Change Management References

...