pm2-alert

Get notified the changes and events of your processes in Slack

How it works

Depends on the cron configuration that defined in pm2-alert.js, it will check the memory of your processes which managed by pm2 and if its memory reach the maximum size then it will send notification via Slack

Notification Example:

How to use

1. simply install pm2-alert via npm install pm2-alert --save
2. Copy pm2-alert.js from node_modules/pm2-alert into the root directory of your application
3. Edit pm2-alert.js and replace to with your Slack Incomming Webhook URL
4. Start your application via pm2 then Start pm2-alert.js with pm2 by running pm2 start pm2-alert.js

Configuration

pm2-alert.js:

let config = {

    /**
     * list of processes that you want to be alerted on memory leak
     * if you want to monitor all of your processes just leave this property empty array
     * (Example) processes: ['app', 'http'] 
     */
    processes: [],

    /**
     * Slack Incomming Webhook URL.
     * To get the Slack URL, you need to setup an Incoming Webhook. 
     * More details on how to set this up can be found here: https://api.slack.com/incoming-webhooks
     */
    to: 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX',

    /**
     * set target
     */
    target: 'slack', // custom or slack


    // TODO: listen to these Events then send notification
    // Events: ['start', 'restart'], // pm2 events

    info: {
        serverName: '192.168.1.1 US'
    },

    /**
     * fill this Object with right value to get the right notification
     */
    memory: {

        /**
         * Define when this module is try to check your process memory
         * You can learn more about cron here: https://en.wikipedia.org/wiki/Cron 
         * By default: every five minute
         */
        cron: '*/5 * * * *', // cronTab => every minute,

        /**
         * Get notified when your memory reached maxMemroySize
         * By default: 800MB
         */
        maxMemroySize: 800 * 1000000, // when process reach 800MB get alerted

        /**
         * Slack messages format
         * learn more about this here: https://api.slack.com/docs/message-formatting
         */
        warning: [
            {
                "color": "warning",
                "pretext": "we noticed that your process not working well",
                "footer": "Raychat Process Managing Service",
                "footer_icon": "https://app.raychat.io/images/favicon.png",
            }
        ]
    }
}

const pm2_slack = require('pm2-alert')
new pm2_slack(config)