diff --git a/README.md b/README.md index 9e38b55..7a08bec 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # elastalert-wechatrobot-plugin 参考: @@ -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"]`(可选)