Archiving Workflow Logs

What will be archived?

A Workflow is running as several instances on the workflow runtime.

These runtime versions of a workflow produce logs for monitoring and performance purposes.

These logs will be archived from the runtime database to a filesystem formatted as JSON.

Archiving Default Settings

The default configuration of the workflow archive job will be done in the container settings of workflow runtime.

Parameter	Description	Default Value
ARCHIVE_ENABLED	Activate the Archive Jobs for Workflow Runtime Logs	true
ARCHIVE_INTERVAL	Period of time that defines how often should the archive Job run	1 week
ARCHIVE_TIME	Daytime when the Job should be executed	2:00
ARCHIVE_MAX_AGE_COMPLETED	Duration after a completed or terminated workflow instance will be archived automatically	6 months

Check if the Simplifier Workflow Runtime Container has a volume path

 workflow-runtime:
    image: simplifierag/workflow-runtime:${SIMPLIFIER_VERSION}
    container_name: workflow-runtime
    restart: always
    volumes:
      - ${HOST_DATA_PATH}/workflowRuntime:/home/workflow-runtime/data

Alternatively, you can configure the Workflow Archive by using native configuration

archive {
   enabled: true
   age: "10 months"
   interval: "1 weeks"
   time: "18:22"
}

Workflow Archive Structure

Each Workflow Model gets a separate sub-folder in the main archive folder.

This folder includes files with the date of execution – each file contains 1000 workflow logs maximum and more entries will be split into several files.

/var/lib/simplifier/workflowRuntime/archive
/var/lib/simplifier/workflowRuntime/archive/mymodel1
/var/lib/simplifier/workflowRuntime/archive/mymodel1/2023-06-05-1.json
/var/lib/simplifier/workflowRuntime/archive/mymodel1/2023-06-05-2.json