Package Exports
- pm2-slack
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pm2-slack) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
pm2-slack
This is a PM2 Module for sending events & logs from your PM2 processes to Slack.
Install
To install and setup pm2-slack, run the following commands:
pm2 install pm2-slack
pm2 set pm2-slack:slack_url https://slack_urlTo 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
Configure
The following events can be subscribed to:
- log - All standard out logs from your processes. Default: false
- error - All error logs from your processes. Default: true
- 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: false
- 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-slack:log true
pm2 set pm2-slack:error falseContributing
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.
Release History
- 0.0.1 Initial Release