pm2logrotate

pm2logrotate, commonly known as pm2-logrotate, is a PM2 module that provides automatic rotation of log files generated by applications managed by PM2. It helps prevent unbounded growth of stdout and stderr logs by rotating files once they reach a configured size and by limiting the number of archived logs kept on disk.

Installation and usage: The module is installed through the PM2 CLI with pm2 install pm2-logrotate. After installation, it runs within the PM2 process ecosystem and applies to all PM2-managed applications, with configuration accessible via pm2 set.

Configuration options include max_size (maximum size of a log file before rotation), retain (number of rotated files to keep), compress (whether to gzip rotated files), and dateFormat (format of timestamps in rotated filenames). These options are set per module using commands such as pm2 set pm2-logrotate:max_size 10M, pm2 set pm2-logrotate:retain 7, pm2 set pm2-logrotate:compress true.

Operation: When a log file exceeds the configured size, it is rotated and the old file is renamed and archived according to the settings. The active stdout and stderr logs continue to be written to new files, while rotated files are kept in the same log directory. This module helps simplify log management in production deployments.

Limitations and considerations: pm2-logrotate only manages PM2 logs; it does not rotate application logs created by custom paths outside PM2's log directory unless those paths are configured accordingly. It may interact with system log rotation policies in complex deployments, so verify behavior in your environment.

See also: PM2 logging features, log rotation concepts, other PM2 modules.