pm2-discord-webhook

PM2 Discord Notifier

Usage no npm install needed!

<script type="module">
  import pm2DiscordWebhook from 'https://cdn.skypack.dev/pm2-discord-webhook';
</script>

README

pm2-discord-webhook

This is a PM2 Module for sending events & logs from your PM2 processes to Discord.

Install

To install and setup pm2-discord-webhook, run the following commands:

pm2 install pm2-discord-webhook
pm2 set pm2-discord-webhook:webhook_url_logs https://discord_url
pm2 set pm2-discord-webhook:webhook_url_errors https://discord_url

discord_url

2 variants available - logs and errors are separated to enable different levels of reporting - both required (you can set them equal to each other) To get the Discord URL, you need to setup a Webhook. More details on how to set this up can be found here: https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks

Configure

The following events can be subscribed to:

  • log - All standard out logs from your processes. Default: true
  • error - All error logs from your processes. Default: false
  • kill - Event fired when PM2 is killed. Default: true
  • exception - Any exceptions from your processes. Default: true
  • restart - Event fired when a process is restarted. Default: false
  • delete - Event fired when a process is removed from PM2. Default: false
  • stop - Event fired when a process is stopped. Default: true
  • restart overlimit - Event fired when a process is reaches the max amount of times it can restart. Default: true
  • exit - Event fired when a process is exited. Default: false
  • start - Event fired when a process is started. Default: false
  • online - Event fired when a process is online. Default: false

You can simply turn these on and off by setting them to true or false using the PM2 set command.

pm2 set pm2-discord-webhook:log true
pm2 set pm2-discord-webhook:error false
...

Options

The following options are available:

  • process_name (string) When this is set, it will only output the logs of a specific named process Default: NULL
  • buffer (bool) - Enable/Disable buffering of messages by timestamp. Messages that occur with the same timestamp (seconds) will be concatenated together and posted as a single discord message. Default: true
  • buffer_seconds (int) - Duration in seconds to aggregate messages. Has no effect if buffer is set to false. Min: 1, Max: 5, Default: 1
  • queue_max (int) - Number of messages to keep queued before the queue will be truncated. When the queue exceeds this maximum, a rate limit message will be posted to discord. Min: 10, Max: 100, Default: 100

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-webhook:process_name myprocess
pm2 set pm2-discord-webhook:buffer true
pm2 set pm2-discord-webhook:buffer_seconds 2
pm2 set pm2-discord-webhook:queue_max 50

Contributing

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.

Acknowledgements

Forked from FranciscoG/pm2-discord and added a separate webhook for logs and errors