[Improvement-18039][Metrics] Add missing metrics for workflow and task state transitions by sanjana2505006 · Pull Request #18038 · apache/dolphinscheduler

sanjana2505006 · 2026-03-09T05:32:07Z

Purpose

This PR adds missing metrics to the Master module to improve visibility into workflow and task execution states. It addresses the gap where several metrics classes were defined but not utilized in the core execution flow.

Proposed Changes

Added workflow instance state tracking in AbstractWorkflowStateAction.
Added granular task state tracking (dispatch, success, failure, kill, retry) in AbstractTaskStateAction.
Added task timeout metric tracking in TaskTimeoutLifecycleEventHandler.
Added workflow instance generation duration measurement in WorkflowExecutionRunnableFactory.

Verification

Verified code style with mvn spotless:apply.
Performed final code review to ensure metrics integration follows existing patterns.

This PR closes #18039

SbloodyS

Please follow the pull request notice and create an issue first. @sanjana2505006

sanjana2505006 · 2026-03-09T06:06:20Z

Thank you @SbloodyS , for the guidance! I've created the issue #18039 and updated the PR title and commit to reference it.

SbloodyS · 2026-03-10T03:36:58Z

Please check the failed CI. @sanjana2505006

sanjana2505006 · 2026-03-10T05:03:13Z

Sure, @SbloodyS, I have an exam today. I’ll take a look at the failed CI once I’m done 😃...

sanjana2505006 · 2026-03-10T18:13:35Z

Hello @SbloodyS, I've updated the PR to address the CI failures. Please have a look when you have time and share your feedback. Thank you!

SbloodyS · 2026-03-16T09:16:24Z

UT still failed. @sanjana2505006

ruanwenjun

Thanks for your PR.
It might be better to add event metrics first.

WorkflowEventBusFireWorker#doFireSingleWorkflowEventBus

We may need to provide a public method to handle changes in instance state, and then use listeners or similar mechanisms to update the metrics.
So it’s not suitable to add this directly at the moment, but I’ll be doing that soon.

…sage - Add back empty line in AbstractTaskStateAction.java line 199 as requested - Add incTaskInstanceByLifecycleEvent method to TaskMetrics to use TaskLifecycleEventType directly - Update WorkflowEventBusFireWorker to use new method instead of string comparisons - Add comprehensive tests for new lifecycle event method Addresses feedback from SbloodyS and ruanwenjun on PR apache#18038

sonarqubecloud · 2026-04-02T07:53:47Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 60%)

See analysis details on SonarQube Cloud

sanjana2505006 · 2026-06-09T15:17:24Z

@SbloodyS I've updated the pr according to your feedback , please have a look
and let me know what else to change

SbloodyS · 2026-06-10T07:12:59Z

+    public void incTaskInstanceByState(final String state) {
+        if (taskInstanceCounters.get(state) == null) {
+            return;
+        }
+        taskInstanceCounters.get(state).increment();
+    }


We should store TaskLifecycleEventType.name() directly. You can refer to org.apache.dolphinscheduler.server.master.metrics.WorkflowInstanceMetrics

det101 · 2026-06-26T08:46:38Z

+    }
+
+    @Test
+    void testCleanUpWorkflowInstanceCountMetricsByDefinitionCode() {


After rebasing onto latest dev, WorkflowInstanceMetricsTest#testCleanUp... may fail to compile because cleanUpWorkflowInstanceCountMetricsByDefinitionCode was removed in #18205. Also, counter tags should use WorkflowExecutionStatus.name() (e.g. SUBMITTED_SUCCESS), not submit/fail.

Thanks for catching that. Rebased onto latest dev, removed the cleanup test (method was dropped in #18205), and updated all counter tag assertions to use WorkflowExecutionStatus.name() — e.g. SUBMITTED_SUCCESS instead of "submit".

…k state transitions Record workflow instance state changes in AbstractWorkflowStateAction, workflow generation duration in WorkflowExecutionFactory, and task lifecycle metrics via TaskLifecycleEventType in WorkflowEventBusFireWorker. Add unit tests for TaskMetrics and WorkflowInstanceMetrics.

SbloodyS · 2026-06-27T02:28:20Z

You should check failed UT. @sanjana2505006

sanjana2505006 requested review from SbloodyS, caishunfeng and ruanwenjun as code owners March 9, 2026 05:32

github-actions Bot added backend test labels Mar 9, 2026

github-actions Bot assigned sanjana2505006 Mar 9, 2026

sanjana2505006 force-pushed the Improvement-Metrics branch from 990a504 to 6176e33 Compare March 9, 2026 05:32

github-actions Bot removed the test label Mar 9, 2026

sanjana2505006 changed the title ~~[Improvement-Metrics][master] Add missing metrics for workflow and task state transitions~~ [Improvement][master] Add missing metrics for workflow and task state transitions Mar 9, 2026

sanjana2505006 changed the title ~~[Improvement][master] Add missing metrics for workflow and task state transitions~~ [Improvement] Add missing metrics for workflow and task state transitions Mar 9, 2026

sanjana2505006 changed the title ~~[Improvement] Add missing metrics for workflow and task state transitions~~ [Improvement][master]Add missing metrics for workflow and task state transitions Mar 9, 2026

sanjana2505006 changed the title ~~[Improvement][master]Add missing metrics for workflow and task state transitions~~ [Improvement][master] Add missing metrics for workflow and task state transitions Mar 9, 2026

SbloodyS reviewed Mar 9, 2026

View reviewed changes

sanjana2505006 changed the title ~~[Improvement][master] Add missing metrics for workflow and task state transitions~~ [Improvement-18039][Metrics] Add missing metrics for workflow and task state transitions Mar 9, 2026

sanjana2505006 force-pushed the Improvement-Metrics branch from 9c47397 to c0013cc Compare March 9, 2026 06:05

sanjana2505006 requested a review from SbloodyS March 9, 2026 06:06

SbloodyS added the improvement make more easy to user or prompt friendly label Mar 9, 2026

SbloodyS added this to the 3.4.2 milestone Mar 9, 2026

sanjana2505006 force-pushed the Improvement-Metrics branch from 2a2647b to edeef4e Compare March 10, 2026 17:44

github-actions Bot added the test label Mar 11, 2026

ruanwenjun reviewed Mar 20, 2026

View reviewed changes

Comment thread ...nscheduler/server/master/engine/task/lifecycle/handler/TaskTimeoutLifecycleEventHandler.java Outdated

Comment thread .../apache/dolphinscheduler/server/master/engine/task/statemachine/AbstractTaskStateAction.java Outdated

sanjana2505006 requested a review from ruanwenjun March 24, 2026 19:23

sanjana2505006 force-pushed the Improvement-Metrics branch from f4919d7 to e30a3d3 Compare March 24, 2026 19:26

SbloodyS reviewed Mar 30, 2026

View reviewed changes

Comment thread ...c/main/java/org/apache/dolphinscheduler/server/master/engine/WorkflowEventBusFireWorker.java Outdated

SbloodyS reviewed Mar 30, 2026

View reviewed changes

Comment thread .../apache/dolphinscheduler/server/master/engine/task/statemachine/AbstractTaskStateAction.java

sanjana2505006 force-pushed the Improvement-Metrics branch from 83a0f5d to 7469149 Compare April 2, 2026 07:34

sanjana2505006 requested a review from SbloodyS April 2, 2026 16:32

SbloodyS modified the milestones: 3.4.2, 3.5.0 Jun 3, 2026

sanjana2505006 force-pushed the Improvement-Metrics branch from 817d2aa to b5ae074 Compare June 9, 2026 15:21

SbloodyS requested changes Jun 10, 2026

View reviewed changes

det101 reviewed Jun 26, 2026

View reviewed changes

sanjana2505006 force-pushed the Improvement-Metrics branch from b5ae074 to e6c6faf Compare June 26, 2026 15:36

sanjana2505006 force-pushed the Improvement-Metrics branch from e6c6faf to 65164d6 Compare June 26, 2026 15:41

sanjana2505006 requested a review from SbloodyS June 26, 2026 15:42

Uh oh!

Conversation

sanjana2505006 commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Proposed Changes

Verification

Uh oh!

SbloodyS left a comment

Choose a reason for hiding this comment

Uh oh!

sanjana2505006 commented Mar 9, 2026

Uh oh!

SbloodyS commented Mar 10, 2026

Uh oh!

sanjana2505006 commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sanjana2505006 commented Mar 10, 2026

Uh oh!

SbloodyS commented Mar 16, 2026

Uh oh!

ruanwenjun left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Apr 2, 2026

Quality Gate failed

Uh oh!

sanjana2505006 commented Jun 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SbloodyS Jun 10, 2026

Choose a reason for hiding this comment

Uh oh!

det101 Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

sanjana2505006 Jun 26, 2026

Choose a reason for hiding this comment

Uh oh!

SbloodyS commented Jun 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sanjana2505006 commented Mar 9, 2026 •

edited

Loading

sanjana2505006 commented Mar 10, 2026 •

edited

Loading

sanjana2505006 commented Jun 9, 2026 •

edited

Loading