• Task
  • Version · 6.0
  • Troubleshoot

Use the Support report

Last updated: September 24, 2026

The Support report streamlines troubleshooting by automatically collecting and packaging diagnostic information into a single, shareable file that the Liquibase Support team can easily analyze to begin diagnosing your issue. Gathering this information manually is time-consuming for both customers and support teams, and critical details are often missed or incomplete. This report ensures the Support and Engineering teams have all the necessary details to resolve customer tickets quickly.

We redact sensitive information during collection; however, please review the contents collected before providing them to our Support team. To learn more, visit our privacy policy.

Collected information:

Default collected information:

  • Complete Liquibase log file, displaying your log level values

  • Properties file - Credentials redacted

  • Environment variables - Credentials redacted

  • Last command ran in the CLI

Optional collected information 

The report can also include this additional information if you specify it:

  • Snapshot file

  • Flow file

  • Policy check file - Credentials redacted

  •  Anything about the environment (Windows/Linux, CLI, automation, etc.) 

  • What GitHub actions are enabled

  • What integrations are enabled

  • Changelog, changeset, or script being run related to the reported issue, with Credentials redacted

Procedure

1

Ensure Troubleshooting mode is enabled on any global parameter.

liquibase --troubleshooting-enabled=true <insert your command here> This will create a .zip file that contains a Support report. Note: When you enable troubleshooting, Liquibase executes the specified command as part of the troubleshooting process—troubleshooting captures diagnostic information while the command runs. This means if you run troubleshooting on the update command and you have undeployed changes, your database will be updated as a side effect. Unless you override the file title, the auto-generated title will be in this format: liquibase-troubleshooting-yyyyMMdd-HHmmSS .zip Example: liquibase-troubleshooting-20251010-124939.zip

2

Optional: Include a parameter to include additional content

Include any parameter from the table below to include different items that are not collected by default. Examples: --troubleshooting-additional-files-directory[=PARAM] --troubleshooting-include-environment-variables[=PARAM]

--troubleshooting-include-system-properties[=PARAM]

Available parameters

Type

Default Value

Description

liquibase.properties: liquibase.troubleshooting.enabled CLI: --troubleshooting-enabled ENV VAR: LIQUIBASE_TROUBLESHOOTING_ENABLED

Boolean

false

Enable or disable troubleshooting mode

liquibase.properties: liquibase.troubleshooting.outputFile CLI: --troubleshooting-output-file ENV VAR: LIQUIBASE_TROUBLESHOOTING_OUTPUT_FILE

String

liquibase-troubleshooting-<timestamp>

Output file path (without .zip extension)

liquibase.properties: liquibase.troubleshooting.includeEnvironmentVariables

CLI: --troubleshooting-include-environment-variables ENV VAR: LIQUIBASE_TROUBLESHOOTING_INCLUDE_ENVIRONMENT_VARIABLES

Boolean

true

Include environment variables in output

liquibase.properties: liquibase.troubleshooting.includeSystemProperties CLI: --troubleshooting-include-system-properties ENV VAR: LIQUIBASE_TROUBLESHOOTING_INCLUDE_SYSTEM_PROPERTIES

Boolean

true

Include Java system properties in output

liquibase.properties: liquibase.troubleshooting.sensitivePropertyPatterns CLI: --troubleshooting-sensitive-property-patterns ENV VAR: LIQUIBASE_TROUBLESHOOTING_SENSITIVE_PROPERTY_PATTERNS

String (comma-separated)

*password*, *secret*, *key*, *token*, *credential*, *auth*, *api*key*, *access*key*

Patterns to identify sensitive properties for obfuscation. Use wildcards (*)

liquibase.properties: liquibase.troubleshooting.includeLogFile CLI: --troubleshooting-include-log-file ENV VAR: LIQUIBASE_TROUBLESHOOTING_INCLUDE_LOG_FILE

Boolean

true

Include log file in bundle (if configured vialogFileproperty)

liquibase.properties: liquibase.troubleshooting.additionalFilesDirectory CLI: --troubleshooting-additional-files-directory ENV VAR: LIQUIBASE_TROUBLESHOOTING_ADDITIONAL_FILES_DIRECTORY

String

null

A directory containing additional files, such as your changelog, to include in the bundle. When null, no additional files are included

liquibase.properties: liquibase.troubleshooting.maxFileSize CLI: --troubleshooting-max-file-size ENV VAR: LIQUIBASE_TROUBLESHOOTING_MAX_FILE_SIZE

(MB)

100

Maximum individual file size. Files exceeding this limit will be skipped

liquibase.properties: liquibase.troubleshooting.maxBundleSize CLI: --troubleshooting-max-bundle-size ENV VAR: LIQUIBASE_TROUBLESHOOTING_MAX_BUNDLE_SIZE

(MB)

500

Maximum total bundle size. Collection stops when limit is reached

3

Optional: Identify sensitive properties for obfuscation.

By default, Liquibase automatically excludes all sensitive properties (passwords, secrets, keys, tokens, credentials, and authentication data) from your Support report. If you need to customize which properties are excluded, you can specify different patterns using the liquibase.troubleshooting.sensitivePropertyPatterns parameter.

Default behavior (no parameter needed):

liquibase --troubleshooting-enabled=true <insert your command here>

Custom pattern (only if you need to exclude specific properties instead):

liquibase --troubleshooting-enabled=true --troubleshooting-sensitive-property-patterns="*password*,*api*key*" <your-command-here>

The default patterns include: *password*, *secret*, *key*, *token*, *credential*, *auth*, *api*key*, and *access*key*

Ensure you always doublequote your values. Example: "*password*,*api*key*"

4

Review the zip file contents.

Please review the zip file before sending it to our Support team to ensure all optional additional content is included, no sensitive information is included, and to support your own troubleshooting.

5

Email this file to support@liquibase.com to create a ticket.

If you already have an open ticket, you can go to our support portal and send the file to our team from there.

PreviousTroubleshootNextError codes and exit codes