PM2 + pm2-logrotate 实现日志自动切割-JavaScript中文网-JavaScript教程资源分享门户

前言

在前端开发中，日志记录是非常重要的一环。日志可以帮助我们追踪问题、分析用户行为、优化性能等。然而，如果我们的应用长时间运行，日志文件会不断增大，不仅占用磁盘空间，而且查找日志也变得困难。因此，我们需要一种方法来自动切割日志文件，以便更好地管理和维护日志。

在本文中，我们将介绍如何使用 PM2 和 pm2-logrotate 来实现日志自动切割。PM2 是一个流行的 Node.js 进程管理工具，可以帮助我们监控、管理和部署 Node.js 应用程序。pm2-logrotate 是 PM2 的一个插件，可以帮助我们自动切割日志文件，以避免日志文件过大的问题。

安装和配置

首先，我们需要使用 npm 安装 PM2 和 pm2-logrotate：

npm install -g pm2 pm2-logrotate

接下来，我们需要在 PM2 中配置 pm2-logrotate。可以通过以下命令来创建一个配置文件：

pm2 install pm2-logrotate

这将在当前目录下创建一个名为 pm2-logrotate-config.js 的文件。我们可以在其中配置日志文件的路径、文件名、大小限制等。例如：

// javascriptcn.com 代码示例
module.exports = {
  rotateInterval: '0 0 * * *',
  rotateModule: true,
  rotateCompression: true,
  rotateMaxSize: '10M',
  rotateWorkerInterval: '30s',
  rotateWorkerSize: '10M',
  rotateWorkerKeep: 10,
  rotateWorkerConcurrency: 1,
  rotateWorkerMode: 'fork',
  rotateWorkerRemote: false,
  rotateWorkerSudo: false,
  rotateWorkerUser: null,
  rotateWorkerGroup: null,
  rotateWorkerCommand: null,
  rotateWorkerArgs: null,
  rotateWorkerEnv: null,
  rotateWorkerCwd: null,
  rotateWorkerExecMode: null,
  rotateWorkerExecInterpretor: null,
  rotateWorkerExecArgs: null,
  rotateWorkerExecEnv: null,
  rotateWorkerRestartOnError: true,
  rotateWorkerRestartOnSuccess: false,
  rotateWorkerStdout: null,
  rotateWorkerStderr: null,
  rotateWorkerStdoutMaxSize: '10M',
  rotateWorkerStderrMaxSize: '10M',
  rotateWorkerStdoutLines: 1000,
  rotateWorkerStderrLines: 1000,
  rotateWorkerStdoutToStderr: false,
  rotateWorkerStderrToStdout: false,
  rotateWorkerOutput: null,
  rotateWorkerError: null,
  rotateWorkerLogrotate: null,
  rotateWorkerDisableLogrotate: false,
  rotateWorkerDateformat: 'YYYY-MM-DD_HH-mm-ss',
  rotateWorkerSuffix: '.log',
  rotateWorkerExtension: null,
  rotateWorkerAddSuffix: false,
  rotateWorkerRename: null,
  rotateWorkerCopytruncate: false,
  rotateWorkerDelaycompress: false,
  rotateWorkerDateext: false,
  rotateWorkerMissingok: false,
  rotateWorkerNotifempty: false,
  rotateWorkerSharedscripts: false,
  rotateWorkerPostrotate: null,
  rotateWorkerPrerotate: null
};

这里我们只关注一些重要属性：

rotateInterval：日志切割的时间间隔，使用 crontab 形式指定，例如每天凌晨 0 点切割一次日志：'0 0 * * *'。
rotateMaxSize：单个日志文件的最大大小，可以使用 K、M、G 后缀来指定单位，例如 10MB：'10M'。
rotateWorkerKeep：保留的日志文件数量，旧的日志文件将被删除。
rotateWorkerSuffix：日志文件名后缀，例如 .log。
rotateWorkerOutput：标准输出日志文件路径。
rotateWorkerError：错误输出日志文件路径。

配置完成后，我们需要重启 PM2 进程，以便应用配置的变更生效：

pm2 restart all

示例代码

下面是一个简单的 Node.js 应用程序，用于记录日志：

// javascriptcn.com 代码示例
const fs = require('fs');
const path = require('path');

const logFile = path.join(__dirname, 'app.log');
const errorFile = path.join(__dirname, 'app-error.log');

function log(message) {
  const timestamp = new Date().toISOString();
  const logMessage = `[${timestamp}] ${message}\n`;
  fs.appendFileSync(logFile, logMessage);
}

function error(message) {
  const timestamp = new Date().toISOString();
  const errorMessage = `[${timestamp}] ${message}\n`;
  fs.appendFileSync(errorFile, errorMessage);
}

setInterval(() => {
  const random = Math.random();
  if (random < 0.5) {
    log(`Random number is ${random}`);
  } else {
    error(`Random number is ${random}`);
  }
}, 1000);

这个应用程序会每秒钟记录一个随机数，并将其写入日志文件。如果随机数小于 0.5，则记录到标准输出日志文件 app.log 中，否则记录到错误输出日志文件 app-error.log 中。

我们可以使用 PM2 启动这个应用程序，并配置 pm2-logrotate 来自动切割日志文件：

pm2 start app.js --name my-app
pm2 install pm2-logrotate
pm2 set pm2-logrotate:my-app /path/to/pm2-logrotate-config.js
pm2 save

这里我们将应用程序命名为 my-app，并将 pm2-logrotate 配置文件指定为 /path/to/pm2-logrotate-config.js。

总结

使用 PM2 和 pm2-logrotate 可以方便地实现日志自动切割，避免日志文件过大的问题。在配置 pm2-logrotate 时，需要注意一些重要属性，如日志切割时间间隔、单个日志文件大小、保留的日志文件数量等。在实际应用中，我们可以根据需求进行调整。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/6582743ad2f5e1655dd9179e