[DSIP-107] Add separate workflow instance logs for UI viewing, similar to task logs.

dolphinscheduler-dao/src/main/java/org/apache/dolphinscheduler/dao/entity/WorkflowInstance.java

@@ -158,6 +158,8 @@ public class WorkflowInstance {
 
     private Date restartTime;
 
+    private String logPath;
+
     /**
      * set the process name with process define version and timestamp
      *

dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_h2.sql

@@ -636,6 +636,7 @@ CREATE TABLE t_ds_workflow_instance
     var_pool                   longtext,
     dry_run                    int NULL DEFAULT 0,
     restart_time               datetime     DEFAULT NULL,
+    log_path                   longtext     DEFAULT NULL,
     PRIMARY KEY (id)
 );
 

dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_mysql.sql

@@ -644,6 +644,7 @@ CREATE TABLE `t_ds_workflow_instance` (
   `dry_run` tinyint(4) DEFAULT '0' COMMENT 'dry run flag：0 normal, 1 dry run',
   `next_workflow_instance_id` int(11) DEFAULT '0' COMMENT 'serial queue next workflowInstanceId',
   `restart_time` datetime DEFAULT NULL COMMENT 'workflow instance restart time',
+  `log_path` longtext DEFAULT NULL COMMENT 'workflow instance log path',
   PRIMARY KEY (`id`),
   KEY `workflow_instance_index` (`workflow_definition_code`,`id`) USING BTREE,
   KEY `start_time_index` (`start_time`,`end_time`) USING BTREE

dolphinscheduler-dao/src/main/resources/sql/dolphinscheduler_postgresql.sql

@@ -584,6 +584,7 @@ CREATE TABLE t_ds_workflow_instance (
   dry_run int DEFAULT '0' ,
   next_workflow_instance_id int DEFAULT '0',
   restart_time timestamp DEFAULT NULL ,
+  log_path text DEFAULT NULL ,
   PRIMARY KEY (id)
 ) ;
 

dolphinscheduler-dao/src/main/resources/sql/upgrade/3.4.2_schema/mysql/dolphinscheduler_ddl.sql

@@ -0,0 +1,19 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+ALTER TABLE `t_ds_workflow_instance`
+ADD COLUMN `log_path` longtext NULL COMMENT 'workflow instance log path';

dolphinscheduler-dao/src/main/resources/sql/upgrade/3.4.2_schema/mysql/dolphinscheduler_dml.sql

@@ -0,0 +1,16 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/

dolphinscheduler-dao/src/main/resources/sql/upgrade/3.4.2_schema/postgresql/dolphinscheduler_ddl.sql

@@ -0,0 +1,18 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/
+
+ALTER TABLE t_ds_workflow_instance ADD COLUMN IF NOT EXISTS "log_path" text DEFAULT NULL;

dolphinscheduler-dao/src/main/resources/sql/upgrade/3.4.2_schema/postgresql/dolphinscheduler_dml.sql

@@ -0,0 +1,16 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+*/

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/WorkflowEventBusFireWorker.java

@@ -29,6 +29,7 @@
 import org.apache.dolphinscheduler.server.master.engine.workflow.execution.IWorkflowExecution;
 import org.apache.dolphinscheduler.server.master.runner.IWorkflowExecuteContext;
 import org.apache.dolphinscheduler.server.master.utils.ExceptionUtils;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.collections4.MapUtils;
@@ -86,11 +87,14 @@ public void fireAllRegisteredEvent() {
             final String workflowInstanceName = workflowExecution.getName();
             try {
                 LogUtils.setWorkflowInstanceIdMDC(workflowInstanceId);
+                WorkflowLogUtils.setWorkflowInstanceLogFullPathMDC(
+                        workflowExecution.getWorkflowExecuteContext().getWorkflowInstance().getLogPath());
                 doFireSingleWorkflowEventBus(workflowExecution);
             } catch (Exception ex) {
                 log.error("Fire event failed for WorkflowExecuteRunnable: {}", workflowInstanceName, ex);
             } finally {
                 LogUtils.removeWorkflowInstanceIdMDC();
+                WorkflowLogUtils.removeWorkflowInstanceLogFullPathMDC();
             }
         }
     }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/AbstractCommandHandler.java

