monitor-performance

The monitor-performance parameter enables internal tracking of the Liquibase code to understand which methods took the longest time to run, and how system memory was used. It generates a JFR file which contains the profiling information which can be analyzed and compared.

Possible values include:

  • If set to false (default value), performance information will not be captured.
  • If set to true, a file name liquibase-TIMESTAMP.jfr will be created in the current working directory.
  • Any other value will enable performance tracking, and the value will be used as the filename.

This attribute is available in Liquibase 4.11+.

Uses

The monitor-performance parameter applies to all Liquibase commands. It can be used to help the Liquibase team better troubleshoot performance issues you may be seeing.

Syntax

You can set this parameter in the following ways:

Option Syntax
Liquibase properties file (defaults file)
liquibase.monitorPerformance: <true|false>
Global flow file argument (example)
stages:
  Default:
    actions:
      - type: liquibase
        command: update
        globalArgs: { monitor-performance: "<true|false>" }
Global CLI parameter
liquibase
 --monitor-performance=<true|false> update
 --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS Environment Variable)

JAVA_OPTS=-Dliquibase.monitorPerformance=<true|false>
Liquibase Environment Variables
LIQUIBASE_MONITOR_PERFORMANCE=<true|false>

For more information, see Working with Command Parameters.