custom-log-data-file

The --custom-log-data-file global parameter allows you to call on a specific file to introduce to a Structured Log. It is available in Liquibase 4.23.2+. Learn more about custom data: Custom and Private Data in Structured Logs.

Uses

If you would like to include or exclude custom data from structured logs you can introduce that specific data with the --custom-log-data-file parameter. This allows you to collect, inspect, and analyze the information to better understand and improve your software development life cycle (SDLC). This custom data can be global or command-specific.

Syntax

You can set this parameter in the following ways:

Option Syntax
Liquibase properties file (defaults file)
liquibase.customLogDataFile: <string>
Global flow file argument (example)
stages:
  Default:
    actions:
      - type: liquibase
        command: update
        globalArgs: { custom-log-data-file: "<string>" }
Global CLI parameter
liquibase
 --custom-log-data-file=<string> update
 --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS Environment Variable)

JAVA_OPTS=-Dliquibase.customLogDataFile=<string>
Liquibase Environment Variables
LIQUIBASE_CUSTOM_LOG_DATA_FILE=<string>

For more information, see Working with Command Parameters.

Related links