@@ -81,6 +81,7 @@ public WorkflowExecution handleCommand(final Command command) {
         assembleWorkflowInstanceLifecycleListeners(workflowExecuteContextBuilder);
         assembleWorkflowEventBus(workflowExecuteContextBuilder);
         assembleWorkflowExecutionGraph(workflowExecuteContextBuilder);
+        assembleLogPath(workflowExecuteContextBuilder);
 
         final WorkflowExecutionBuilder workflowExecutionBuilder = WorkflowExecutionBuilder
                 .builder()
@@ -159,4 +160,8 @@ protected void assembleProject(
         workflowExecuteContextBuilder.setProject(project);
     }
 
+    protected void assembleLogPath(final WorkflowExecuteContextBuilder workflowExecuteContextBuilder) {
+        workflowExecuteContextBuilder.setLogPath(workflowExecuteContextBuilder.getWorkflowInstance().getLogPath());
+    }
+
 }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/ExecuteTaskCommandHandler.java

@@ -36,6 +36,7 @@
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecution;
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecutionBuilder;
 import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import org.apache.commons.collections4.CollectionUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -86,6 +87,12 @@ protected void assembleWorkflowInstance(final WorkflowExecuteContextBuilder work
             workflowInstance.setTaskDependType(command.getTaskDependType());
         }
         workflowInstance.setHost(masterConfig.getMasterAddress());
+        workflowInstance.setLogPath(WorkflowLogUtils.getWorkflowInstanceLogFullPath(
+                workflowInstance.getRestartTime(),
+                workflowInstance.getWorkflowDefinitionCode(),
+                workflowInstance.getWorkflowDefinitionVersion(),
+                workflowInstance.getId()));
+
         workflowInstanceDao.updateById(workflowInstance);
         workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance);
     }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/ReRunWorkflowCommandHandler.java

@@ -26,6 +26,7 @@
 import org.apache.dolphinscheduler.dao.repository.WorkflowInstanceDao;
 import org.apache.dolphinscheduler.server.master.config.MasterConfig;
 import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import java.util.Date;
 import java.util.List;
@@ -74,6 +75,12 @@ protected void assembleWorkflowInstance(final WorkflowExecuteContextBuilder work
         workflowInstance.setHost(masterConfig.getMasterAddress());
         workflowInstance.setEndTime(null);
         workflowInstance.setRunTimes(workflowInstance.getRunTimes() + 1);
+        workflowInstance.setLogPath(WorkflowLogUtils.getWorkflowInstanceLogFullPath(
+                workflowInstance.getRestartTime(),
+                workflowInstance.getWorkflowDefinitionCode(),
+                workflowInstance.getWorkflowDefinitionVersion(),
+                workflowInstance.getId()));
+
         workflowInstanceDao.updateById(workflowInstance);
 
         workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance);

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/RecoverFailureTaskCommandHandler.java

@@ -33,6 +33,7 @@
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecutionBuilder;
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskInstanceFactories;
 import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import java.util.ArrayList;
 import java.util.HashSet;
@@ -95,6 +96,12 @@ protected void assembleWorkflowInstance(
         workflowInstance.setStateWithDesc(WorkflowExecutionStatus.RUNNING_EXECUTION, command.getCommandType().name());
         workflowInstance.setCommandType(command.getCommandType());
         workflowInstance.setHost(masterConfig.getMasterAddress());
+        workflowInstance.setLogPath(WorkflowLogUtils.getWorkflowInstanceLogFullPath(
+                workflowInstance.getStartTime(),
+                workflowInstance.getWorkflowDefinitionCode(),
+                workflowInstance.getWorkflowDefinitionVersion(),
+                workflowInstance.getId()));
+
         workflowInstanceDao.updateById(workflowInstance);
 
         workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance);

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/RecoverSerialWaitCommandHandler.java

