What are structured logging keys?

Key

Description

class

Name of the Liquibase logger that emitted the log event, such as liquibase.changelog or liquibase.ui. This is a component-level logger name, not a fully qualified Java class name. There is no separate logger key; the logger name appears here

changelog

Name of the changelog associated with the log event

changelogProperties

A list of any changelog properties whose values you are substituting. Displays both property names and values. For more information, see What is property substitution?

changesetAuthor

Value of --author. Author of the changeset being logged

changesetContext

Contexts assigned to the changeset being logged. Empty when the changeset has no contexts

changesetCount

Number of changesets associated with the log event

changesetFilepath

Path to the changelog file containing the changeset being logged. Also appears as a nested key under duplicateChangesets

changesetId

Value of --id. ID of the changeset being logged

changesetOutcome

Outcome of deploying this changeset

deploymentId

ID of database deployment. Appears in all logs in Liquibase 4.25.0+.

deploymentOutcome

Outcome of the database deployment. Appears in all logs in Liquibase 4.25.0+.

deploymentOutcomeCount

Number of changesets deployed. Appears in all logs in Liquibase 4.25.0+.

duplicateChangesets

Appears if there are any duplicated changesets. Available in Liquibase 4.25.1+. Contains the following nested keys: changesetAuthor, changesetFilepath, changesetId

errorClassification

Classification of the failure, either business or system

exception

Stack trace of the exception. May appear multiple times for different exceptions.

exceptionDetails

Details about the exception being logged. Contains the following nested keys: exception (stack trace), primaryException (exception class), primaryExceptionReason (message), primaryExceptionSource (application or component)

failOnError

Value of failOnError

level

Value of --log-level. Level of detail of the output.

liquibaseCatalogName

Value of --liquibase-catalog-name. Name of the database catalog. Appears in all logs in Liquibase 4.25.0+.

liquibaseCommandName

Name of the command entered in the CLI

liquibaseErrorCode

Design-for-Failure error code of the failure, in the form LB-<DOMAIN>-<NNNN>. See Error codes and exit codes for the full catalog.

liquibaseHostName

System name running Liquibase

liquibaseInternalCommand

Name of the internal Liquibase operation

liquibasePsqlArgs

Value of --psql-args

liquibasePsqlKeepTemp

Value of --psql-keep-temp

liquibasePsqlKeepTempName

Value of --psql-keep-temp-name

liquibasePsqlKeepTempPath

Value of --psql-keep-temp-path

liquibasePsqlLogFile

Value of --psql-log-file

liquibasePsqlPath

Value of --psql-path

liquibasePsqlTimeout

Value of --psql-timeout

liquibaseSqlcmdArgs

Value of --sqlcmd-args

liquibaseSqlcmdCatalogName

Value of --sqlcmd-catalog-name

liquibaseSqlcmdKeepTemp

Value of --sqlcmd-keep-temp

liquibaseSqlcmdKeepTempName

Value of --sqlcmd-keep-temp-name

liquibaseSqlcmdKeepTempPath

Value of --sqlcmd-keep-temp-path

liquibaseSqlcmdLogFile

Value of --sqlcmd-log-file

liquibaseSqlcmdPath

Value of --sqlcmd-path

liquibaseSqlcmdTempOverwrite

Value of --sqlcmd-keep-temp-overwrite

liquibaseSqlcmdTimeout

Value of --sqlcmd-timeout

liquibaseSqlplusArgs

Value of --sqlplus-args

liquibaseSqlplusCreateSpool

Value of --sqlplus-create-spool

liquibaseSqlplusKeepTemp

Value of --sqlplus-keep-temp

liquibaseSqlplusKeepTempPath

Value of --sqlplus-keep-temp-path

liquibaseSqlplusKeepTempName

Value of --sqlplus-keep-temp-name

liquibaseSqlplusPath

Value of --sqlplus-path

liquibaseSqlplusSpoolFile

Value of --sqlplus-spool-file

liquibaseSqlplusTempOverwrite

Value of --sqlplus-keep-temp-overwrite

liquibaseSqlplusTimeout

Value of --sqlplus-timeout

liquibaseSchemaName

Value of --liquibase-schema-name. Name of the database schema. Appears in all logs in Liquibase 4.25.0+.

liquibaseSuggestion

Suggested next step for resolving the failure, when the error code has one

liquibaseSystemName

Deprecated. System name running Liquibase

liquibaseSystemUser

Name of user running Liquibase

liquibaseTargetUrl

URL of the target database associated with the log

liquibaseVersion

Version of Liquibase installed

message

Short descriptor of log event

operationOutcome

Outcome of the command, either success or fail

operationStart

UTC timestamp of operation start

operationStop

