Commit 619cfa49 authored by walkhan's avatar walkhan

add warning document

parent 5f852dde
......@@ -21,8 +21,8 @@
- 注册中心
- 集群实例
- 集群配置
- [数据源管理](/zh-CN/administrator-guide/register_center/datasource_management.md)
- [告警管理](/zh-CN/administrator-guide/register_center/warning.md)
- [数据源管理](/zh-CN/administrator-guide/registerCenter/datasource_manage.md)
- [告警管理](/zh-CN/administrator-guide/registerCenter/warning.md)
- jar管理
- 文档管理
- 元数据管理
......
# 告警管理
如何创建报警实例及报警组,在0.6版本以后,用户可以创建报警实例及报警组,监控FlinkSQL作业。一个报警组可以使用多个报警实例,用户就可以进一步收到报警通知。收到的报警通知如下:
- unknow
- stop
- cancel
- finished
首先要进入<span style="">注册中心</span>,选择<span>报警管理</span>,然后选择左侧的报警实例管理,创建一个告警实例。然后选择对应的报警插件(当前支持钉钉及企业微信)。然后选择报警组管理,创建一个报警组。
## 报警实例管理
新建一个报警实例,选择新建
![image-20220313231030171](http://www.aiwenmo.com/dinky/dev/docs/image-20220313231030171.png)
![image-20220313231641014](http://www.aiwenmo.com/dinky/dev/docs/image-20220313231641014.png)
点击<span>钉钉或者企业微信</span>,创建报警实例配置。报警实例配置完成,就可以创建报警组。
## 报警组管理
新建一个报警组,选择新建
![image-20220313232311137](http://www.aiwenmo.com/dinky/dev/docs/image-20220313232311137.png)
![image-20220313232557068](http://www.aiwenmo.com/dinky/dev/docs/image-20220313232557068.png)
## 钉钉
如果用户使用钉钉进行报警,请在报警实例中选择报警实例管理,选择新建<span>钉钉</span>报警实例。钉钉的配置如下:
![image-20220313233200594](http://www.aiwenmo.com/dinky/dev/docs/image-20220313233200594.png)
**参数配置:**
- **名称:** 自定义;
- **地址:** Webhook,格式如下:https://oapi.dingtalk.com/robot/send?access_token=???????
- **关键字:** 安全设置的自定义关键词,如{"touser":"{toUser}","agentid":{agentId}","msgtype":"{showType}","{showType}":{"content":"{msg}"}};
- **密令:** 安全设置的加签;
- **开启代理:** 默认否(一般默认)
- **@所有人:** 默认禁用,需要开启;
- **是否启用:** 默认禁用,需要开启;
- **展示方式类型:** 支持MarkDown和文本;
**说明:** 自定义机器人发送消息时,在“被@人列表”里面的人员收到该消息时,会有@消息提醒。
[自定义机器人接入开发文档](https://open.dingtalk.com/document/robots/custom-robot-access)
## 企业微信
如果用户使用企业微信进行报警,请在报警实例中选择报警实例管理,选择新建<span>企业微信</span>报警实例。企业微信的配置如下:
![image-20220313235619613](http://www.aiwenmo.com/dinky/dev/docs/image-20220313235619613.png)
**参数配置:**
- **名称:** 自定义;
- **企业id:** 询问企业微信管理员即可;
- **密令:** 安全设置的加签;
- **用户:** 企业微信联系人中可添加;
- **发送消息:** 接口中定义的msg,如{"touser":"{toUser}","agentid":{agentId}","msgtype":"{showType}","{showType}":{"content":"{msg}"}}
- **代理ID:**询问企业微信管理员即可;
- **发送方式:** 支持应用和群聊;
- **展示方式类型:** 支持MarkDown和文本;
- **是否启用:** 默认禁用,需要开启;
其中发送方式分别对应企微文档:
[应用](https://work.weixin.qq.com/api/doc/90000/90135/90236) [群聊](https://work.weixin.qq.com/api/doc/90000/90135/90248)
发送消息对应文档中的 content,与此相对应的值的变量为 {msg}
......@@ -115,11 +115,11 @@ Dinky开发环境配置有两种模式,分别是product环境和compile环境
- 如果要基于二进制包进行开发,需要切换到对应的分支代码,如0.5.1;
- 如果想要开发新代码,切换到dev分支即可;
下面说明在启动前如何修改相应的代码,为本地启动做准备。
下面说明在启动前如何修改相应的代码,为本地启动做准备。修改
### dlink-core模块修改
### 修改pom文件
需要修改 dlink-core模块下的pom文件,下面以本地开发为例,修改如下:
需要修改 dlink根目录下的pom文件,下面以本地开发为例,修改如下:
```
<properties>
......@@ -132,21 +132,6 @@ Dinky开发环境配置有两种模式,分别是product环境和compile环境
</properties>
```
### dlink-admin模块修改
- 可在该 pom 下按功能添加其他 Dlink 子组件依赖以及 Flink 和 Hadoop 的第三方依赖。
- 如使用 MySQL数据源及元数据功能,则添加以下内容:
```xml
<dependency>
<groupId>com.dlink</groupId>
<artifactId>dlink-metadata-mysql</artifactId>
</dependency>
```
如使用 Flink Hive 等其他连接器功能,则需要添加相关依赖
#### 修改配置文件
修改dlink根目录下/dlink-admin/src/main/resources/application.ym文件
......
......@@ -38,9 +38,9 @@ mvn clean package -Dmaven.test.skip=true
## 远程调试环境搭建
### dlink-core模块修改
### 修改pom文件
需要修改 dlink-core模块下的pom文件,将 provied 改为 complie,修改如下:
需要修改 dlink根目录下的pom文件,将 provied 改为 complie,修改如下:
```
<properties>
......@@ -53,66 +53,6 @@ mvn clean package -Dmaven.test.skip=true
</properties>
```
### dlink-admin模块修改
需要修改 dlink-admin模块下的pom文件
- 可在该 pom 下按功能添加其他 Dlink 子组件依赖以及 Flink 和 Hadoop 的第三方依赖。
- 如使用 MySQL数据源及元数据功能,则添加以下内容:
```xml
<dependency>
<groupId>com.dlink</groupId>
<artifactId>dlink-gateway</artifactId>
</dependency>
<dependency>
<groupId>com.dlink</groupId>
<artifactId>dlink-metadata-mysql</artifactId>
</dependency>
<dependency>
<groupId>com.dlink</groupId>
<artifactId>dlink-metadata-doris</artifactId>
</dependency>
<dependency>
<groupId>com.dlink</groupId>
<artifactId>dlink-metadata-phoenix</artifactId>
</dependency>
<dependency>
<groupId>org.apache.phoenix</groupId>
<artifactId>phoenix-core</artifactId>
<version>4.14.2-HBase-1.4</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-yarn_2.11</artifactId>
<version>1.13.6</version>
</dependency>
<dependency>
<groupId>org.apache.flink</groupId>
<artifactId>flink-shaded-hadoop-3-uber</artifactId>
<version>3.1.1.7.2.1.0-327-9.0</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
```
**说明:**如使用 Flink Hive 等其他连接器功能,则需要添加相关依赖,以上phoenix,doris,mysql依赖可选,根据情况选择Dinky已经支持的数据源依赖即可。
另外远程调试需要添加[flink-shaded-hadoop-3-uber](https://repository.cloudera.com/artifactory/cloudera-repos/org/apache/flink/flink-shaded-hadoop-3-uber/3.1.1.7.2.9.0-173-9.0/flink-shaded-hadoop-3-uber-3.1.1.7.2.9.0-173-9.0.jar)依赖,如果下载不下来,可以在pom下添加如下依赖:
```
<repositories>
<repository>
<id>cloudera</id>
<url>https://repository.cloudera.com/artifactory/cloudera-repos/</url>
</repository>
</repositories>
```
### 修改配置文件
修改dlink根目录下/dlink-admin/src/main/resources/application.ym文件
......
......@@ -5,7 +5,7 @@
- SQLServer
- PostGreSQL
- Phoenix
- Doris
- Doris(Starrocks)
- ClickHouse
使用以上数据源,请查阅注册中心[数据源管理](/zh-CN/administrator-guide/register_center/warning.md),配置数据源连接
\ No newline at end of file
使用以上数据源,请查阅注册中心[数据源管理](/zh-CN/administrator-guide/registerCenter/datasource_manage.md),配置数据源连接
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment