[ospp] support custom notice template #1233

Eden4701 · 2023-09-07T09:28:15Z

What's changed?

Custom Notice Template Configuration

Checklist

I have read the Contributing Guide
I have written the necessary doc or comment.
I have added the necessary unit tests and all cases have passed.

tomsun28 · 2023-09-11T07:24:57Z

👍

gcdd1993 · 2023-09-13T01:34:33Z

manager/src/main/resources/application.yml

+  #      password: 123456
+  #      url: jdbc:h2:./data/hertzbeat;MODE=MYSQL
+  #      hikari:
+  #        max-lifetime: 120000
  datasource:


这个配置修改本地测试可以的，但是不要提交远程

gcdd1993 · 2023-09-13T02:08:03Z

common/src/main/java/org/dromara/hertzbeat/common/entity/manager/NoticeTemplate.java

+            description = "模板名称",
+            example = "dispatch-1", accessMode = READ_WRITE)
+    @Length(max = 100)
+    @NotNull


针对String类型的非空校验，可以使用@NotBlank

gcdd1993 · 2023-09-13T02:09:12Z

common/src/main/java/org/dromara/hertzbeat/common/entity/manager/NoticeTemplate.java

+    @Schema(title = "Record the latest modification time (timestamp in milliseconds)",
+            description = "记录最新修改时间", accessMode = READ_ONLY)
+    @LastModifiedDate
+    private LocalDateTime gmtUpdate;


是否缺少一个字段，用于标识是否系统预设模版（系统预设模板不允许删除）？

gcdd1993 · 2023-09-13T02:16:59Z

manager/src/main/java/org/dromara/hertzbeat/manager/service/impl/NoticeConfigServiceImpl.java

