Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt

The Audit Log provides information about the operations that users of the JobScheduler REST Web Service - including JOC Cockpit users and external applications - perform on job-related objects. The Audit Log lists the relevant objects - jobs, job chains, orders etc. - and any operations that modify their status.

The Audit Log is feeded written by the JobScheduler REST Web Service as shown in the JOC Cockpit - Architecture page.

...

The Audit Log is maintained for objects for which users modify the status, e.g. by stopping jobs, starting orders etcsuch as jobs, orders, etc., whose statuses are modified by users carrying out operations such as starting, stopping or pausing.

  • Any new entries are added to this file, i.e. the file will not be overwritten.
  • The Audit Log is not visible to users but only to adminstrators only administrators with access to the file system where the JOC Cockpit is installed.
  • It lies in the responsibility of the administrator to check compliance requirements such as e.g. the retention period for information contained in this file.
  • Maintaining Maintenance of an Audit Log requires the administrator to comply with applicable law and corporate governance.

Audit Log Location

The Audit Log is available from found in the ./joc_home/jetty_base/logs directory with , in the file  JOCAuditLog.log file. If the file does not exist, then it will be created with the first operation of a user who modifies modifying the status of an object status.

Audit Log Sample

The following sample shows a number of Web Service requests that have been performed by a user "ap":

Code Block
languagetext
titleAudit Log Sample
collapsetrue
2017-01-02 18:23:54,553 INFO  USER: ap - REQUEST: ./orders/resume - PARAMS: {"orderId":"6","jobChain":"/sample/job_chain1"}
2017-01-02 18:24:07,033 INFO  USER: ap - REQUEST: ./tasks/kill - PARAMS: {"job":"/sample/job2","taskIds":[]}
2017-01-02 18:24:25,899 INFO  USER: ap - REQUEST: ./tasks/kill - PARAMS: {"job":"/sample/job2","taskIds":[]}
2017-01-02 18:24:47,051 INFO  USER: ap - REQUEST: ./orders/suspend - PARAMS: {"orderId":"6","jobChain":"/sample/job_chain1"}
2017-01-02 18:25:10,352 INFO  USER: ap - REQUEST: ./orders/suspend - PARAMS: {"orderId":"execution_per_30s","jobChain":"/sample/job_chain1"}
2017-01-02 18:26:11,271 INFO  USER: ap - REQUEST: ./orders/add - PARAMS: {"jobChain":"/sample/job_chain1","at":"now"}
2017-01-02 18:26:19,150 INFO  USER: ap - REQUEST: ./orders/add - PARAMS: {"jobChain":"/sample/job_chain1","at":"now"}
2017-01-02 18:26:32,933 INFO  USER: ap - REQUEST: ./orders/add - PARAMS: {"jobChain":"/sample/job_chain1","at":"now"}
2017-01-02 18:27:36,719 INFO  USER: ap - REQUEST: ./jobs/stop - PARAMS: {"job":"/sample/job2"}
2017-01-02 18:29:41,394 INFO  USER: ap - REQUEST: ./jobs/unstop - PARAMS: {"job":"/sample/job2"}
2017-01-02 18:29:46,156 INFO  USER: ap - REQUEST: ./orders/resume - PARAMS: {"orderId":"execution_per_30s","jobChain":"/sample/job_chain1"}
2017-01-02 18:30:51,713 INFO  USER: ap - REQUEST: ./orders/resume - PARAMS: {"orderId":"6","jobChain":"/sample/job_chain1"}
2017-01-02 18:31:22,838 INFO  USER: ap - REQUEST: ./orders/suspend - PARAMS: {"orderId":"daily_execution","jobChain":"/sample/job_chain1"}
2017-01-02 18:31:43,712 INFO  USER: ap - REQUEST: ./orders/add - PARAMS: {"jobChain":"/sample/job_chain1","at":"now"}
2017-01-02 18:31:47,868 INFO  USER: ap - REQUEST: ./orders/add - PARAMS: {"jobChain":"/sample/job_chain1","at":"now"}
2017-01-02 18:31:55,244 INFO  USER: ap - REQUEST: ./orders/add - PARAMS: {"jobChain":"/sample/job_chain1","at":"now"}

...

Audit Log Explanation

  • The Audit Log includes the Web Service URL that , which allows to identify the object type and operation , e.g. .to be identified. For example, ./orders/resume translates to the operation to resume an order that is identified by its order ID and job Chain path, as specified by parametersin the parameters part of each log entry.