This is an improved PM2 Module for sending events & logs from your PM2 processes to Discord.
To install and setup pm2-discord-plus, run the following commands:
pm2 install JamesNZL/pm2-discord-plus
pm2 set pm2-discord-plus:discord_url https://discord_url
To get the Discord URL, you need to setup a Discord webhook.
Follow this guide if you need help.
The following events can be subscribed to:
| Event | Description | Default |
|---|---|---|
| log | All standard out logs from your processes. | true |
| error | All error logs from your processes. | false |
| kill | Event fired when PM2 is killed. | true |
| exception | Any exceptions from your processes. | true |
| restart | Event fired when a process is restarted. | false |
| delete | Event fired when a process is removed from PM2. | false |
| stop | Event fired when a process is stopped. | true |
| restart overlimit | Event fired when a process is reaches the max amount of times it can restart. | true |
| exit | Event fired when a process is exited. | false |
| start | Event fired when a process is started. | false |
| online | Event fired when a process is online. | false |
You can turn these on/off by setting them to true or false using the pm2 set command.
pm2 set pm2-discord-plus:log true
pm2 set pm2-discord-plus:error false
.
.
.
The following options are available:
| Option | Type | Description | Default | Range |
|---|---|---|---|---|
| process_name | string | Use this to setting to only output the logs of a specific process | null |
|
| buffer | boolean | Whether to buffer messages by timestamp. Messages that occur within buffer_seconds of each other will be concatenated and posted together in a single Discord message. |
true |
|
| buffer_seconds | int | Number of seconds within which to aggregate messages. Ignored if buffer is false. |
1 |
Min: 1, Max: 5 |
| queue_max | int | Maximum number of messages to keep in the queue before truncation. When the queue exceeds this maximum, a rate limit message will be posted to Discord. | 100 |
Min: 10, Max: 100 |
| embed_name | string | The name to use for the author field of Discord embeds | null |
|
| embed_footer_icon | string | An http(s) URL to an image to use as the Discord embed footer icon | null |
|
| date_format | string | The dateformat mask with which to format the message timestamp | 'default' |
Set these options in the same way you subscribe to events.
Example: The following configuration options will enable message buffering, and set the buffer duration to 2 seconds. All messages that occur within 2 seconds of each other (for the same event) will be concatenated into a single Discord message.
pm2 set pm2-discord-plus:process_name myprocess
pm2 set pm2-discord-plus:buffer true
pm2 set pm2-discord-plus:buffer_seconds 2
pm2 set pm2-discord-plus:queue_max 50
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
This is a fork of Naxey/pm2-discord-plus, which is forked in turn from FranciscoG/pm2-discord and mattpker/pm2-slack.