apache/dolphinscheduler

[Improvement][Alter] Add instance link to alert like email

Open

#16,716 opened on Oct 21, 2024

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Java (11,659 stars) (4,324 forks)batch import
discussionhelp wantedimprovement

Description

Search before asking

  • I had searched in the issues and found no similar feature requirement.

Description

image

image

The current alert content has some information like projectName, processName, logPath, I am consider can we add the task instance link to the content. Then when job failed we can click the link directly into the instance, to check the log.

The link address pattern is like:

http://<uiAddress>/dolphinscheduler/ui/projects/<projectCode>/workflow/instances/<processId>?code=<processDefinitionCode>
  • uiAddress need config when startup
  • projectCode, processId, processDefinitionCode all can get them directly, because the current content has those fields.

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor guide

Tech stack
java
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Java knowledgefamiliarity with alert module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Examine the email alert plugin code in the DolphinScheduler repository to find where alert content is generated. Identify how projectCode, processId, and processDefinitionCode are accessed. Determine the existing template or string concatenation used for the email body. Then, integrate the instance link by appending it to the alert content, using a configurable uiAddress. The configuration for uiAddress may need to be added to the alert plugin or global settings.