UTC timestamp of operation end

outputFile

Value of --output-file

outputFileEncoding

Value of --output-file-encoding

releaseLocksOutcome

Outcome of releasing the changelog lock

rowsAffected

Number of rows in a table the change affects

runWith

Value of runWith

thread

Name of the thread that emitted the log event, such as main. Liquibase 6.0 reports a thread name where earlier versions reported a numeric thread ID

timestamp

UTC timestamp of log event

Key

Description

changelogChecks

The checks that run against the changelog

databaseChecks

The checks that run against the database

Key

Description

executedChecks

The checks executed against the changelog

hasProLicense

The changelogs that have a Secure license key

changesetsValidated

The changelogs that have valid changesets.

productVersion

The version of Liquibase currently being used with the given changelog

username

Value of username

issueCount

The issue count occurring in the changelog

executionDate

The date each check was executed against the changelog

unlicensedChangesetsCount

Number count of unlicensed changeset that exist in the given changelog

unlicensedChangesets

List of unlicensed changesets that exist in the given changelog

unrecognizedChecks

Any unrecognized checks that exist in the given changelog

executedChecksCount

Number count of executed checks that ran against the changelog

issues

Any issues existing within the changelog

changesetsValidatedCount

Number count of validated changesets existing in the given changelog

changelogFilePath

The file path of the given changelog

integration

changelog integrated checks

unparseableChangesets

List of any unparseable changesets within the given changelog

unparseableChangesetsCount

Number count of the unparseable changesets within the given changelog

checksSettingsFile

The checks settings file being utilized

returnCode

The return code of each issue that exists within a changelog

Key

Description

customizations

Any customizations performed on checks executed against the changelog

description

The description of the checks executed against the changelog

checkName

The name of the checks executed against the changelog

enabled

A list of enabled checks executed against the changelog

checkShortName

The abbreviation of the checks executed against the changelog

severity

The severity of the checks executed against the changelog

Key

Description

constraint

Any customized constraints assigned to checks that are executed

objectTypes

List of existing object types within the customized executed checks

stripComments

Allows you to strip comments from customized, executed checks

exceptionsList

List of any exceptions within the customized, executed checks

This includes:

exception primaryClass

exception primaryReason

exception source

exception details

Learn more here: Structured Logging

constraintOperator

The constraint operator assigned to customized, executed checks

tableName

List of existing tables within customized, executed checks

columnName

List of existing columns within customized, executed checks

changeTypeList

List of existing

Change Type

s within customized, executed checks

maxColumns

maximum number of columns allowed within customized, executed checks

allowedList

the list of allowed customizations within executed checks

privilegeList

the list of privileges within executed checks

message

the executed checks message

operator

the operator who carries out the customized, executed checks

searchString

keywords that can be used to search the customized, executed checks

caseSensitive

Customized, executed checks that are case sensitive

Key

Description

changesetAuthor

The changeset author of each issue that exists within a changelog

changesetFilePath

The changeset file path of each issue that exists within a changelog

changesetId

The changeset ID of each issue that exists within a changelog

checkMessage

The message of each issue that exists within a changelog

checkName

The name of each issue that exists within a changelog

checkReturnCode

The return code of each issue that exists within a changelog

checkSeverity

The severity of each issue that exists within a changelog

checkShortName

The abbreviated name of a changelog check from each issue

Key

Description

target

The targeted database

executedChecks

The checks executed against the given database

hasProLicense

States if the database has a Secure license key, or not

databaseObjectsValidatedCount

The count of all objects validated within the database

productVersion

States the version of Liquibase that is being utilized in the current database

username

The username of who runs any database checks

issueCount

The number of existing issues

executionDate

The date the database check was executed on

unrecognizedChecks

Lists any unrecognized checks

executedChecksCount

The number of executed checks

issues

List of any existing issues

integration

Database integrated checks

databaseObjectsValidated

List of database objects validated

targetType

The type of target being used by the database

unparseableDatabaseObjectCount

Number of any unparseable database objects

checksSettingsFile

The checks settings file being utilized

returnCode

The check return code of database checks

Key

Description

customizations

Any customizations performed on executed database checks

description

The description of executed database checks

checkName

The name of executed database checks

enabled

List of the enabled database checks

checkShortName

The abbreviated name of an executed database check

severity

The severity of an executed database check

Key

Description

constraint

Constraints on the customized executed checks

objectTypes

Customized object types of executed checks

stripComments

Allows you to strip comments from customized, executed checks

exceptionsList

List of exceptions in customized, executed checks

This includes:

- exception primaryClass

- exception primaryReason

- exception source

- exception details

Learn more here: Structured Logging

constraintOperator

The constraint operator assigned to customized, executed checks

