Add mdc to update command (DAT-12602)

liquibase-core/src/main/java/liquibase/Liquibase.java

@@ -31,6 +31,8 @@
 import liquibase.logging.Logger;
 import liquibase.logging.core.BufferedLogService;
 import liquibase.logging.core.CompositeLogService;
+import liquibase.logging.mdc.MdcKey;
+import liquibase.logging.mdc.MdcValue;
 import liquibase.parser.ChangeLogParser;
 import liquibase.parser.ChangeLogParserFactory;
 import liquibase.parser.core.xml.XMLChangeLogSAXParser;
@@ -235,6 +237,8 @@ public void update(Contexts contexts, LabelExpression labelExpression, boolean c
         runInScope(() -> {
             LockService lockService = LockServiceFactory.getInstance().getLockService(database);
             lockService.waitForLock();
+            Scope.getCurrentScope().addMdcValue(MdcKey.OPERATION_TARGET_VALUE, database.getConnection().getURL());
+            Scope.getCurrentScope().addMdcValue(MdcKey.OPERATION_TARGET_TYPE, MdcValue.URL_DATABASE_TARGET);
 
             changeLogParameters.setContexts(contexts);
             changeLogParameters.setLabels(labelExpression);
@@ -252,6 +256,8 @@ public void update(Contexts contexts, LabelExpression labelExpression, boolean c
                 ChangeLogHistoryService changelogService = ChangeLogHistoryServiceFactory.getInstance().getChangeLogService(database);
                 changelogService.generateDeploymentId();
 
+                Scope.getCurrentScope().addMdcValue(MdcKey.DEPLOYMENT_ID, changelogService.getDeploymentId());
+
                 changeLog.validate(database, contexts, labelExpression);
 
                 //

liquibase-core/src/main/java/liquibase/changelog/ChangeSet.java

@@ -16,6 +16,7 @@
 import liquibase.executor.ExecutorService;
 import liquibase.executor.LoggingExecutor;
 import liquibase.logging.Logger;
+import liquibase.logging.mdc.MdcKey;
 import liquibase.parser.ChangeLogParserConfiguration;
 import liquibase.parser.core.ParsedNode;
 import liquibase.parser.core.ParsedNodeException;
@@ -27,6 +28,7 @@
 import liquibase.sql.visitor.SqlVisitor;
 import liquibase.sql.visitor.SqlVisitorFactory;
 import liquibase.statement.SqlStatement;
+import liquibase.util.ISODateFormat;
 import liquibase.util.StreamUtil;
 import liquibase.util.StringUtil;
 
@@ -569,6 +571,7 @@ public ExecType execute(DatabaseChangeLog databaseChangeLog, ChangeExecListener
         }
 
         long startTime = new Date().getTime();
+        Scope.getCurrentScope().addMdcValue(MdcKey.CHANGESET_OPERATION_START_TIME, new ISODateFormat().format(new Date()));
 
         ExecType execType = null;
 
@@ -697,7 +700,8 @@ public ExecType execute(DatabaseChangeLog databaseChangeLog, ChangeExecListener
                 if (runInTransaction) {
                     database.commit();
                 }
-                log.info("ChangeSet " + toString(false) + " ran successfully in " + (new Date().getTime() - startTime + "ms"));
+                Scope.getCurrentScope().addMdcValue(MdcKey.CHANGESET_OPERATION_STOP_TIME, new ISODateFormat().format(new Date()));
+                log.info("ChangeSet " + toString(false) + " ran successfully in " + (new Date().getTime() - startTime) + "ms");
                 if (execType == null) {
                     execType = ExecType.EXECUTED;
                 }

liquibase-core/src/main/java/liquibase/changelog/visitor/UpdateVisitor.java

@@ -13,6 +13,7 @@
 import liquibase.executor.Executor;
 import liquibase.executor.ExecutorService;
 import liquibase.executor.LoggingExecutor;
+import liquibase.logging.mdc.MdcKey;
 
 import java.util.Set;
 
@@ -43,6 +44,10 @@ public Direction getDirection() {
     @Override
     public void visit(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Database database,
                       Set<ChangeSetFilterResult> filterResults) throws LiquibaseException {
+        Scope scope = Scope.getCurrentScope();
+        scope.addMdcValue(MdcKey.CHANGESET_ID, changeSet.getId());
+        scope.addMdcValue(MdcKey.CHANGESET_AUTHOR, changeSet.getAuthor());
+        scope.addMdcValue(MdcKey.CHANGESET_FILEPATH, changeSet.getFilePath());
         Executor executor = Scope.getCurrentScope().getSingleton(ExecutorService.class).getExecutor("jdbc", database);
         if (! (executor instanceof LoggingExecutor)) {
             Scope.getCurrentScope().getUI().sendMessage("Running Changeset: " + changeSet);
@@ -61,6 +66,7 @@ public void visit(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Data
         if (!runStatus.equals(ChangeSet.RunStatus.NOT_RAN)) {
             execType = ChangeSet.ExecType.RERAN;
         }
+        Scope.getCurrentScope().addMdcValue(MdcKey.CHANGESET_OUTCOME, execType.value.toLowerCase());
         fireRan(changeSet, databaseChangeLog, database, execType);
         // reset object quoting strategy after running changeset
         this.database.setObjectQuotingStrategy(previousStr);

liquibase-core/src/main/java/liquibase/executor/jvm/JdbcExecutor.java

@@ -11,6 +11,7 @@
 import liquibase.executor.AbstractExecutor;
 import liquibase.listener.SqlListener;
 import liquibase.logging.Logger;
+import liquibase.logging.mdc.MdcKey;
 import liquibase.servicelocator.PrioritizedService;
 import liquibase.sql.CallableSql;
 import liquibase.sql.Sql;
@@ -425,6 +426,7 @@ public Object doInStatement(Statement stmt) throws SQLException, DatabaseExcepti
                         statement = statement.replaceFirst("[\\s\\r\\n]*[^*]/[\\s\\r\\n]*$", "");
                     }
                 }
+                Scope.getCurrentScope().addMdcValue(MdcKey.CHANGESET_SQL, statement);
 
                 for (SqlListener listener : Scope.getCurrentScope().getListeners(SqlListener.class)) {
                     listener.writeSqlWillRun(String.format("%s", statement));

liquibase-core/src/main/java/liquibase/integration/commandline/LiquibaseCommandLineConfiguration.java

@@ -3,6 +3,7 @@
 import liquibase.configuration.AutoloadedConfigurations;
 import liquibase.configuration.ConfigurationDefinition;
 import liquibase.configuration.ConfigurationValueConverter;
+import liquibase.logging.LogFormat;
 
 import java.util.logging.Level;
 
@@ -22,6 +23,7 @@ public class LiquibaseCommandLineConfiguration implements AutoloadedConfiguratio
     public static final ConfigurationDefinition<Level> LOG_LEVEL;
     public static final ConfigurationDefinition<String> LOG_CHANNELS;
     public static final ConfigurationDefinition<String> LOG_FILE;
+    public static final ConfigurationDefinition<LogFormat> LOG_FORMAT;
     public static final ConfigurationDefinition<String> OUTPUT_FILE;
     public static final ConfigurationDefinition<Boolean> SHOULD_RUN;
     public static final ConfigurationDefinition<ArgumentConverter> ARGUMENT_CONVERTER;
@@ -79,6 +81,13 @@ public class LiquibaseCommandLineConfiguration implements AutoloadedConfiguratio
                 .setDefaultValue(argument -> argument)
                 .build();
 
+        LOG_FORMAT = builder.define("logFormat", LogFormat.class)
+                .setDescription("Set the format of log output to console or log files\n" +
+                        "[OSS] Defaults to \"TEXT\" logs to the console or output log files\n" +
+                        "[PRO] Can be set to \"JSON\" to enable json-structured log files to the console or output log files")
+                .setDefaultValue(LogFormat.TEXT)
+                .build();
+
    }
 
     public interface ArgumentConverter {

liquibase-core/src/main/java/liquibase/integration/commandline/Main.java

@@ -26,12 +26,15 @@
 import liquibase.logging.LogService;
 import liquibase.logging.Logger;
 import liquibase.logging.core.JavaLogService;
+import liquibase.logging.mdc.MdcKey;
+import liquibase.logging.mdc.MdcValue;
 import liquibase.resource.*;
 import liquibase.ui.ConsoleUIService;
 import liquibase.util.*;
 
 import java.io.*;
 import java.lang.reflect.Field;
+import java.net.InetAddress;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.net.URLClassLoader;
@@ -324,6 +327,10 @@ public Integer run() throws Exception {
                             }
                         }
 
+                        Scope.getCurrentScope().getMdcManager().put(MdcKey.LIQUIBASE_VERSION, LiquibaseUtil.getBuildVersionInfo());
+                        Scope.getCurrentScope().getMdcManager().put(MdcKey.LIQUIBASE_SYSTEM_USER, System.getProperty("user.name"));
+                        Scope.getCurrentScope().getMdcManager().put(MdcKey.LIQUIBASE_SYSTEM_NAME, InetAddress.getLocalHost().getHostName());
+
                         LicenseService licenseService = Scope.getCurrentScope().getSingleton(LicenseServiceFactory.class).getLicenseService();
                         if (licenseService != null) {
                             if (main.liquibaseProLicenseKey == null) {
@@ -393,9 +400,13 @@ public Integer run() throws Exception {
                         if (!Main.runningFromNewCli) {
                             innerScopeObjects.put(Scope.Attr.resourceAccessor.name(), new ClassLoaderResourceAccessor(main.configureClassLoader()));
                         }
+                        Scope.getCurrentScope().getMdcManager().remove(MdcKey.LIQUIBASE_VERSION);
+                        Scope.getCurrentScope().getMdcManager().remove(MdcKey.LIQUIBASE_SYSTEM_NAME);
+                        Scope.getCurrentScope().getMdcManager().remove(MdcKey.LIQUIBASE_SYSTEM_USER);
+
                         Scope.child(innerScopeObjects, () -> {
                             main.doMigration();
-
+                            Scope.getCurrentScope().addMdcValue(MdcKey.DEPLOYMENT_OUTCOME, MdcValue.COMMAND_SUCCESSFUL);
                             if (!Main.runningFromNewCli) {
                                 if (COMMANDS.UPDATE.equals(main.command)) {
                                     Scope.getCurrentScope().getUI().sendMessage(coreBundle.getString("update.successful"));
@@ -407,6 +418,7 @@ public Integer run() throws Exception {
                             }
                         });
                     } catch (Throwable e) {
+                        Scope.getCurrentScope().addMdcValue(MdcKey.DEPLOYMENT_OUTCOME, MdcValue.COMMAND_FAILED);
                         String message = e.getMessage();
                         if (e.getCause() != null) {
                             message = e.getCause().getMessage();
@@ -1831,7 +1843,9 @@ protected void doMigration() throws Exception {
             }
 
             try {
+                Scope.getCurrentScope().addMdcValue(MdcKey.LIQUIBASE_COMMAND_NAME, command);
                 if (COMMANDS.UPDATE.equalsIgnoreCase(command)) {
+                    Scope.getCurrentScope().addMdcValue(MdcKey.OPERATION_TYPE, COMMANDS.UPDATE);
                     try {
                         liquibase.update(new Contexts(contexts), new LabelExpression(getLabelFilter()));
                     } catch (LiquibaseException updateException) {

liquibase-core/src/main/java/liquibase/logging/LogFormat.java

@@ -0,0 +1,6 @@
+package liquibase.logging;
+
+public enum LogFormat {
+    TEXT,
+    JSON
+}

liquibase-core/src/main/java/liquibase/logging/mdc/MdcKey.java

@@ -0,0 +1,20 @@
+package liquibase.logging.mdc;
+
+public class MdcKey {
+    public static final String DEPLOYMENT_ID = "deploymentId";
+    public static final String CHANGESET_ID = "changesetId";
+    public static final String CHANGESET_AUTHOR = "changesetAuthor";
+    public static final String CHANGESET_FILEPATH = "changesetFilepath";
+    public static final String CHANGESET_OUTCOME = "changesetOutcome";
+    public static final String OPERATION_TYPE = "liquibaseOperation";
+    public static final String OPERATION_TARGET_TYPE = "liquibaseTargetType";
+    public static final String OPERATION_TARGET_VALUE = "liquibaseTarget";
+    public static final String CHANGESET_OPERATION_START_TIME = "changesetOperationStart";
+    public static final String CHANGESET_OPERATION_STOP_TIME = "changesetOperationStop";
+    public static final String CHANGESET_SQL = "changesetSql";
+    public static final String DEPLOYMENT_OUTCOME = "deploymentOutcome";
+    public static final String LIQUIBASE_COMMAND_NAME = "liquibaseCommandName";
+    public static final String LIQUIBASE_VERSION = "liquibaseVersion";
+    public static final String LIQUIBASE_SYSTEM_NAME = "liquibaseSystemName";
+    public static final String LIQUIBASE_SYSTEM_USER = "liquibaseSystemUser";
+}

liquibase-core/src/main/java/liquibase/logging/mdc/MdcValue.java

@@ -0,0 +1,7 @@
+package liquibase.logging.mdc;
+
+public class MdcValue {
+    public static final String COMMAND_SUCCESSFUL = "success";
+    public static final String COMMAND_FAILED = "fail";
+    public static final String URL_DATABASE_TARGET = "url";
+}