Nodejs 中的日志记录和监控：最佳实践-js教程-PHP中文网

Nodejs 中的日志记录和监控：最佳实践

聖光之護

发布： 2024-11-07 08:48:07

转载

494人浏览过

nodejs 中的日志记录和监控：最佳实践

有效的日志记录和监控对于维护应用程序运行状况、快速识别问题和提高性能至关重要。在本文中，我们将深入探讨 node.js 应用程序的日志记录和监控，涵盖选择日志记录级别、设置结构化日志、与监控工具集成以及使用 winston 和 elasticsearch 的最佳实践等关键主题。

日志记录和监控简介

日志记录有助于捕获应用程序中的实时事件、错误和其他重要信息，而监控则涉及跟踪一段时间内的应用程序性能指标。它们共同提供了有关应用程序运行状况的重要见解，从而能够主动解决问题。

在 node.js 中设置基本日志记录

内置的控制台对象提供了简单的日志记录功能，但专用的日志记录库对于生产应用程序来说更加强大。

基本控制台日志记录

console.log("server started on port 3000");
console.warn("this is a warning");
console.error("error occurred while processing request");

登录后复制

但是，控制台日志记录在复杂应用中存在局限性，例如缺乏日志级别控制以及没有日志持久化。

温斯顿介绍

winston 是一个流行的 node.js 日志库，提供多个日志级别、传输（日志目的地）和结构化日志记录。

安装温斯顿：

   npm install winston

登录后复制

设置温斯顿

   const winston = require("winston");

   // configure logger
   const logger = winston.createlogger({
       level: "info",
       format: winston.format.combine(
           winston.format.timestamp(),
           winston.format.json()
       ),
       transports: [
           new winston.transports.console(),
           new winston.transports.file({ filename: "app.log" })
       ]
   });

   // logging examples
   logger.info("server started on port 3000");
   logger.error("database connection failed");

登录后复制

选择适当的日志级别

日志级别根据日志消息的重要性对其进行分类。常见的日志级别有：

错误：需要立即关注的严重问题，例如数据库或服务器故障。
警告：非关键问题，例如已弃用的 api。
信息：一般应用程序信息，例如服务器启动或关闭。
调试：开发过程中有用的详细信息，例如变量值。

在 winston 中配置日志级别

logger.level = "debug"; // sets the minimum log level to debug, capturing all messages.

登录后复制

在生产中，最好将日志级别保持在 info 或 warn 以避免不必要的日志数据。

结构化日志记录的一致性

结构化日志记录通过保持一致的格式可以更轻松地过滤和分析日志。

将元数据添加到日志

user_id 或 request_id 等元数据可以帮助跟踪日志中的特定操作：

logger.info("user login successful", { user_id: "12345" });
logger.error("failed to fetch user data", { user_id: "12345", error: "database unavailable" });

登录后复制

与 elasticsearch 集成以实现集中日志记录

elasticsearch 广泛用于集中式日志管理和搜索功能。

安装 elasticsearch 和 elasticsearch transport

   npm install @elastic/elasticsearch winston-elasticsearch

登录后复制

配置 elasticsearch 传输

   const { elasticsearchtransport } = require("winston-elasticsearch");

   const estransport = new elasticsearchtransport({
       clientopts: { node: "http://localhost:9200" }
   });

   logger.add(estransport);

登录后复制

此设置会将日志发送到 elasticsearch，允许您使用 kibana 进行实时日志搜索和分析。

使用 prometheus 和 grafana 监控应用程序指标

监控跟踪 cpu 使用率、内存和响应时间等应用程序性能指标，有助于确保应用程序稳定。

使用 node.js 设置 prometheus

安装 prometheus 客户端库

   npm install prom-client

登录后复制

创建和导出指标

   const client = require("prom-client");
   const httprequestduration = new client.histogram({
       name: "http_request_duration_seconds",
       help: "duration of http requests in seconds",
       labelnames: ["method", "route"]
   });

   function startmonitoring(req, res, next) {
       const end = httprequestduration.starttimer();
       res.on("finish", () => end({ method: req.method, route: req.path }));
       next();
   }
   app.use(startmonitoring);

登录后复制

公开指标端点

   app.get("/metrics", async (req, res) => {
       res.set("Content-Type", client.register.contentType);
       res.end(await client.register.metrics());
   });

登录后复制