Nodejs 应用程序的有效日志记录和监控-js教程-PHP中文网

nodejs 应用程序的有效日志记录和监控

对于任何应用程序，尤其是在生产环境中，监控和日志记录都是关键组件。它们可以深入了解应用程序的运行状况、性能和潜在问题。在 node.js 应用程序中，监控可帮助您跟踪响应时间、内存使用情况、错误率等指标，同时日志记录可捕获有关用户活动、错误和系统性能的基本数据。本文介绍了 node.js 应用程序的有效日志记录和监控技术，以及实际示例和代码片段。

日志记录和监控的重要性
在 node.js 中设置日志记录
使用 winston 进行灵活的日志记录
使用 prometheus 和 grafana 进行监控
实施健康检查
实际用例：生产中的日志记录和监控

日志记录和监控的重要性

日志记录和监控提供了以下方面的见解：

应用程序运行状况：有关错误、崩溃或严重问题的实时警报。
性能指标：有关服务器响应时间、内存使用情况和负载处理的数据。
用户活动：跟踪用户请求、成功操作和错误。
调试：通过错误日志和跟踪查明问题，更快地进行故障排除。

在 node.js 中设置日志记录

node.js 有一个内置的控制台对象，它提供基本的日志记录功能（console.log()、console.error() 等）。然而，对于可扩展的应用程序，结构化且可配置的日志记录至关重要。

基本日志记录示例：

// basic logging in node.js
console.log("application started");
console.error("an error occurred");

对于生产级应用程序，请使用结构化记录器，例如 winston 或 bunyan。

使用 winston 进行灵活的日志记录

winston 是 node.js 中流行的日志记录库，它允许配置日志记录级别并支持多种传输（例如文件、控制台、http）。

设置温斯顿：

const winston = require('winston');

const logger = winston.createlogger({
    level: 'info',
    format: winston.format.json(),
    transports: [
        new winston.transports.console(),
        new winston.transports.file({ filename: 'error.log', level: 'error' }),
        new winston.transports.file({ filename: 'combined.log' })
    ]
});

// log messages
logger.info("this is an informational message");
logger.error("this is an error message");

使用 prometheus 和 grafana 进行监控

prometheus 是一个用于收集应用程序指标的强大工具，grafana 允许您通过详细的仪表板可视化这些指标。

第 1 步：安装 node.js 的 prometheus 客户端

安装舞会客户端包：

npm install prom-client

第 2 步：设置 prometheus 指标

在 node.js 应用程序中定义请求持续时间和活动请求等指标：

const client = require('prom-client');

// create metrics
const requestduration = new client.histogram({
    name: 'http_request_duration_seconds',
    help: 'duration of http requests in seconds',
    labelnames: ['method', 'status']
});

const activerequests = new client.gauge({
    name: 'active_requests',
    help: 'number of active requests'
});

// record metrics
app.use((req, res, next) => {
    const end = requestduration.starttimer();
    activerequests.inc();

    res.on('finish', () => {
        end({ method: req.method, status: res.statuscode });
        activerequests.dec();
    });

    next();
});

第 3 步：公开指标端点

创建端点以向 prometheus 公开指标：

app.get('/metrics', async (req, res) => {
    res.set('content-type', client.register.contenttype);
    res.send(await client.register.metrics());
});

第 4 步：使用 grafana 进行可视化

将 prometheus 连接到 grafana 并创建自定义仪表板以可视化请求率、延迟和内存使用等指标。

Nodejs Patterns

内容：生产级 Node.js 后端模式，涵盖 Express/Fastify 配置、分层架构、中间件、错误处理、验证、数据库集成、身份验证及缓存。时机：构建 REST API、搭建 Node.js 服务器、实施身份验证、集成数据库、添加验证/缓存或构建后端应用结构时。关键词：nodejs, node, express, fastify, typescript, api, rest, 中间件, 身份验证, jwt, 验证, zod, postgres, mongodb, redis, 缓存, 速率限

下载

实施健康检查

健康检查监视您的应用程序的状态并提醒您可能影响可用性的问题。它们可以包括对服务器响应、内存使用情况或数据库连接的基本检查。

示例：node.js 中的健康检查端点

app.get('/health', (req, res) => {
    const healthstatus = {
        uptime: process.uptime(),
        message: 'ok',
        timestamp: date.now()
    };
    res.status(200).send(healthstatus);
});

将运行状况检查与 aws cloudwatch 或 google cloud monitoring 等监控工具集成，以便在出现问题时创建警报。

实际用例：生产中的日志记录和监控

假设您正在 aws 上运行电子商务应用程序，每秒处理数百个请求。以下是如何设置强大的日志记录和监控：

第 1 步：使用 winston 实施日志记录

使用 winston 记录所有关键操作，包括用户请求、成功的交易和错误。

logger.info("User login successful", { userId: "12345", timestamp: new Date() });
logger.error("Payment processing failed", { error: error.message, timestamp: new Date() });

第 2 步：设置 prometheus 进行指标收集

使用 prometheus 跟踪请求持续时间、活动请求和内存使用情况等指标。这可以帮助识别高流量期间的性能问题。

第3步：创建用于监控的grafana仪表板

将 prometheus 数据连接到 grafana 并设置仪表板来实时监控响应时间、cpu 使用率和错误率。配置警报以接收任何异常情况的通知，例如错误率激增或内存使用率过高。

结论

有效的日志记录和监控对于管理和扩展 node.js 应用程序至关重要，尤其是在生产环境中。 winston 等日志框架允许您捕获结构化日志，而 prometheus 和 grafana 等监控工具可提供性能指标的可见性并帮助您更快地解决问题。通过实施这些工具，您可以确保 node.js 应用程序平稳运行、高效处理流量并为用户提供可靠的体验。

在下一篇文章中，我们将探讨如何保护 node.js 应用程序，讨论 https、cors、数据加密等技术。请继续关注！