[feature#14654] alert-spi support prometheus alertmanager #15079

xjlgod · 2023-10-25T12:54:20Z

Purpose of the pull request

To add alert-api for prometheus alertmanager close #14654.
The implementation principle is to request its alert interface through http client to generate an alert.
api document

Brief change log

a new moudle dolphinscheduler-alert-prometheus be added

Verify this pull request

create alert instance to test it.

codecov-commenter · 2023-10-26T01:10:06Z

Codecov Report

Merging #15079 (36aa3fa) into dev (0121c5d) will increase coverage by 0.07%.
Report is 1 commits behind head on dev.
The diff coverage is 66.94%.

❗ Current head 36aa3fa differs from pull request most recent head cf4c6ed. Consider uploading reports for the commit cf4c6ed to get more accurate results

@@             Coverage Diff              @@
##                dev   #15079      +/-   ##
============================================
+ Coverage     38.17%   38.24%   +0.07%     
- Complexity     4681     4693      +12     
============================================
  Files          1281     1285       +4     
  Lines         45350    45412      +62     
  Branches       4941     4926      -15     
============================================
+ Hits          17311    17367      +56     
- Misses        26151    26154       +3     
- Partials       1888     1891       +3

Files	Coverage Δ
...nscheduler/api/service/impl/DqRuleServiceImpl.java	`59.18% <100.00%> (ø)`
...cheduler/plugin/task/dq/utils/RuleParserUtils.java	`87.03% <100.00%> (ø)`
...lert/prometheus/PrometheusAlertChannelFactory.java	`95.65% <95.65%> (ø)`
...gin/alert/prometheus/PrometheusAlertConstants.java	`0.00% <0.00%> (ø)`
...apache/dolphinscheduler/dao/utils/DqRuleUtils.java	`0.00% <0.00%> (ø)`
...inscheduler/plugin/task/api/enums/dp/DataType.java	`88.88% <85.71%> (ø)`
...er/runner/execute/TaskExecutionContextFactory.java	`0.00% <0.00%> (ø)`
...lugin/alert/prometheus/PrometheusAlertChannel.java	`16.66% <16.66%> (ø)`
...plugin/alert/prometheus/PrometheusAlertSender.java	`62.16% <62.16%> (ø)`

... and 27 files with indirect coverage changes

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

...us/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSender.java

Gallardot · 2023-10-26T06:15:47Z

...us/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSender.java

+    }
+
+    private static CloseableHttpClient getDefaultClient() {
+        return HttpClients.createDefault();


dolphinscheduler/dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-http/src/main/java/org/apache/dolphinscheduler/plugin/alert/http/HttpSender.java

Lines 110 to 116 in a5284e4

public String getResponseString(HttpRequestBase httpRequest) throws IOException {

CloseableHttpClient httpClient =

HttpClients.custom().setRetryHandler(HttpServiceRetryStrategy.retryStrategy).build();

CloseableHttpResponse response = httpClient.execute(httpRequest);

HttpEntity entity = response.getEntity();

return EntityUtils.toString(entity, DEFAULT_CHARSET);

}

Based on the implementation of other plugins, it is recommended to use an HTTP client that supports retrying

Gallardot

Rest LGTM.

Gallardot · 2023-10-30T07:11:54Z

...rc/test/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSenderTest.java

+
+    @BeforeEach
+    public void initConfig() {
+        config.put(AlertManagerConstants.NAME_ALERT_MANAGER_URL, "http://127.0.0.1:9093");


How does this unit test mock an AlertManager-Server and pass the test?

I set the unit test result to false. If need, I can add test to mock an AlertManager-Server. I did not add it for there is no mock for third server in any other alert plugins.

Got it. LGTM.

Gallardot · 2023-10-31T10:44:42Z

@SbloodyS @Radeity @EricGao888 @qingwli PTAL.

...nscheduler-alert-api/src/main/java/org/apache/dolphinscheduler/alert/api/AlertInputTips.java

...us/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSender.java

Radeity · 2023-11-01T03:15:39Z

In addition, file name in package org.apache.dolphinscheduler.plugin.alert.prometheus should start with Prometheus, like PrometheusAlertChannel and PrometheusSender.

xjlgod · 2023-11-02T13:57:16Z

In addition, file name in package org.apache.dolphinscheduler.plugin.alert.prometheus should start with Prometheus, like PrometheusAlertChannel and PrometheusSender.

OK

qingwli · 2023-11-03T02:13:12Z

...src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/PrometheusAlertSender.java

+            log.error("send prometheus alert manager alert msg  exception: {}", e.getMessage());
+            alertResult = new AlertResult();
+            alertResult.setStatus("false");
+            alertResult.setMessage("send prometheus alert manager alert fail.");


Please add error into the message

qingwli

Others LGTM

...src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/PrometheusAlertSender.java

…cheduler-alert-prometheus/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/PrometheusAlertSender.java Co-authored-by: 旺阳 <[email protected]>

qingwli

LGTM

qingwli · 2023-11-13T03:13:12Z

PTAL @Radeity

sonarqubecloud · 2023-11-13T03:38:31Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
15 Code Smells

66.2% Coverage
0.0% Duplication

xjlgod requested review from Amy0104, caishunfeng and songjianet as code owners October 25, 2023 12:54

github-actions bot added UI ui and front end related backend labels Oct 25, 2023

xjlgod changed the title ~~[feature#14654] alert-spi support prometheus alertmanager~~ [WIP][feature#14654] alert-spi support prometheus alertmanager Oct 25, 2023

xjlgod force-pushed the alertManager branch from ad9f493 to fde0d25 Compare October 25, 2023 13:20

xjlgod changed the title ~~[WIP][feature#14654] alert-spi support prometheus alertmanager~~ [feature#14654] alert-spi support prometheus alertmanager Oct 25, 2023

songjianet previously approved these changes Oct 26, 2023

View reviewed changes

github-advanced-security bot found potential problems Oct 26, 2023

View reviewed changes

...us/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSender.java Fixed Show fixed Hide fixed

...us/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSender.java Fixed Show fixed Hide fixed

Gallardot reviewed Oct 26, 2023

View reviewed changes

SbloodyS assigned xjlgod Oct 26, 2023

SbloodyS added the 3.3.0 label Oct 26, 2023

SbloodyS added this to the 3.3.0 milestone Oct 26, 2023

SbloodyS added feature new feature first time contributor First-time contributor labels Oct 26, 2023

xjlgod dismissed songjianet’s stale review via b6aea33 October 26, 2023 12:23

xjlgod force-pushed the alertManager branch from ab19352 to b6aea33 Compare October 26, 2023 12:23

xjlgod requested review from Gallardot and songjianet October 27, 2023 15:33

Gallardot reviewed Oct 30, 2023

View reviewed changes

Gallardot approved these changes Oct 31, 2023

View reviewed changes

qingwli reviewed Nov 1, 2023

View reviewed changes

...nscheduler-alert-api/src/main/java/org/apache/dolphinscheduler/alert/api/AlertInputTips.java Outdated Show resolved Hide resolved

...us/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/AlertManagerSender.java Outdated Show resolved Hide resolved

Radeity reviewed Nov 1, 2023

View reviewed changes

feat alert-spi support prometheus alert manager

f3346d9

xjlgod force-pushed the alertManager branch from c090fca to f3346d9 Compare November 2, 2023 13:55

xjlgod requested review from Gallardot, Radeity and qingwli November 2, 2023 13:57

qingwli reviewed Nov 3, 2023

View reviewed changes

xjlgod and others added 2 commits November 5, 2023 22:07

fix: fix err into message

2a7d4dd

Merge branch 'dev' into alertManager

3070652

qingwli added the ready-to-merge label Nov 9, 2023

qingwli reviewed Nov 9, 2023

View reviewed changes

...src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/PrometheusAlertSender.java Outdated Show resolved Hide resolved

Update dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphins…

50da881

…cheduler-alert-prometheus/src/main/java/org/apache/dolphinscheduler/plugin/alert/prometheus/PrometheusAlertSender.java Co-authored-by: 旺阳 <[email protected]>

qingwli approved these changes Nov 10, 2023

View reviewed changes

Merge branch 'dev' into alertManager

cf4c6ed

Radeity approved these changes Nov 13, 2023

View reviewed changes

qingwli merged commit 6096c58 into apache:dev Nov 13, 2023

	public String getResponseString(HttpRequestBase httpRequest) throws IOException {
	CloseableHttpClient httpClient =
	HttpClients.custom().setRetryHandler(HttpServiceRetryStrategy.retryStrategy).build();
	CloseableHttpResponse response = httpClient.execute(httpRequest);
	HttpEntity entity = response.getEntity();
	return EntityUtils.toString(entity, DEFAULT_CHARSET);
	}

[feature#14654] alert-spi support prometheus alertmanager #15079

[feature#14654] alert-spi support prometheus alertmanager #15079

Uh oh!

Conversation

xjlgod commented Oct 25, 2023 • edited by SbloodyS Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of the pull request

Brief change log

Verify this pull request

Uh oh!

codecov-commenter commented Oct 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Gallardot Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

xjlgod Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

Gallardot left a comment

Choose a reason for hiding this comment

Uh oh!

Gallardot Oct 30, 2023

Choose a reason for hiding this comment

Uh oh!

xjlgod Oct 30, 2023

Choose a reason for hiding this comment

Uh oh!

Gallardot Oct 31, 2023

Choose a reason for hiding this comment

Uh oh!

Gallardot commented Oct 31, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Radeity commented Nov 1, 2023

Uh oh!

xjlgod commented Nov 2, 2023

Uh oh!

qingwli Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

xjlgod Nov 5, 2023

Choose a reason for hiding this comment

Uh oh!

qingwli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

qingwli left a comment

Choose a reason for hiding this comment

Uh oh!

qingwli commented Nov 13, 2023

Uh oh!

sonarqubecloud bot commented Nov 13, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

xjlgod commented Oct 25, 2023 •

edited by SbloodyS

Loading

codecov-commenter commented Oct 26, 2023 •

edited

Loading