Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twipped/librato-pm2
A nodejs process for reporting PM2 process metrics to the Librato Metrics Service
https://github.com/twipped/librato-pm2
Last synced: about 1 month ago
JSON representation
A nodejs process for reporting PM2 process metrics to the Librato Metrics Service
- Host: GitHub
- URL: https://github.com/twipped/librato-pm2
- Owner: Twipped
- License: other
- Created: 2015-10-22T18:44:49.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-22T18:47:41.000Z (about 9 years ago)
- Last Synced: 2024-10-10T20:19:17.066Z (3 months ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
librato-pm2
===
librato-pm2 is a tiny node application to feed process metrics from [PM2](https://www.npmjs.com/package/pm2) into [librato.com](https://www.librato.com).
##Installation
Install the executable with npm:
```
npm install -g librato-pm2
```
Create a `.librato-pm2rc` file in your home directory (or the directory of the user that PM2 processes run as) containing the following JSON:
```json
{
"email": "YOUR LIBRATO EMAIL ADDRESS",
"token": "YOUR LIBRATO API ACCESS TOKEN"
}
```
You can obtain the access token from the [Account Settings > API Access Tokens](https://metrics.librato.com/account/api_tokens) page
Finally, add librato-pm2 to your PM2 process stack.
```
pm2 start librato-pm2
```
Within a few moments you will see new metrics on your librato account for every process currently managed by PM2, named with a prefix followed by the process name in PM2 and the metric available.
The following metrics are supplied:
- `cpu`: CPU usage in percentage from 0 to 100.
- `memory`: Memory usage in bytes.
- `online`: Boolean 0 or 1 for if the process is running.
- `restarts`: Total crashes recorded by PM2.
- `uptime`: Time in seconds since the process was last started (Float).
##Options
In addition to the `email` and `token` values on the configuration file, you can provide the following options:
**`interval`**: Time, in seconds, that the metrics will be polled and submitted. Default is `10`.
**`metricPrefix`**: String used to prefix every metric name. Default is `"pm2."`
Additionally, the config file itself may be installed in any of the locations supported by the [`rc`](https://www.npmjs.com/package/rc) library.