n8n 中文文档

登录n8n

日志记录是调试的重要功能。n8n 使用 winston{:target=_blank .external-link} 日志记录库。

提示

功能可用性

本文所述的所有日志记录选项(Log streaming 日志流除外)均适用于:

  • n8n Cloud:所有计划
  • Self-hosted 自托管:所有版本

Log streaming 日志流适用于:

  • n8n Cloud:Enterprise
  • Self-hosted 自托管:Enterprise

如何在 n8n 中设置日志记录?

要在n8n中设置日志记录,您需要设置以下环境变量(您也可以在配置文件中设置值)

配置文件中的设置 使用环境变量 描述
n8n.log.level N8N_LOG_LEVEL 日志输出级别。可用选项(从最低到最高级别)是 error、warn、info 和 debug。默认值是 info。你可以在日志级别了解有关这些选项的更多信息。
n8n.log.output N8N_LOG_OUTPUT 输出日志的位置。可用选项是 console 和 file。可以使用逗号(,)分隔多个值。默认使用 console。
n8n.log.file.location N8N_LOG_FILE_LOCATION 日志文件位置,仅在日志输出设置为 file 时使用。默认情况下,使用 <n8nFolderPath>/logs/n8n.log。
n8n.log.file.fileSizeMax N8N_LOG_FILE_SIZE_MAX 每个日志文件的最大大小(以 MB 为单位)。默认情况下,n8n 使用 16 MB。
n8n.log.file.fileCountMax N8N_LOG_FILE_COUNT_MAX 要保留的日志文件的最大数量。默认值是 100。使用 worker 时应设置此值。
# Set the logging level to 'debug' <a href="#set-the-logging-level-to-debug" id="set-the-logging-level-to-debug"></a>
export N8N_LOG_LEVEL=debug

# Set log output to both console and a log file <a href="#set-log-output-to-both-console-and-a-log-file" id="set-log-output-to-both-console-and-a-log-file"></a>
export N8N_LOG_OUTPUT=console,file

# Set a save location for the log file <a href="#set-a-save-location-for-the-log-file" id="set-a-save-location-for-the-log-file"></a>
export N8N_LOG_FILE_LOCATION=/home/jim/n8n/logs/n8n.log

# Set a 50 MB maximum size for each log file <a href="#set-a-50-mb-maximum-size-for-each-log-file" id="set-a-50-mb-maximum-size-for-each-log-file"></a>
export N8N_LOG_FILE_SIZE_MAX=50

# Set 60 as the maximum number of log files to be kept <a href="#set-60-as-the-maximum-number-of-log-files-to-be-kept" id="set-60-as-the-maximum-number-of-log-files-to-be-kept"></a>
export N8N_LOG_FILE_COUNT_MAX=60

日志级别

n8n 使用标准日志级别来报告:

  • silent:完全不输出任何内容
  • error:仅输出错误,不输出其他内容
  • warn:输出错误和警告消息
  • info:包含有关进度的有用信息
  • debug:最详细的输出。n8n 输出大量信息来帮助您调试问题。

如何在开发期间添加日志?

开发期间,添加日志消息是一种良好实践,有助于调试错误。要为开发环境配置日志记录,请按照以下指南操作。

实施细节

n8n 使用位于 workflow 包中的 LoggerProxy 类。将 Logger 实例传入 LoggerProxy.init(),即可在使用前初始化该类。

初始化过程只发生一次。start.ts 文件已经为您完成了此过程。如果您从头开始创建新命令,则需要初始化 LoggerProxy 类。

在 cli 包中创建 Logger 实现后,可以通过从导出的模块调用 getInstance 便利方法来获取它。

查看 start.ts 文件以了解有关此过程如何工作的更多信息。

添加日志

在项目中初始化 LoggerProxy 类后,您可以将其导入任何其他文件并添加日志。

为所有日志记录级别提供了便利方法,因此可以在需要时使用格式 Logger.<logLevel>('<message>', ...meta) 添加新日志,其中 meta 表示除 message 之外所需的任何其他属性。

在上面的示例中,我们使用日志级别描述的标准日志级别。message 参数是字符串,meta 是数据对象。

// 您必须导入 LoggerProxy。我们将其重命名为 Logger 以使其更容易

import {
    LoggerProxy as Logger
} from 'n8n-workflow';

// 触发器函数的信息级日志记录,以工作流名称和工作流 ID 作为其他元数据属性

Logger.info(`Polling trigger initiated for workflow "${workflow.name}"`, {workflowName: workflow.name, workflowId: workflow.id});

创建新日志记录器时,需要记住的一些有用标准是:

  • 制作尽可能人性化的日志消息。例如,始终将名称用引号括起来。
  • 在日志消息和元数据中复制信息,如上面示例中的工作流名称,这很有用,因为消息更容易搜索,元数据使过滤更容易。
  • 在所有日志中包含多个 ID(例如,executionId、workflowId 和 sessionId)。
  • 使用节点类型而不是节点名称(或两者),因为这更一致,因此更容易搜索。

是否有前端日志?

目前,前端日志不可用。在 editor-ui 包中使用 Logger 或 LoggerProxy 会产生错误。此功能将在未来版本中实现。

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。