Skip to content

docs: improve README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# elastalert-wechatrobot-plugin

参考:
Expand All @@ -11,3 +13,8 @@ ElastAlert企业微信群组机器人告警通知。和钉钉机器人那个一
完全是照着elastalert-dingtalk-plugin插件修改的，因为企业微信机器人webhook里的某几个参数与钉钉机器人webhook不一样，所以需要改一下参数，代码是一样的。

使用方法请参考elastalert-dingtalk-plugin。

需在 ElastAlert 规则或 `config.yaml` 中补充以下参数：
- `wechat_robot_webhook`: 企业微信群机器人 Webhook 地址（必填）
- `wechat_robot_msgtype`: 消息类型，如 `text`（必填，默认 `text`）
- `wechat_robot_mentioned_list`: @提及列表，如 `["@all"]`（可选）