Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/archywillhe/wechaty-log-monitor
a Wechaty plugin for log-related DevOps. Fully functional! Very Loose coupling! Pretty much pure (other than side effects in I.O.)!
https://github.com/archywillhe/wechaty-log-monitor
chatbot devops-tools log-monitoring wechaty
Last synced: 3 months ago
JSON representation
a Wechaty plugin for log-related DevOps. Fully functional! Very Loose coupling! Pretty much pure (other than side effects in I.O.)!
- Host: GitHub
- URL: https://github.com/archywillhe/wechaty-log-monitor
- Owner: archywillhe
- Created: 2020-08-04T09:19:19.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T20:48:55.000Z (about 2 years ago)
- Last Synced: 2024-08-09T06:10:37.903Z (6 months ago)
- Topics: chatbot, devops-tools, log-monitoring, wechaty
- Language: TypeScript
- Homepage:
- Size: 3.64 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
> Huge thanks to Wechaty + Juzi for the free pad-plus and donut tokens.
## Wechaty Log Monitor
This is a Wechaty plugin for log-related DevOps. Fully functional! Very Loose coupling! Pretty much pure (other than side effects in I.O.)! It allows you to receive log alerts, view log files, execute cmd, and perform DevOps such as _QR Rescue_ for your WeChaty on Wechat itself!
[A Chinese write-up about this plugin is published on wechaty.js.org](https://wechaty.js.org/2020/08/09/wechaty-log-monitor/).
## Quick guide to implementing your Wechaty log operation:
```typescript
import { Wechaty, FileBox } from 'wechaty'
import {execAndPipeToBot, botSendToBot, WechatyLogOperationConfig, WechatyLogOperation } from "wechaty-log-monitor"
export const somethingNew = (
config: WechatyLogOperationConfig, parameter:{someNumber:number,someString:string}
):WechatyLogOperation => {
return{
config,
onLogFileIsChanged : async (bot:Wechaty, newLogs:string)=> {
//your side effect
},
onCmdReceived : async (
bot:Wechaty, cmd:string, config: WechatyLogOperationConfig
) => {
//your side effect
}
}
}
bot.use(
WechatyLogMonitor({
enableSelfToBeQrRescued: true,
logOperations:[somethingNew] //can include as many log operations as you want
}),
)
```
For examples see `src/qrRescue.ts` and `src/miscellaneous.ts`!
## Quickstart
```bash
yarn add wechaty-log-monitor@latest
```
### 1. qrResuce (aka 掉线给码)
Requirements:
- At least two Wechaties. Must be deployed on the same production server.
- Two phones. Or a way to project the QR code onto a screen so you can scan it in your Wechat via the native camera.
```typescript
import {qrResuce, WechatyLogMonitor} from "wechaty-log-monitor"
const qrResuceForB = qrResuce(({
logFile: "../botBob.log",
adminWeixin: "BobWeixin"
},{loginTest:"您好世界"}))
bot.use(
WechatyLogMonitor({
enableSelfToBeQrRescued: true,
logOperations:[qrResuceForB]
}),
)
```
### 二、logAlert (aka 发log给你)
```typescript
import {logAlert, WechatyLogMonitor} from "wechaty-log-monitor"
const errorAlert = logAlert({
logFile: "../botBob-errors.log",
adminWeixin: "BobWeixin"
},{limitPerMinute:3,customName:"bob"})
bot.use(
WechatyLogMonitor({
logOperations:[errorAlert]
}),
)
```
### 三、restartPM2 (aka PM2重启)
```typescript
import {restartPM2, WechatyLogMonitor} from "wechaty-log-monitor"
const restartBobPM2 = restartPM2({
adminWeixin: "BobWeixin"
},{pm2Id:"archy"})
bot.use(
WechatyLogMonitor({
logOperations:[restartBobPM2]
}),
)
```
Please feel free to fork me & implement more features! Pull requests are welcomed too!
## To-do
0. write integration test cases using wechaty-mock
1. add authentication support (via SMS, authy, googleAuth)
2. integrate [GPT-3 Natural language Shell](https://beta.openai.com/?app=productivity&example=4_2_0)