tableName

List of existing tables within customized, executed checks

columnName

List of existing columns within customized, executed checks

changeTypeList

List of existing

Change Type

s within customized, executed checks

maxColumns

maximum number of columns allowed within customized, executed checks

allowedList

The list of allowed customizations within executed checks

privilegeList

The list of privileges within executed checks

message

The executed checks message

operator

The operator who carries out the customized, executed checks

searchString

Keywords that can be used to search the customized, executed checks

caseSensitive

Customized, executed checks that are case sensitive

Key

Description

checkMessage

Message displayed about each issue appearing in the database

checkName

The name of each issue appearing in the database

checkReturnCode

The return code of each issue that exists within a database

checkSeverity

The severity of each issue within the database

checkShortName

The abbreviation of each issue within the database

databaseObjectLocation

The location of an object within the database

databaseObjectName

The name of an object within the database

databaseObjectType

The type of object within the database

Key

Description

objectType

List of the object type that are validated in the database

count

Number count that are validated in the database

objects

List of the objects that are validated in the database

Key

Description

arguments

A list of arguments the user specified, including the command.

author

Value from the changeset author attribute.

command

Name of the command the user specified.

contexts

Context(s) used to execute the changeset.

description

Short, auto-generated, human-readable description of the changeset.

end

Timestamp in the user's local timezone that the operation ended.

executedSql

The SQL Liquibase executed in the operation.

extensions

A list of extensions to Liquibase, including pre-installed drivers.

filename

Path to the changelog. This may be an absolute path or a relative path depending on how the changelog was passed to Liquibase. For best results, it should be a relative path. The logicalFilePath attribute can be used on the changelog or on individual changesets.

hostname

Name of the machine Liquibase executed the operation on.

id

Value from the changeset id attribute.

interface

The way you called Liquibase, such as the CLI or a flow file.

internalCommand

Internal name of the command Liquibase ran.

labels

Label(s) used to execute the changeset.

liquibaseVersion

Version of Liquibase used to execute the changeset.

md5Sum

Checksum of the changeset when it was executed. Used on each run to ensure there have been no unexpected changes to changesets in the changelog file. See Changeset Checksums.

outcome

Description of how the changeset was executed. Possible values include EXECUTED, FAILED, SKIPPED, RERAN, and MARK_RAN.

start

Timestamp in the user's local timezone that the operation started.

systemUser

Name of the system account that initiated the Liquibase operation.

tag

Tracks which changesets correspond to tag operations.

Key

Command

Description

diffOutcome

diff

Whether the diff was successful

diffResultsSummary

diff

Diff result info. Contains nested keys: changed (count), missing (count), unexpected (count)

format

diff

Value of --format

outputFile

diff

Value of --output-file

outputFileEncoding

diff

Value of --output-file-encoding

schema

diff

Value of --schemas

diffTypes

diff, diff-changelog

Value of --diff-types

excludeObjects

diff, diff-changelog

Value of --exclude-objects

includeObjects

diff, diff-changelog

Value of --include-objects

liquibaseReferenceUrl

diff, diff-changelog

Value of --reference-url

outputSchemas

diff, diff-changelog

Value of --output-schemas

referenceDefaultCatalogName

diff, diff-changelog

Value of --reference-default-catalog-name

referenceDefaultSchemaName

diff, diff-changelog

Value of --reference-default-schema-name

referenceSchemas

diff, diff-changelog

Value of --reference-schemas

referenceUsername

diff, diff-changelog

Value of --reference-username

changesetComment

diff-changelog

Comment applied to changeset

changesetLabel

diff-changelog

Label applied to changeset

commandContextFilter

diff-changelog

Value of --context-filter

commandLabelFilter

diff-changelog

Value of --label-filter

databaseChangelogSql

diff-changelog

SQL to update the DATABASECHANGELOG table

databaseChangelogTableOutcome

diff-changelog

Outcome of update to the DATABASECHANGELOG table

diffChangelogFile

diff-changelog

Path to the generated changelog file

includeCatalog

diff-changelog

Value of --include-catalog

includeSchema

diff-changelog

Value of --include-schema

includeTablespace

diff-changelog

Value of --include-tablespace

schemas

diff-changelog

Value of the --schemas property

Key

Description

changelogFile

The changelog file you are using with the flow command

commandContextFilter

Value of --context-filter

commandLabelFilter

Value of --label-filter

flowFileFailedMessage

Error message if the flow file fails

flowFileFailedStage

Stage at which the flow file failed

flowFileRoot

Root directory of the flow file

flowStart

UTC timestamp when the flow started

flowStop

UTC timestamp when the flow ended

rollbackOnError

Indicates whether rollback was triggered due to an error

