analytics-enabled

--analytics-enabled is a global Boolean parameter. You can use it to enable or disable Liquibase Anonymous Analytics. It is available in Liquibase 4.30.0 and later. The default value is true for Liquibase Open Source users and false for Liquibase Pro users.

Note: Analytics are aggregated and anonymous. Liquibase does not collect personally identifiable information (PII). Liquibase does not share any data with third parties.

Uses

Liquibase collects analytics about how commands are used in order to better support the product. For example, analytics tell Liquibase which commands are used the most frequently and which commands most frequently result in failures, which may help guide improvements to the product and documentation. For more information on how data is used, see Anonymous Analytics.

You may want to use this parameter to change whether analytics are enabled:

  • If you are a Liquibase Open Source user whose company's internal policies don't allow you to share anonymous data with Liquibase, you can disable analytics by setting --analytics-enabled to false.
  • If you are a Liquibase Pro user who has had analytics disabled by default, you can enable them by setting --analytics-enabled to true.

For example, you can enable or disable analytics for a specific instance of a command in the CLI:

liquibase status --analytics-enabled=[true|false]

Alternatively, you can enable or disable analytics globally in your defaults file or as an environment variable. For syntax examples, see the following section.

To see a log of analytics data collected when you run a command, set both --log-level and --analytics-log-level to FINE. There is a JSON object at the end of the output containing the analytics for the command.

Syntax

You can set this parameter in the following ways:

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

JVM system property (JAVA_OPTS Environment Variable)

 
JAVA_OPTS=-Dliquibase.analytics.enabled=<true|false>
Liquibase Environment Variables 
LIQUIBASE_ANALYTICS_ENABLED=<true|false>

For more information, see Working with Command Parameters.

Related links