Skip to content

Latest commit

 

History

History
120 lines (86 loc) · 2.95 KB

readme.md

File metadata and controls

120 lines (86 loc) · 2.95 KB
Raw

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!

demo

A Chinese write-up about this plugin is published on wechaty.js.org.

Quick guide to implementing your Wechaty log operation:

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

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.

import {qrResuce, WechatyLogMonitor} from "wechaty-log-monitor"

const qrResuceForB = qrResuce(({
  logFile: "../botBob.log",
  adminWeixin: "BobWeixin"
},{loginTest:"您好世界"}))

bot.use(
  WechatyLogMonitor({
    enableSelfToBeQrRescued: true,
    logOperations:[qrResuceForB]
  }),
)

demo

二、logAlert (aka 发log给你)

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重启)

import {restartPM2, WechatyLogMonitor} from "wechaty-log-monitor"

const restartBobPM2 = restartPM2({
  adminWeixin: "BobWeixin"
},{pm2Id:"archy"})
bot.use(
  WechatyLogMonitor({
    logOperations:[restartBobPM2]
  }),
)

demo

Please feel free to fork me & implement more features! Pull requests are welcomed too!

To-do

  1. write integration test cases using wechaty-mock

  2. add authentication support (via SMS, authy, googleAuth)

  3. integrate GPT-3 Natural language Shell

demo