Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keymetrics/pm2-logrotate
Automatically rotate all applications logs managed by PM2
https://github.com/keymetrics/pm2-logrotate
cron easy keymetrics logrotate logrotation logs monitor pm2 rotated
Last synced: 2 days ago
JSON representation
Automatically rotate all applications logs managed by PM2
- Host: GitHub
- URL: https://github.com/keymetrics/pm2-logrotate
- Owner: keymetrics
- Created: 2015-04-22T03:48:25.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T09:16:31.000Z (8 months ago)
- Last Synced: 2024-12-15T03:01:58.847Z (9 days ago)
- Topics: cron, easy, keymetrics, logrotate, logrotation, logs, monitor, pm2, rotated
- Language: JavaScript
- Homepage:
- Size: 102 KB
- Stars: 1,255
- Watchers: 23
- Forks: 137
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## Description
PM2 module to automatically rotate logs of processes managed by PM2.
## Install
pm2 install pm2-logrotate
**NOTE:** the command is `pm2 install` NOT `npm install`
## Configure
- `max_size` (Defaults to `10M`): When a file size becomes higher than this value it will rotate it (its possible that the worker check the file after it actually pass the limit) . You can specify the unit at then end: `10G`, `10M`, `10K`
- `retain` (Defaults to `30` file logs): This number is the number of rotated logs that are keep at any one time, it means that if you have retain = 7 you will have at most 7 rotated logs and your current one.
- `compress` (Defaults to `false`): Enable compression via gzip for all rotated logs
- `dateFormat` (Defaults to `YYYY-MM-DD_HH-mm-ss`) : Format of the data used the name the file of log
- `rotateModule` (Defaults to `true`) : Rotate the log of pm2's module like other apps
- `workerInterval` (Defaults to `30` in secs) : You can control at which interval the worker is checking the log's size (minimum is `1`)
- `rotateInterval` (Defaults to `0 0 * * *` everyday at midnight): This cron is used to a force rotate when executed.
We are using [node-schedule](https://github.com/node-schedule/node-schedule) to schedule cron, so all valid cron for [node-schedule](https://github.com/node-schedule/node-schedule) is valid cron for this option. Cron style :
- `TZ` (Defaults to system time): This is the standard [tz database timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used to offset the log file saved. For instance, a value of `Etc/GMT+1`, with an hourly log, will save a file at hour `14` GMT with hour `13` (GMT+1) in the log name.
```
* * * * * *
┬ ┬ ┬ ┬ ┬ ┬
│ │ │ │ │ |
│ │ │ │ │ └ day of week (0 - 7) (0 or 7 is Sun)
│ │ │ │ └───── month (1 - 12)
│ │ │ └────────── day of month (1 - 31)
│ │ └─────────────── hour (0 - 23)
│ └──────────────────── minute (0 - 59)
└───────────────────────── second (0 - 59, OPTIONAL)
```
### How to view current configuration of the above values ?
After having installed the module, you have to type :
`pm2 conf`
### How to set these values ?
After having installed the module you have to type :
`pm2 set pm2-logrotate: `
e.g:
- `pm2 set pm2-logrotate:max_size 1K` (1KB)
- `pm2 set pm2-logrotate:compress true` (compress logs when rotated)
- `pm2 set pm2-logrotate:rotateInterval '*/1 * * * *'` (force rotate every minute)