Skip to content

登录 n8n

日志记录是调试的一个重要功能。n8n 使用winston日志记录库。

日志流

除了本文档中描述的日志记录选项外, n8n 自托管企业层还包括日志流

设置

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

配置文件中的设置 使用环境变量 描述
n8n.log.级别 N8N_LOG_LEVEL 日志输出级别。可用选项(从低到高)为 error、warn、info 和 debug。默认值为。您可以在此处了解有关这些选项的更多信息。
n8n.log.输出 N8N_LOG_输出 日志输出位置。可选参数为和。多个值之间用逗号 ( ) 分隔。默认为 。
n8n.log.文件.位置 N8N_LOG_FILE_LOCATION 日志文件位置,仅当将日志输出设置为文件时使用。默认情况下使用。
n8n.log.file.maxsize N8N_日志文件大小_MAX 每个日志文件的最大大小(以 MB 为单位)。默认情况下,n8n 使用 16 MB。
n8n.log.file.maxcount N8N_LOG_FILE_COUNT_MAX 保留的最大日志文件数。默认值为 100。使用 Worker 时应设置此值。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Set the logging level to 'debug'
export N8N_LOG_LEVEL=debug

# Set log output to both console and a log file
export N8N_LOG_OUTPUT=console,file

# Set a save location for the log file
export N8N_LOG_FILE_LOCATION=/home/jim/n8n/logs/n8n.log

# Set a 50 MB maximum size for each log file
export N8N_LOG_FILE_MAXSIZE=50

# Set 60 as the maximum number of log files to be kept
export N8N_LOG_FILE_MAXCOUNT=60

日志级别

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

  • :什么也不输出
  • :仅输出错误,不输出其他内容
  • :输出错误和警告信息
  • :包含有关进度的有用信息
  • :最详细的输出。n8n 输出大量信息来帮助您调试问题。

发展

在开发过程中,添加日志消息是一种很好的做法。它有助于调试错误。要配置开发日志记录,请遵循以下指南。

实现细节

n8n 使用位于包中的 类。通过传入 的实例来调用,可以在使用前初始化该类。

初始化过程仅发生一次。该文件已为您完成此过程。如果您要从头创建新命令,则需要初始化该类。

一旦在包中创建了实现,就可以通过调用导出模块中的便捷方法来获取它。

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

添加日志

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

所有日志记录级别都提供了便捷的方法,因此可以在需要时使用格式添加新日志,其中表示除 之外所需的任何其他属性。

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

1
2
3
4
5
6
7
8
9
// You have to import the LoggerProxy. We rename it to Logger to make it easier

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

// Info-level logging of a trigger function, with workflow name and workflow ID as additional metadata properties

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

创建新的记录器时,需要牢记以下一些有用的标准:

  • 尽量使日志信息易于阅读。例如,始终将名称括在引号中。
  • 复制日志消息和元数据中的信息(如上例中的工作流名称)很有用,因为消息更容易搜索,而元数据可以更容易地进行过滤。
  • 在所有日志中包含多个 ID(例如,、和)。
  • 使用节点类型而不是节点名称(或两者),因为这样更一致,因此更容易搜索。

前端日志

目前,前端日志不可用。使用或会导致包中出现错误。此功能将在未来的版本中实现。