@@ -24,6 +24,7 @@
 import org.apache.dolphinscheduler.dao.repository.WorkflowInstanceDao;
 import org.apache.dolphinscheduler.server.master.config.MasterConfig;
 import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
@@ -45,6 +46,12 @@ protected void assembleWorkflowInstance(WorkflowExecuteContext.WorkflowExecuteCo
                 .orElseThrow(() -> new IllegalArgumentException("Cannot find WorkflowInstance:" + workflowInstanceId));
         workflowInstance.setStateWithDesc(WorkflowExecutionStatus.RUNNING_EXECUTION, command.getCommandType().name());
         workflowInstance.setHost(masterConfig.getMasterAddress());
+        workflowInstance.setLogPath(WorkflowLogUtils.getWorkflowInstanceLogFullPath(
+                workflowInstance.getRestartTime(),
+                workflowInstance.getWorkflowDefinitionCode(),
+                workflowInstance.getWorkflowDefinitionVersion(),
+                workflowInstance.getId()));
+
         workflowInstanceDao.updateById(workflowInstance);
         workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance);
     }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/RunWorkflowCommandHandler.java

@@ -35,6 +35,7 @@
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecution;
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecutionBuilder;
 import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import org.apache.commons.collections4.CollectionUtils;
 
@@ -77,6 +78,12 @@ protected void assembleWorkflowInstance(final WorkflowExecuteContextBuilder work
         workflowInstance.setHost(masterConfig.getMasterAddress());
         workflowInstance.setCommandParam(command.getCommandParam());
         workflowInstance.setGlobalParams(mergeCommandParamsWithWorkflowParams(command, workflowDefinition));
+        workflowInstance.setLogPath(WorkflowLogUtils.getWorkflowInstanceLogFullPath(
+                workflowInstance.getStartTime(),
+                workflowInstance.getWorkflowDefinitionCode(),
+                workflowInstance.getWorkflowDefinitionVersion(),
+                workflowInstance.getId()));
+
         workflowInstanceDao.upsertWorkflowInstance(workflowInstance);
         workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance);
     }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/command/handler/WorkflowFailoverCommandHandler.java

@@ -31,6 +31,7 @@
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecution;
 import org.apache.dolphinscheduler.server.master.engine.task.execution.TaskExecutionBuilder;
 import org.apache.dolphinscheduler.server.master.runner.WorkflowExecuteContext.WorkflowExecuteContextBuilder;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import java.util.Date;
 import java.util.Map;
@@ -89,6 +90,12 @@ protected void assembleWorkflowInstance(
         workflowInstance.setRestartTime(new Date());
         workflowInstance.setState(workflowFailoverCommandParam.getWorkflowExecutionStatus());
         workflowInstance.setHost(masterConfig.getMasterAddress());
+        workflowInstance.setLogPath(WorkflowLogUtils.getWorkflowInstanceLogFullPath(
+                workflowInstance.getRestartTime(),
+                workflowInstance.getWorkflowDefinitionCode(),
+                workflowInstance.getWorkflowDefinitionVersion(),
+                workflowInstance.getId()));
+
         workflowInstanceDao.updateById(workflowInstance);
 
         workflowExecuteContextBuilder.setWorkflowInstance(workflowInstance);

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/task/dispatcher/WorkerGroupDispatcher.java

@@ -25,6 +25,7 @@
 import org.apache.dolphinscheduler.server.master.engine.task.dispatcher.event.TaskDispatchableEvent;
 import org.apache.dolphinscheduler.server.master.engine.task.execution.ITaskExecution;
 import org.apache.dolphinscheduler.server.master.engine.task.lifecycle.event.TaskFailedLifecycleEvent;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 import org.apache.dolphinscheduler.task.executor.log.TaskExecutorMDCUtils;
 
 import java.util.Date;
@@ -93,9 +94,12 @@ public void run() {
                     TaskExecutorMDCUtils.MDCAutoClosable ignore =
                             TaskExecutorMDCUtils.logWithMDC(taskExecution.getId())) {
                 LogUtils.setWorkflowInstanceIdMDC(taskExecution.getTaskInstance().getWorkflowInstanceId());
+                WorkflowLogUtils
+                        .setWorkflowInstanceLogFullPathMDC(taskExecution.getWorkflowInstance().getLogPath());
                 doDispatchTask(taskExecution);
             } finally {
                 LogUtils.removeWorkflowInstanceIdMDC();
+                WorkflowLogUtils.removeWorkflowInstanceLogFullPathMDC();
             }
         }
     }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/engine/workflow/statemachine/AbstractWorkflowStateAction.java

