Skip to content

Commit

Permalink
[Improve] Improve lark alarm docs (#273)
Browse files Browse the repository at this point in the history
* Add flying book alarm information

---------

Co-authored-by: qinjiyong <[email protected]>
  • Loading branch information
hackallan and qinjiyong authored Oct 11, 2023
1 parent b0c80a9 commit 403d17a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions docs/development/alert-conf.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,10 @@ Then, Enter robot `Lark Tokens` and other configurations, click `Submit`.

**Configuration description:**

1. `Lark Token`:<font color='red'>`Required`</font>.1. It is the default address of the group robot, intercept the content behind `/hook/`.
2. `At All User``optional` .2.After it is turned on, the alarm message will be @ everyone in the group.
3. `Secret Enable``optional` .3.If `encryption signature verification` is enabled, the `Secret Token` signature verification key information needs to be configured.
1. `streampark.proxy.lark-url`:We need to add the `streampark.proxy.lark-url` property to the configuration file. Example: yaml file adds streampark.proxy.lark-url: https://open.feishu.cn .
2. `Lark Token`:<font color='red'>`Required`</font>.1. It is the default address of the group robot, intercept the content behind `/hook/`.
3. `At All User``optional` .2.After it is turned on, the alarm message will be @ everyone in the group.
4. `Secret Enable``optional` .3.If `encryption signature verification` is enabled, the `Secret Token` signature verification key information needs to be configured.

:::info Lark robot application
Please refer to the [official Lark official](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bot-v3/bot-overview ) for robot application and configuration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,10 @@ import TabItem from '@theme/TabItem';

**配置项说明:**

1. `Lark Token`:<font color='red'>`必填项`</font>。为群机器人默认地址,截取 `/hook/` 后面内容。
2. `At All User`:选填项 。开启后,报警消息会@群内所有人。
3. `Secret Enable`:选填项 。如果开启机器人请求 `加密验签`,则需要配置,并且需要配置 `Lark Secret Token` 验签密钥信息。
1. `streampark.proxy.lark-url`:添加 `streampark.proxy.lark-url`属性到配置文件中,例:在yaml文件中添加 streampark.proxy.lark-url: https://open.feishu.cn
2. `Lark Token`:<font color='red'>`必填项`</font>。为群机器人默认地址,截取 `/hook/` 后面内容。
3. `At All User`:选填项 。开启后,报警消息会@群内所有人。
4. `Secret Enable`:选填项 。如果开启机器人请求 `加密验签`,则需要配置,并且需要配置 `Lark Secret Token` 验签密钥信息。

:::info 飞书群机器人申请
请参考 `飞书官方文档` https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bot-v3/bot-overview 进行机器人申请和配置
Expand Down

0 comments on commit 403d17a

Please sign in to comment.