dolphinscheduler icon indicating copy to clipboard operation
dolphinscheduler copied to clipboard

[DSIP-92][Alert] Support DolphinScheduler Configuration Markdown and String Alert Template

Open HeyAlaia opened this issue 5 months ago • 6 comments

Search before asking

  • [x] I had searched in the DSIP and found no similar DSIP.

Motivation

I want use dolphinScheduler configuration markdown or string alert template, like is:

markdown
   ## ${alertSubject}
    * project name: ${projectName}
    * workflow name: ${workflowName}
    * alert time: ${alertTime}
    * alert status: ${alertStatus}

or

string
   ${alertSubject}, project name: ${projectName}, workflow name: ${workflowName}

But this feature was not found.

Design Detail

In the alert instance editor, if you select the any plugin (Need plugin support) and choose Markdown or String as the message type,If it is a string, it will be the same as before, if markdown need a larger text box will appear below. Use this box to enter your Markdown template. You can use JSON strings (System built-in: like ${alertSubject}, ${projectName}, ${alertTime} etc.) to dynamically replace values within the template. like is:

Image

Compatibility, Deprecation, and Migration Plan

This feature is fully backward-compatible and introduces Markdown, string template substitution. Data returned to any plugin will be automatically parsed for formatting.

Test Plan

Functional testing

Code of Conduct

HeyAlaia avatar Jul 30 '25 10:07 HeyAlaia

+1.

We can provide the built-in workflow instance properties, and assemble this into the template, both in text/markdown. And all plugins can use the template syntax.

ruanwenjun avatar Jul 31 '25 02:07 ruanwenjun

+1.

We can provide the built-in workflow instance properties, and assemble this into the template, both in text/markdown. And all plugins can use the template syntax.

Given the inconsistent template support among plugins, this feature is becoming complex. Let's proceed with developing an MVP version for now.

HeyAlaia avatar Jul 31 '25 02:07 HeyAlaia

Given the inconsistent template support among plugins, this feature is becoming complex. Let's proceed with developing an MVP version for now.

As @ruanwenjun said, we should provide a unified way for all plugins to use. We don't need an MVP version since this is an open source project, not a commercial product.

SbloodyS avatar Jul 31 '25 02:07 SbloodyS

Given the inconsistent template support among plugins, this feature is becoming complex. Let's proceed with developing an MVP version for now.

As @ruanwenjun said, we should provide a unified way for all plugins to use. We don't need an MVP version since this is an open source project, not a commercial product.

ok, need modify this issue?

HeyAlaia avatar Jul 31 '25 07:07 HeyAlaia

ok, need modify this issue?

Yes. You also need to supplement the design details, you can refer to #16423.

SbloodyS avatar Aug 05 '25 01:08 SbloodyS

ok, need modify this issue?

Yes. You also need to supplement the design details, you can refer to #16423.

done

HeyAlaia avatar Aug 21 '25 01:08 HeyAlaia