Logs

应用程序日志

使用 PM2 启动应用程序后,您可以轻松查询和管理日志。

日志文件位于文件夹 中。$HOME/.pm2/logs

日志视图

要显示应用程序的日志,您可以使用以下命令pm2 logs

bash
-l --log [path]              # 指定文件路径以输出输出和错误日志
-o --output <path>           # 指定日志文件
-e --error <path>            # 指定错误日志文件
--time                       # 带有标准格式时间戳的前缀日志
--log-date-format <format>   # 带有自定义格式时间戳的前缀日志
--merge-logs                 # 当运行具有相同应用程序名称的多个进程时,不要按 id 拆分文件

流日志文件。默认流式传输所有日志

选项:

bash
--json                # json日志输出
--format              # 格式化日志输出
--raw                 # 原始输出
--err                 # 只显示错误输出
--out                 # 只显示标准输出
--lines <n>           # 默认输出最后 N 行,而不是最后 15 行
--timestamp [format]  # 添加时间戳(默认格式 YYYY-MM-DD-HH:mm:ss)
--nostream            # 在不启动日志流的情况下打印日志
--highlight [value]   # 突出显示给定的值
-h, --help            # 输出使用信息```

一些重要的命令:

bash
# 实时显示所有应用日志
pm2 logs

# 仅显示 `api` 应用程序日志
pm2 logs api

# 在 json 中显示新日志
pm2 logs --json

# 显示 1000 行 api 日志文件
pm2 logs big-api --lines 1000

您还可以使用 CLI 仪表板检查日志:

对于每个应用行,将打印以下元数据:

js
{
   "message": "echo\n",                     // `console.log` 的实际消息
   "timestamp": "2017-02-06T14:51:38.896Z", // 消息的时间戳,可以格式化
   "type": "out",                           // 日志类型,可以是 `err`、`out` 或 `PM2`
   "process_id": 0,                         // PM2 使用的进程 ID
   "app_name": "one-echo"                   // 应用名称
}

模块 pm2-logrotate 自动旋转并使用磁盘上的有限空间保留所有日志文件。

要安装它:

bash
$ pm2 install pm2-logrotate

在此处阅读有关 pm2-logrotate 的更多信息

刷新日志

这将清空 PM2 管理的当前应用程序日志:

bash
$ pm2 flush

$ pm2 flush <api> # 清除 Name/ID 与 <api> 匹配的应用程序的日志

应用程序日志选项

启动应用程序时,您可以指定许多选项,说明如何

命令行界面

运行 pm2 start app.js [OPTIONS] 时,您可以将以下任何选项传递给 CLI:

bash
-l --log [path]              # 指定文件路径以输出输出和错误日志
-o --output <path>           # 指定日志文件
-e --error <path>            # 指定错误日志文件
--time                       # 带有标准格式时间戳的前缀日志
--log-date-format <format>   # 带有自定义格式时间戳的前缀日志
--merge-logs                 # 当运行具有相同应用程序名称的多个进程时,不要按 id 拆分文件

自动为日志添加日期前缀

要轻松为应用程序日志添加前缀,您可以传递以下选项:--time

bash
$ pm2 start app.js --time
# Or a running app
$ pm2 restart app --time

配置文件

通过配置文件,您可以传递以下选项:

类型描述
error_file(字符串) 错误文件路径(默认为 $HOME/.pm2/logs/<App Name>-error-<pid>.log)
out_file(字符串) 输出文件路径(默认为 $HOME/.pm2/logs/<App Name>-out-<pid>.log)
log_file(字符串) 输出日志和错误日志的文件路径(默认禁用)
pid_file(字符串) pid 文件路径(默认为 $HOME/.pm2/pids/<app name>-<pid>.pid)
merge_logs布尔如果设置为 true,则避免使用进程 ID 为日志文件添加后缀
log_date_format(字符串)“年-月-日-小时:毫米Z”日志日期格式(请参阅日志部分)
log_type(字符串)“啧”指定日志输出样式,可能的值:“json”(默认情况下将记录原始)

禁用日志后缀

仅适用于集群模式 (node.js) 中的应用程序; 如果您希望集群进程的所有实例都登录到同一个文件中,您可以使用选项 --merge-logsmerge_logs: true

禁用日志记录

要禁止将所有日志写入磁盘,您可以将选项 out_fileerror_file 设置为 /dev/null

js
module.exports = {
  apps : [{
    name: 'Business News Watcher',
    script: 'app.js',
    instances: 1,
    out_file: "/dev/null",
    error_file: "/dev/null"
    cron_restart: '0 0 * * *'
    [...]
  }]
}

您可以提供/dev/nullNULL作为日志的输出(不取决于平台,它们是硬编码的字符串)。

设置本机日志旋转

bash
$ sudo pm2 logrotate -u user

这会将基本的 logrotate 配置写入 /etc/logrotate.d/pm2-user,如下所示:

/home/user/.pm2/pm2.log /home/user/.pm2/logs/*.log {
  rotate 12
  weekly
  missingok
  notifempty
  compress
  delaycompress
  create 0640 user user
}