Key

Description

changelogPath

Path to the changelog you are using with the

history

command

changesets

history

updateDate

Date of last deployment

Key

Command

Description

changelogFile

rollback*

The changelog containing changesets being rolled back

changesetComment

rollback*

Comment applied to changeset

changesetLabel

rollback*

Label applied to changeset

changesetOperationStart

rollback*

UTC timestamp of operation start. Repeats in every changeset log message

changesetOperationStop

rollback*

UTC timestamp of operation end. Repeats in every changeset log message

changesetOutcome

rollback*

Individual changeset outcomes

changesetSql

rollback*

Generated/executed SQL

changesetsRolledBack

rollback*

The changesets that were rolled back. Contains nested keys: changesetCount, changeset, changesetAuthor, changesetFilepath, changesetId, changesetOutcome, deploymentId

commandContextFilter

rollback*

Value of --context-filter

commandLabelFilter

rollback*

Value of --label-filter

databaseChangelogSql

rollback*

SQL to update the DATABASECHANGELOG table

databaseChangelogTableOutcome

rollback*

Outcome of update to the DATABASECHANGELOG table

rollbackCount

rollback-count

Value of --count in rollback-count logs only

rollbackDate

rollback-to-date

Value of --date in rollback-to-date logs only

rollbackOneChangesetForce

rollback-one-changeset

Value of --force in rollback-one-changeset logs only

rollbackOneUpdateForce

rollback-one-update

Value of --force in rollback-one-update logs only

rollbackScript

rollback*

Value of --rollback-script

rollbackToTag

rollback

Value of --tag

Key

Description

changelogFile

The changelog potentially containing undeployed changesets

commandContextFilter

Value of --context-filter

commandLabelFilter

Value of --label-filter

Key

Command

Description

changelogFile

update*

The changelog containing changesets being deployed

changesetComment

update*

Comment applied to changeset

changesetLabel

update*

Label applied to changeset

changesetOperationStart

update*

UTC timestamp of operation start. Repeats in every changeset log message

changesetOperationStop

update*

UTC timestamp of operation end. Repeats in every changeset log message

changesetSql

update*

Generated/executed SQL

changesetsUpdated

update*

The changesets that were updated. Contains nested keys: changesetCount, changeset, changesetAuthor, changesetFilepath, changesetId, changesetOutcome, deploymentId

commandContextFilter

update*

Value of --context-filter

commandLabelFilter

update*

Value of --label-filter

databaseChangelogSql

update*

SQL to update the DATABASECHANGELOG table

databaseChangelogTableOutcome

update*

Outcome of update to the DATABASECHANGELOG table

rollbackOnError

update*

Value of --rollback-on-error

updateSummary

update*

Only appears if --show-summary=summary. Contains nested keys: value, run, runPreviously, skipped, dbmsUnknown, labels, context, totalSkipped, totalChangesets

Key

Description

javaHome

Contains nested keys:

path

version

liquibaseLibraries

Contains nested keys:

libraries

"name": "Apache Commons Collections", "path": "internal/lib/commons-collections4.jar"

"name": "Apache Commons Lang", "path": "internal/lib/commons-lang3.jar"

"name": "Apache Commons Text", "path": "internal/lib/commons-text.jar"

"name": "H2 Database Engine", "path": "internal/lib/h2.jar"

"name": "HSQLDB", "path": "internal/lib/hsqldb.jar"

"name": "jaxb-api", "path": "internal/lib/jaxb-api.jar"

"name": "JAXB Core", "path": "internal/lib/jaxb-core.jar"

"name": "JAXB Runtime", "path": "internal/lib/jaxb-runtime.jar"

"name": "Jaybird", "path": "internal/lib/jaybird.jar"

"name": "IBM JCC JDBC 4 Driver", "path": "internal/lib/jcc.jar"

"name": "Commercial Liquibase Functionality", "path": "internal/lib/liquibase-commercial.jar"

"name": "mariadb-java-client", "path": "internal/lib/mariadb-java-client.jar"

"name": "Microsoft JDBC Driver for SQL Server", "path": "internal/lib/mssql-jdbc.jar"

"name": "JDBC", "path": "internal/lib/ojdbc17.jar"

"name": "opencsv", "path": "internal/lib/opencsv.jar"

"name": "picocli", "path": "internal/lib/picocli.jar"

"name": "PostgreSQL JDBC Driver", "path": "internal/lib/postgresql.jar"

"name": "SnakeYAML", "path": "internal/lib/snakeyaml.jar"

"name": "snowflake-jdbc", "path": "internal/lib/snowflake-jdbc.jar"

"name": "SQLite JDBC", "path": "internal/lib/sqlite-jdbc.jar"