docs • 用户指南 • logging

日志记录

Node-RED使用一个将输出写入控制台的日志记录器。它还支持使用自定义日志模块，以便将输出发送到其他地方。

Note : if you are running as a service on the Raspberry Pi using our install script, you can use the node-red-log command to view the service log.

控制台日志记录器

控制台日志记录器可以在设置文件中的logging属性下进行配置。

// Configure the logging output
logging: {
    // Console logging
    console: {
        level: "info",
        metrics: false,
        audit: false
    }
}

有3个属性用于配置日志记录器的行为：

`level`

要记录的日志级别。选项包括：

fatal - 仅记录导致应用程序无法使用的严重错误
error - 记录对特定请求被视为致命的错误
warn - 记录非致命性问题
info - 记录应用程序常规运行的相关信息
debug - 记录比info更详细的信息
trace - 记录非常详细的日志
off - 完全不记录任何日志消息

除了off之外，每个日志级别都包含更高级别的消息 - 例如，warn级别将包含error和fatal级别的消息。您可以在编写函数章节中找到如何记录这些不同日志级别的API参考

`metrics`

当设置为true时，Node-RED运行时会输出流程执行和内存使用信息。

每个节点接收和发送的事件都会输出到日志中。例如，以下日志是由包含注入和调试节点的流程输出的。

Mar 13:57:53 - [metric] {"level":99,"nodeid":"8bd04b10.813f58","event":"node.inject.receive","msgid":"86c8212c.4ef45","timestamp":1489067873391}
Mar 13:57:53 - [metric] {"level":99,"nodeid":"8bd04b10.813f58","event":"node.inject.send","msgid":"86c8212c.4ef45","timestamp":1489067873392}
Mar 13:57:53 - [metric] {"level":99,"nodeid":"4146d01.5707f3","event":"node.debug.receive","msgid":"86c8212c.4ef45","timestamp":1489067873393}

内存使用情况每15秒记录一次。

Mar 13:56:24 - [metric] {"level":99,"event":"runtime.memory.rss","value":97517568,"timestamp":1489067784815}
Mar 13:56:24 - [metric] {"level":99,"event":"runtime.memory.heapTotal","value":81846272,"timestamp":1489067784817}
Mar 13:56:24 - [metric] {"level":99,"event":"runtime.memory.heapUsed","value":59267432,"timestamp":1489067784817}

`audit`

当设置为true时，将记录Admin HTTP API访问事件。该事件包含被访问的端点、IP地址和时间戳等附加信息。

如果启用了adminAuth，事件将包含有关请求用户的信息。

9 Mar 13:49:42 - [audit] {"event":"library.get.all","type":"flow","level":98,"path":"/library/flows","ip":"127.0.0.1","timestamp":1489067382686}
9 Mar 14:34:22 - [audit] {"event":"flows.set","type":"full","version":"v2","level":98,"user":{"username":"admin","permissions":"write"},"path":"/flows","ip":"127.0.0.1","timestamp":1489070062519}

自定义日志模块

也可以使用自定义日志模块。例如，metrics输出可能会被发送到单独的系统，用于监控系统性能。

要使用自定义日志记录器，请在您的设置文件的logging属性中添加一个新块：

// Configure the logging output
logging: {
    // Console logging
    console: {
        level: "info",
        metrics: false,
        audit: false
    },
    // Custom logger
    myCustomLogger: {
        level: 'debug',
        metrics: true,
        handler: function(settings) {
            // Called when the logger is initialised

            // Return the logging function
            return function(msg) {
                console.log(msg.timestamp, msg.event);
            }
        }
    }
}

level、metrics 和 audit 属性与控制台日志记录相同。

handler属性定义了自定义日志处理器。它是一个在启动时被调用一次的函数，会传入日志记录器的配置。它必须返回一个用于处理日志消息的函数。

可以配置多个自定义日志记录器 - 唯一保留的名称为console。

日志记录器示例

以下示例添加了一个自定义日志记录器，用于通过TCP连接将指标事件发送到Logstash实例。

这是一个非常快速简单的示例 - 没有错误处理或重新连接逻辑。

logging: {
    console: {
        level: "info",
        metrics: false,
        audit: false
    },
    logstash: {
        level:'off',
        metrics:true,
        handler: function(conf) {
            var net = require('net');
            var logHost = '192.168.99.100',logPort = 9563;
            var conn = new net.Socket();
            conn.connect(logPort,logHost)
                .on('connect',function() {
                    console.log("Logger connected")
                })
                .on('error', function(err) {
                    // Should attempt to reconnect in a real env
                    // This example just exits...
                    process.exit(1);
                });
            // Return the function that will do the actual logging
            return function(msg) {
                var message = {
                    '@tags': ['node-red', 'test'],
                    '@fields': msg,
                    '@timestamp': (new Date(msg.timestamp)).toISOString()
                }
                try {
                    conn.write(JSON.stringify(message)+"\n");
                }catch(err) { console.log(err);}
            }
        }
    }
}