@@ -189,7 +344,9 @@ public boolean sendTestMsg(NoticeReceiver noticeReceiver) {
        alert.setFirstAlarmTime(System.currentTimeMillis());
        alert.setLastAlarmTime(System.currentTimeMillis());
        alert.setPriority(CommonConstants.ALERT_PRIORITY_CODE_CRITICAL);
-        return dispatcherAlarm.sendNoticeMsg(noticeReceiver, alert);
+        Byte type=noticeReceiver.getType();
+        NoticeTemplate noticeTemplate=getNoticeTemplatesById(Long.valueOf(type));;


这边逻辑不太对，传参是type，但是查询是通过模板ID查询

gcdd1993 · 2023-09-13T02:17:36Z

manager/src/main/java/org/dromara/hertzbeat/manager/service/impl/NoticeConfigServiceImpl.java

+
+    @Override
+    public NoticeTemplate getNoticeTemplatesById(Long templateId) {
+        return noticeTemplateDao.getReferenceById(templateId);


建议使用findById，返回值用Optional

gcdd1993 · 2023-09-13T02:23:51Z

...ava/org/dromara/hertzbeat/manager/component/alerter/impl/AbstractAlertNotifyHandlerImpl.java

-        context.setVariable("monitorNameLabel", bundle.getString("alerter.notify.monitorName"));
-        context.setVariable("targetLabel", bundle.getString("alerter.notify.target"));
-        context.setVariable("target", alert.getTarget());
+        String monitorId=alert.getTags().get("monitorId");


存在空指针风险

Signed-off-by: Eden4701 <Eden4701@163.com>

tomsun28 · 2023-10-10T13:58:12Z

hi pls fix these confilcts

manager/pom.xml
web-app/src/assets/i18n/zh-CN.json

Signed-off-by: Eden4701 <Eden4701@163.com>

tomsun28 · 2023-10-11T03:31:19Z

启动修改 hzb_notice_rule 表新增 template_id 字段报错不能为null, 这里是因为之前的老数据没有此字段导致，新增 alter table hzb_notice_rule add column template_id bigint not null 会导致之前的老数据异常

2023-10-11 11:14:23 [main] WARN  org.hibernate.tool.schema.internal.ExceptionHandlerLoggedImpl - GenerationTarget encountered exception accepting command : Error executing DDL "alter table hzb_notice_rule add column template_id bigint not null" via JDBC Statement
org.hibernate.tool.schema.spi.CommandAcceptanceException: Error executing DDL "alter table hzb_notice_rule add column template_id bigint not null" via JDBC Statement

建议不设置 template_id 约束null，然后考虑老数据问题，当template_id为null时应该有个对应的默认模版

启动时报错 'classpath:sql/data.sql' 找不到资源，那是因为没有在manager模块的pom.xml里面配置资源路径，导致编译class时没有主动编译此资源到类路径下面去
Caused by: java.lang.IllegalStateException: No data scripts found at location 'classpath:sql/data.sql'
需要把 <include>sql/**</include> 添加到 manager pom.xml build.resources.resource.includes 下

tomsun28 · 2023-10-11T05:08:42Z

要不要把我们内置的默认消息模版像之前一样以文件的方式存储，用户自定义消息模版用现在的数据库方式存储。系统启动时从文件中加载内置模版到内存中，当 template_id 为null找不到时就使用我们内置的消息模版。页面配置用户不选择的情况下默认就使用内置消息模版。
这样能避免 template_id 为null老数据问题和data.sql重复初始化等问题，无需初始化数据库里面的消息模版数据。

hertzbeat · 2023-10-11T05:08:53Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

Should we store our built-in default message templates in files as before, and user-defined message templates in the current database method? When the system starts, the built-in template is loaded from the file into the memory. When template_id is null and cannot be found, our built-in message template is used. If the page configuration user does not select it, the built-in message template will be used by default.
This can avoid the problem of old data with template_id being null and repeated initialization of data.sql. There is no need to initialize the message template data in the database.

Eden4701 · 2023-10-13T10:56:15Z

@tomsun28 @Eden4701 可以换成用文件存储，这样就不用初始化数据和是否为默认模板这个字段了；但是缺点是需要额外维护一下从文件获取模板的代码，而且，如果要在页面显示默认模板的话，还需要额外编写代码（文件 + 数据库的分页感觉有点难做）

是的，如果这样做的话看能不能应用层的代码尽量不改动，主要是启动时加载内置的文件模版，还有数据层操作，因为内置模版只查询不修改，数据层分页改造的时候我们固定把内置模版排序到最前面，然后计算剩余pagesize 和pagenum查询数据库数据后合并用 new PageImpl<>(list)来返回数据

新的代码已提交，预设模板文件存储，自定义模板在数据库，设置通知规则时模板是可选项，用户不选择模板时默认使用预设模板

hertzbeat · 2023-10-13T10:56:28Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

@tomsun28 @Eden4701 You can switch to file storage, so you don’t need to initialize the data and the fields of whether it is the default template; but the disadvantage is that you need to maintain the code to get the template from the file, and if you want to display the default template on the page If so, additional code needs to be written (file + database paging seems a bit difficult to do)

Yes, if you do this, see if you can keep the application layer code as unchanged as possible. The main thing is to load the built-in file template at startup and data layer operations, because the built-in template only queries and does not modify. When we transform the data layer paging Fixed sorting the built-in templates to the front, then calculating the remaining pagesize and pagenum, querying the database data, and then merging and using new PageImpl<>(list) to return the data.

The new code has been submitted, the preset template file is stored, and the custom template is in the database. The template is optional when setting notification rules. When the user does not select a template, the preset template is used by default.

tomsun28 · 2023-10-15T01:42:41Z

...ava/org/dromara/hertzbeat/manager/component/alerter/impl/AbstractAlertNotifyHandlerImpl.java

-
-    @EventListener(SystemConfigChangeEvent.class)
-    public void onEvent(SystemConfigChangeEvent event) {
-        log.info("{} receive system config change event: {}.", this.getClass().getName(), event.getSource());
-        this.bundle = ResourceBundleUtil.getBundle("alerter");
-    }


hi 这里需要保留当用户语言变更时模版语言监听变更

tomsun28 · 2023-10-15T01:45:08Z

...n/java/org/dromara/hertzbeat/manager/component/alerter/impl/EmailAlertNotifyHandlerImpl.java

-            //获取sender
-            JavaMailSenderImpl sender = (JavaMailSenderImpl) javaMailSender;
-            String fromUsername = username;
-            try {
-                boolean useDatabase = false;
-                GeneralConfig emailConfig = generalConfigDao.findByType(TYPE);
-                if (emailConfig != null && emailConfig.getContent() != null) {
-                    // 若启用数据库配置
-                    String content = emailConfig.getContent();
-                    EmailNoticeSender emailNoticeSenderConfig = objectMapper.readValue(content, EmailNoticeSender.class);
-                    if (emailNoticeSenderConfig.isEnable()) {
-                        sender.setHost(emailNoticeSenderConfig.getEmailHost());
-                        sender.setPort(emailNoticeSenderConfig.getEmailPort());
-                        sender.setUsername(emailNoticeSenderConfig.getEmailUsername());
-                        sender.setPassword(emailNoticeSenderConfig.getEmailPassword());
-                        Properties props = sender.getJavaMailProperties();
-                        props.put("mail.smtp.ssl.enable", emailNoticeSenderConfig.isEmailSsl());
-                        fromUsername = emailNoticeSenderConfig.getEmailUsername();  
-                        useDatabase = true;
-                    }
-                } 
-                if (!useDatabase) {
-                    // 若数据库未配置则启用yml配置
-                    sender.setHost(host);
-                    sender.setPort(port);
-                    sender.setUsername(username);
-                    sender.setPassword(password);
-                    Properties props = sender.getJavaMailProperties();
-                    props.put("mail.smtp.ssl.enable", sslEnable);
-                }
-            } catch (Exception e) {
-                log.error("Type not found {}",e.getMessage());
-            }


hi 数据库获取邮件服务器配置需要保留，我们现在支持用户在页面配置邮件服务器或者在 application.yml配置邮件服务器。优先级页面数据库配置高于 application.yml 文件配置。

tomsun28 · 2023-10-15T01:45:41Z

...n/java/org/dromara/hertzbeat/manager/component/alerter/impl/EmailAlertNotifyHandlerImpl.java

-
-    @EventListener(SystemConfigChangeEvent.class)
-    public void onEvent(SystemConfigChangeEvent event) {
-        log.info("{} receive system config change event: {}.", this.getClass().getName(), event.getSource());
-        this.bundle = ResourceBundleUtil.getBundle("alerter");
-    }


hi 同上上，这里监听语言变更也需要保留

tomsun28 · 2023-10-15T01:46:59Z

manager/src/main/java/org/dromara/hertzbeat/manager/service/impl/MailServiceImpl.java

-    @EventListener(SystemConfigChangeEvent.class)
-    public void onEvent(SystemConfigChangeEvent event) {
-        log.info("{} receive system config change event: {}.", this.getClass().getName(), event.getSource());
-        this.bundle = ResourceBundleUtil.getBundle("alerter");


hi 同上，这里监听语言变更也需要保留

tomsun28

👍👍👍LGTM

tomsun28 · 2023-10-15T13:30:24Z

赞👍 完成度和质量都很高，这个PR合并了哦。
后续UI优化建议供参考：

[通知模板] 菜单放到第三位即 [告警通知策略] 后面，因为通知模版在默认情况下用户不修改也能使用，对于多数没有修改模版需求的用户它只需前面两步即可。
[告警通知策略]新增配置时建议[通知模版框]根据选中的接收人的通知类型自动渲染填充系统内置默认模版
编辑通知模版UI建议有展示当前所支持的模版环境变量，参考华为云消息通知模版

hertzbeat · 2023-10-15T13:30:37Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

Like 👍 The completion and quality are very high, this PR has been merged.
Follow-up UI optimization suggestions are for reference:

The [Notification Template] menu is placed in the third position, that is, after [Alarm Notification Policy], because the notification template can be used by users without modification by default. For most users who do not need to modify the template, it only requires the first two steps. .
[Alarm Notification Policy] When adding new configuration, it is recommended that [Notification Template Box] automatically render and fill the system's built-in default template according to the notification type of the selected recipient.
It is recommended to display the currently supported template environment variables when editing the notification template UI. Please refer to Huawei Cloud Message Notification Template.

tomsun28 · 2023-10-15T13:57:06Z

@all-contributors please add @Eden4701 for code

allcontributors · 2023-10-15T13:58:43Z

@tomsun28

I've put up a pull request to add @Eden4701! 🎉

Eden4701 · 2023-10-15T16:28:42Z

赞👍 完成度和质量都很高，这个PR合并了哦。后续UI优化建议供参考：

[通知模板] 菜单放到第三位即 [告警通知策略] 后面，因为通知模版在默认情况下用户不修改也能使用，对于多数没有修改模版需求的用户它只需前面两步即可。

[告警通知策略]新增配置时建议[通知模版框]根据选中的接收人的通知类型自动渲染填充系统内置默认模版

编辑通知模版UI建议有展示当前所支持的模版环境变量，参考华为云消息通知模版

收到！

hertzbeat · 2023-10-15T16:28:54Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

Like 👍 The completion and quality are very high, this PR has been merged. Follow-up UI optimization suggestions are for reference:

The [Notification Template] menu is placed in the third position, that is, after [Alarm Notification Policy], because the notification template can be used by users without modification by default. For most users who do not need to modify the template, it only requires the first two steps. Can.

[Alarm Notification Policy] When adding new configurations, it is recommended that the [Notification Template Box] automatically render and fill the system's built-in default template according to the notification type of the selected recipient.

It is recommended to display the currently supported template environment variables when editing the notification template UI. Please refer to Huawei Cloud Message Notification Template.

receive!

tomsun28 · 2023-10-16T15:54:34Z

@Eden4701 hi 打扰了今天使用中有个建议反馈下我们现在对默认模版每次是发告警时去打开文件，读取文件内容，关闭文件这样，在大量告警消息时会很耗性能。建议参考 org.dromara.hertzbeat.manager.service.impl.AppServiceImpl#run 在程序启动时统一读取文件加载到内存中，发告警消息时若使用内置默认模版，就到内存中取模版内容即可。

hertzbeat · 2023-10-16T15:54:49Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

@Eden4701 hi I’m sorry to bother you. I have a suggestion during use today. Please give me feedback. We now use the default template to open the file, read the file content, and close the file every time an alarm is sent. This will consume a lot of performance when there are a large number of alarm messages. It is recommended to refer to org.dromara.hertzbeat.manager.service.impl.AppServiceImpl#run to uniformly read the file and load it into the memory when the program starts. If you use the built-in default template when sending an alarm message, just get the template content from the memory.

Eden4701 · 2023-10-17T01:55:57Z

@Eden4701 hi 打扰了今天使用中有个建议反馈下我们现在对默认模版每次是发告警时去打开文件，读取文件内容，关闭文件这样，在大量告警消息时会很耗性能。建议参考 org.dromara.hertzbeat.manager.service.impl.AppServiceImpl#run 在程序启动时统一读取文件加载到内存中，发告警消息时若使用内置默认模版，就到内存中取模版内容即可。

ok

hertzbeat · 2023-10-17T01:56:07Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

@Eden4701 hi Sorry to bother you. I have a suggestion and feedback during use today. We now use the default template to open the file, read the file content, and close the file every time an alarm is sent. This will consume a lot of performance when there are a large number of alarm messages. It is recommended to refer to org.dromara.hertzbeat.manager.service.impl.AppServiceImpl#run to uniformly read the file and load it into the memory when the program starts. If you use the built-in default template when sending an alarm message, just get the template content from the memory.

OK

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

ulikehhh added 2 commits September 7, 2023 17:12

second-commit

751e786

third-commit

001fe92

tomsun28 added enhancement New feature or request good first pull request Good for newcomers new feature labels Sep 8, 2023

tomsun28 changed the title ~~Custom NoticeTemplate~~ [ospp] support custom notice template Sep 8, 2023

fourth-commit

46c1f3c

tomsun28 requested a review from gcdd1993 September 11, 2023 06:43

gcdd1993 requested changes Sep 13, 2023

View reviewed changes

ulikehhh added 5 commits September 16, 2023 00:54

fifth-commit

b493d4a

commit

e825064

commit

91664b1

commit

28256c6

commit

204e22d

gcdd1993 approved these changes Sep 25, 2023

View reviewed changes

Eden4701 added 2 commits September 25, 2023 14:55

Merge branch 'master' into hzb_NoticeTemplate

e7e0ab1

Signed-off-by: Eden4701 <Eden4701@163.com>

Merge branch 'master' into hzb_NoticeTemplate

f31df54

Signed-off-by: Eden4701 <Eden4701@163.com>

gcdd1993 approved these changes Sep 26, 2023

View reviewed changes

tomsun28 added this to the v1.4.2 milestone Sep 26, 2023

ulikehhh and others added 2 commits September 26, 2023 23:41

commit

3d811dc

Merge branch 'master' into hzb_NoticeTemplate

19dc0c9

gcdd1993 approved these changes Sep 28, 2023

View reviewed changes

tomsun28 linked an issue Oct 10, 2023 that may be closed by this pull request

[Task] <Development of custom template configuration for message notification> #1145

Closed

Merge branch 'master' into hzb_NoticeTemplate

a1d9a77

Signed-off-by: Eden4701 <Eden4701@163.com>

Merge remote-tracking branch 'upstream/master' into hzb_NoticeTemplate

9a90da4

tomsun28 reviewed Oct 15, 2023

View reviewed changes

tomsun28 approved these changes Oct 15, 2023

View reviewed changes

commit

f392bfd

tomsun28 merged commit 2883967 into apache:master Oct 15, 2023
2 checks passed

allcontributors bot mentioned this pull request Oct 15, 2023

add Eden4701 as a contributor for code #1287

Merged

tomsun28 pushed a commit that referenced this pull request Jan 16, 2024

[ospp] support custom notice template (#1233)

8936d38

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 9, 2024

[ospp] support custom notice template (#1233)

f67530c

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 9, 2024

[ospp] support custom notice template (#1233)

2e05823

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 10, 2024

[ospp] support custom notice template (#1233)

065de10

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 10, 2024

[ospp] support custom notice template (#1233)

9ca18ce

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 11, 2024

[ospp] support custom notice template (#1233)

17296c1

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 11, 2024

[ospp] support custom notice template (#1233)

f17043e

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 11, 2024

[ospp] support custom notice template (#1233)

3981b29

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

tomsun28 pushed a commit that referenced this pull request Mar 11, 2024

[ospp] support custom notice template (#1233)

2fb5c5c

Signed-off-by: Eden4701 <Eden4701@163.com> Co-authored-by: ulikehhh <2762242004@qq.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ospp] support custom notice template #1233

[ospp] support custom notice template #1233

Eden4701 commented Sep 7, 2023 •

edited

Loading

tomsun28 commented Sep 11, 2023

gcdd1993 Sep 13, 2023

gcdd1993 Sep 13, 2023

gcdd1993 Sep 13, 2023

gcdd1993 Sep 13, 2023

gcdd1993 Sep 13, 2023

gcdd1993 Sep 13, 2023

tomsun28 commented Oct 10, 2023

tomsun28 commented Oct 11, 2023

tomsun28 commented Oct 11, 2023

hertzbeat commented Oct 11, 2023

Eden4701 commented Oct 13, 2023

hertzbeat commented Oct 13, 2023

tomsun28 Oct 15, 2023

tomsun28 Oct 15, 2023

tomsun28 Oct 15, 2023

tomsun28 Oct 15, 2023

tomsun28 left a comment

tomsun28 commented Oct 15, 2023

hertzbeat commented Oct 15, 2023

tomsun28 commented Oct 15, 2023

allcontributors bot commented Oct 15, 2023

Eden4701 commented Oct 15, 2023

hertzbeat commented Oct 15, 2023

tomsun28 commented Oct 16, 2023

hertzbeat commented Oct 16, 2023

Eden4701 commented Oct 17, 2023

hertzbeat commented Oct 17, 2023

[ospp] support custom notice template #1233

[ospp] support custom notice template #1233

Conversation

Eden4701 commented Sep 7, 2023 • edited Loading

What's changed?

Checklist

tomsun28 commented Sep 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomsun28 commented Oct 10, 2023

tomsun28 commented Oct 11, 2023

tomsun28 commented Oct 11, 2023

hertzbeat commented Oct 11, 2023

Eden4701 commented Oct 13, 2023

hertzbeat commented Oct 13, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomsun28 left a comment

Choose a reason for hiding this comment

tomsun28 commented Oct 15, 2023

hertzbeat commented Oct 15, 2023

tomsun28 commented Oct 15, 2023

allcontributors bot commented Oct 15, 2023

Eden4701 commented Oct 15, 2023

hertzbeat commented Oct 15, 2023

tomsun28 commented Oct 16, 2023

hertzbeat commented Oct 16, 2023

Eden4701 commented Oct 17, 2023

hertzbeat commented Oct 17, 2023

Eden4701 commented Sep 7, 2023 •

edited

Loading