Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alonelucky/pm2-notify-x
当前项目是一个pm2的进程通知插件模块
https://github.com/alonelucky/pm2-notify-x
bark bot dingtalk feishu notify pm2 process slack telegram wxwork
Last synced: about 2 months ago
JSON representation
当前项目是一个pm2的进程通知插件模块
- Host: GitHub
- URL: https://github.com/alonelucky/pm2-notify-x
- Owner: alonelucky
- Created: 2019-10-24T01:17:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T01:15:23.000Z (8 months ago)
- Last Synced: 2024-11-03T04:49:47.388Z (3 months ago)
- Topics: bark, bot, dingtalk, feishu, notify, pm2, process, slack, telegram, wxwork
- Language: JavaScript
- Homepage:
- Size: 2.01 MB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# pm2-notify-x
> 当前项目是一个pm2的进程通知插件模块
> 借助已有途径对 pm2 进程错误信息实时提醒
### 1. 安装使用
```bash
pm2 install pm2-notify-x
```
### 2. 完整配置
```json
{
"delay": 15, // pm2 set pm2-notify-x:delay 15
"debug": false, // pm2 set pm2-notify-x:debug false
"smtp": "", // 利用url解析smtp配置,协议s为开启 tls; pm2 set pm2-notify-x:smtp smtp://username:[email protected]:25
"wxwork": [], // 支持多个设置 `,` 分割 pm2 set pm2-notify-x:wxwork uuidkey
"email": [], // 支持多个设置 `,` 分割 pm2 set pm2-notify-x:email email
"bark": [],
"slack": [],
"dingtalk": [],
"feishu": [],
"telegram": [],
"process_wxwork": [], // pm2 set pm2-notify-x:process_wxwork
"process_feishu": [], // pm2 set pm2-notify-x:process_feishu
"process_email": [], // pm2 set pm2-notify-x:process_email
...
}
```
### 3. 项目规划
- [x] 企业微信 `wxwork` [文档](https://developer.work.weixin.qq.com/document/path/91770)
- [x] Bark通知 `bark` [文档](https://bark.day.app/#/tutorial?id=url%e6%a0%bc%e5%bc%8f)
- [x] Slack通知 `slack` [文档](https://api.slack.com/reference/surfaces/formatting#attachments)
- [x] Telegram通知 `telegram` [文档](https://core.telegram.org/bots/api#formatting-options)
- [x] 钉钉通知 `dingtalk` [文档](https://open.dingtalk.com/document/orgapp/custom-bot-send-message-type#)
- [x] 飞书通知 `feishu` [文档](https://open.feishu.cn/document/common-capabilities/message-card/message-cards-content/card-structure/card-content)
- [x] SMTP 邮件通知 `email` [文档](https://nodemailer.com/)
- [x] 按进程区分通知
- [x] 增加消息规则匹配
### 4. 使用示例
```
$> pm2 l
┌────┬────────────────────┬──────────┬──────┬───────────┬──────────┬──────────┐
│ id │ name │ mode │ ↺ │ status │ cpu │ memory │
├────┼────────────────────┼──────────┼──────┼───────────┼──────────┼──────────┤
│ 4 │ test │ fork │ 378 │ online │ 0% │ 0b │
│ 9 │ test │ fork │ 64 │ online │ 0% │ 0b │
│ 6 │ test111 │ fork │ 15 │ online │ 0% │ 0b │
└────┴────────────────────┴──────────┴──────┴───────────┴──────────┴──────────┘
```
- 全局配置
```bash
# 合并通知间隔: 单位秒, 默认 15s
$> pm2 set pm2-notify-x:delay 15
# 设置调试日志输出
$> pm2 set pm2-notify-x:debug true
# 设置日志匹配规则
# 增加 jsonpath 查找，查找规则 https://radash-docs.vercel.app/docs/object/get，查不到依然通知，只不过通知的是消息整体
pm2 set pm2-notify-x:find $.msg
# 增加正则查找，正则支持 正则表达式及字符串, 正则表达式匹配不到的消息不进行通知
pm2 set pm2-notify-x:find /"msg":/ig # will eval('/"msg":/ig')
pm2 set pm2-notify-x:find "msg": # will new Regexp('"msg":')
```
- 设置企微通知
```bash
$> pm2 set pm2-notify-x:wxwrok uuidkey
# 为 test 程序设置企微通知
$> pm2 set pm2-notify-x:test_wxwrok uuidkey
```
- 设置Slack通知
```bash
# 为 test111 程序设置企微通知
$> pm2 set pm2-notify-x:test111_slack slackurl
```
- 设置 telegram 通知
```bash
# 为 test111 程序设置指定解析匹配通知
$> pm2 set pm2-notify-x:test111_telegram tgboturl
$> pm2 set pm2-notify-x:test111_find $.msg
```