@@ -38,6 +38,7 @@
 import org.apache.dolphinscheduler.server.master.engine.workflow.policy.IWorkflowFailureStrategy;
 import org.apache.dolphinscheduler.server.master.metrics.WorkflowInstanceMetrics;
 import org.apache.dolphinscheduler.server.master.utils.WorkflowInstanceUtils;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 import org.apache.dolphinscheduler.service.alert.WorkflowAlertManager;
 
 import org.apache.commons.collections4.CollectionUtils;
@@ -116,12 +117,15 @@ protected void triggerTasks(final IWorkflowExecution workflowExecution,
     protected void pauseActiveTask(final IWorkflowExecution workflowExecution) {
         try {
             LogUtils.setWorkflowInstanceIdMDC(workflowExecution.getId());
+            WorkflowLogUtils.setWorkflowInstanceLogFullPathMDC(
+                    workflowExecution.getWorkflowExecuteContext().getWorkflowInstance().getLogPath());
             workflowExecution
                     .getWorkflowExecutionGraph()
                     .getActiveTaskExecution()
                     .forEach(ITaskExecution::pause);
         } finally {
             LogUtils.removeWorkflowInstanceIdMDC();
+            WorkflowLogUtils.removeWorkflowInstanceLogFullPathMDC();
         }
     }
 

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/failover/TaskFailover.java

@@ -20,6 +20,7 @@
 import org.apache.dolphinscheduler.plugin.task.api.utils.LogUtils;
 import org.apache.dolphinscheduler.server.master.engine.task.execution.ITaskExecution;
 import org.apache.dolphinscheduler.server.master.engine.task.lifecycle.event.TaskFailoverLifecycleEvent;
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
 
 import org.springframework.stereotype.Component;
 
@@ -30,6 +31,7 @@ public void failoverTask(final ITaskExecution taskExecution) {
         LogUtils.setWorkflowInstanceIdMDC(taskExecution.getWorkflowInstance().getId());
         taskExecution.getWorkflowEventBus().publish(TaskFailoverLifecycleEvent.of(taskExecution));
         LogUtils.removeWorkflowInstanceIdMDC();
+        WorkflowLogUtils.removeWorkflowInstanceLogFullPathMDC();
     }
 
 }

dolphinscheduler-master/src/main/java/org/apache/dolphinscheduler/server/master/log/WorkflowLogDiscriminator.java

@@ -0,0 +1,52 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.dolphinscheduler.server.master.log;
+
+import org.apache.dolphinscheduler.server.master.utils.WorkflowLogUtils;
+
+import lombok.Getter;
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
+
+import org.slf4j.MDC;
+
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.sift.AbstractDiscriminator;
+
+/**
+ * Workflow Log Discriminator
+ */
+@Slf4j
+@Getter
+@Setter
+public class WorkflowLogDiscriminator extends AbstractDiscriminator<ILoggingEvent> {
+
+    private String key;
+
+    private String logBase;
+
+    @Override
+    public String getDiscriminatingValue(ILoggingEvent event) {
+        String workflowInstanceLogPath = MDC.get(WorkflowLogUtils.WORKFLOW_INSTANCE_LOG_FULL_PATH_MDC_KEY);
+        if (workflowInstanceLogPath == null) {
+            log.error("The workflow instance log path is null, please check the logback configuration, log: {}", event);
+        }
+        return workflowInstanceLogPath;
+    }
+
+}