JS7 does not make use of files for log output of order logs and task logs, see the JS7 - Order Logs and Task Logs article for detailed information. Instead, JS7 streams log output from Agents to the Controller and to the JOC Cockpit without the use of files.
A number of users prefer to have log files available for each order execution and job execution, for example to consolidate log files on a file server or to submit log files to specific tools for log analysis.
To support a situation when log output should be consolidated to files, the JS7 - REST Web Service API allows access to log output of orders and jobs. The JS7 - PowerShell Module is a lightweight wrapper for the REST Web Service API that is used for the examples below on Linux and Windows. Users are free to use the JS7 REST Web Service from their preferred scripting language to provide similar functionality.
Task logs can be handled similarly - see JS7 - How to make task logs available from files.
Order logs include the task log output of each job and instructions included in a workflow. This provides better a context than the use of individual task logs.
The following cmdlets are provided:
Access Log Object
Get-JS7OrderHistorycmdlet returns history results that can be filtered by folders, workflows, date range, order states, see cmdlet description linked above. By default today's order executions are returned.
Get-JS7OrderLogcmdlet is used in a pipeline and returns the order log object for each history entry.
- As a result the
$logsarray holds the list of order log objects.
An order log object carries a number of attributes as can be seen in the following console example:
Write Log to File
Reads the logs of today's orders and writes the logs to a common file.
Reads the logs of orders that completed within the last 8 hours and writes the log output to individual files in the
The log file names are created from the start time, the workflow name and Order ID.
- Provides a mechanism to subsequently retrieve previous logs. Starting from initial execution of the
Get-JS7OrderHistorycmdlet the resulting
$lastHistoryobject is used for any subsequent calls.
Consider use of the
Tee-Objectcmdlet in the pipeline that updates the
$lastHistoryobject which can be used for later executions of the same pipeline.
This pipeline can, for example, be executed in a cyclic job.
Automate Log File Creation
A workflow is created that runs the commands mentioned above in a cycle. The workflow operates 24/7 and writes order logs to files.
- The first job
get-history-order-logsis executed at the point in time when the order which starts the workflow arrives.
- This job determines the last history entry from which to start.
- The second job
write-order-logs-to-filesis executed within a JS7 - Cycle Instruction:
- The above example implements a ticking cycle every 30 minutes. For a 24h period the job will repeat every 30 minutes.
- Users can adjust the cycle as required.
The first job
get-history-order-logs looks like this:
- Line 1: The shebang is required to identify PowerShell as the interpreter of the script. The above example is for Unix, for Windows the first line of the job script should be replaced as follows:
- Line 4: The are a number of ways of specifying the details for a JS7 connection - see the JS7 - How to connect to JOC Cockpit using the PowerShell Module article.
- The host and port are specific for a user's environment.
- The Controller ID is specified during installation of the Controller and defaults to
- Line 9: A workflow variable is created that carries the list of order log objects returned by
the Get-JS7OrderHistorycmdlet which task logs should be created for. This variable is in fact a PowerShell object that is serialized to JSON and prefixed with the string
json:for later use with the second job in the workflow.
The second job
write-order-logs-to-files looks like this:
- Lines 1, 4: The same explanations apply as for the previous job.
- Lines 7: The variable holding the list of order log objects of the last processing of this job is restored from a temporary file which holds the JSON representation of the objects. The temporary files are provided by the JS7 Agent and are referenced from an environment variable which is assigned the workflow variable like this.
Line 10: When reading the order history, the variable carrying the list of order log objects is updated and forwarded to the workflow for next execution of the cycle.