custom-log-data-frequency

The --custom-log-data-frequency global argument lets you specify how frequently to include custom data in your Structured Logs. Valid values are ONCE and REPEATED. The default value is REPEATED. It is available in Liquibase 4.24.0+. Learn more about custom data: Custom and Private Data in Structured Logs.

Uses

By default, Liquibase 4.24.0+ includes all custom data in your Structured Logs, so the same piece of data may appear multiple times in logs. This enables you to use dashboard queries and reports that depend on these custom key:values pairs. However, if you only want Liquibase to include your custom data once per log, you can set --custom-log-data-frequency to ONCE.

Syntax

You can set this parameter in the following ways:

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

JVM system property (JAVA_OPTS Environment Variable)

 
JAVA_OPTS=-Dliquibase.customLogDataFrequency=<string>
Liquibase Environment Variables 
LIQUIBASE_CUSTOM_LOG_DATA_FREQUENCY=<string>

For more information, see Working with Command Parameters.

Related links