首页  >  文章  >  web前端  >  记录 Node.js 应用程序的最佳实践

记录 Node.js 应用程序的最佳实践

WBOY
WBOY原创
2024-08-10 06:38:22671浏览

Logging Best Practices For Your Node.js App

作为一名 Node.js 开发人员,在调试、监控和维护应用程序时,日志记录几乎就是一切。但您是否使用日志记录最佳实践?让我们探索一些可以将您的 Node.js 应用程序提升到新水平的日志记录技术。

要了解更多信息,您可以查看完整的博客文章。

1. 温斯顿:伐木界的瑞士军刀

?工具:温斯顿
?描述:Node.js 的多功能日志库
?主要特点:

  • 多种传输选项(控制台、文件、数据库)
  • 可自定义的日志级别
  • 支持多种格式的日志记录(JSON、纯文本)
javascriptCopyconst winston = require('winston');

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

2. Morgan:HTTP请求记录器中间件

?工具:摩根
?描述:简化 Express.js 中的 HTTP 请求日志记录
?主要特点:

  • 预定义的日志格式
  • 自定义令牌支持
  • 与 Express.js 轻松集成
javascriptCopyconst express = require('express');
const morgan = require('morgan');

const app = express();
app.use(morgan('combined'));

3. Bunyan:Node.js 的 JSON 日志记录

?工具:班扬
?描述:Node.js 应用程序的结构化 JSON 日志记录
?主要特点:

  • 默认 JSON 日志格式
  • 支持子记录器
  • 用于查看日志的内置 CLI
javascriptCopyconst bunyan = require('bunyan');
const log = bunyan.createLogger({name: "myapp"});

log.info("Hi");
log.warn({lang: 'fr'}, "Au revoir");

4. Pino:超快速 Node.js 记录器

?工具:皮诺
?描述:具有 JSON 输出的低开销日志记录
?主要特点:

  • 极快的性能
  • 自动日志轮转
  • 支持子记录器
javascriptCopyconst pino = require('pino');
const logger = pino();

logger.info('hello world');
logger.error('this is at error level');

5. 调试:微型调试实用程序

?工具:调试
?描述:Node.js 的小型调试实用程序
?主要特点:

  • 轻巧易用
  • 使用命名空间进行选择性调试
  • 浏览器支持
javascriptCopyconst debug = require('debug')('http');

debug('booting %o', name);

6. Log4js:灵活的 JavaScript 日志记录

?工具:Log4js
?描述:log4j 框架到 JavaScript 的转换
?主要特点:

  • 分层日志记录级别
  • 多个输出附加器
  • 可配置的布局
javascriptCopyconst log4js = require("log4js");
log4js.configure({
  appenders: { cheese: { type: "file", filename: "cheese.log" } },
  categories: { default: { appenders: ["cheese"], level: "error" } }
});

const logger = log4js.getLogger("cheese");
logger.error("Cheese is too ripe!");

7.Elasticsearch、Logstash 和 Kibana(ELK 堆栈)

?工具:ELK Stack
?描述:日志管理和分析的强大组合
?主要特点:

  • 集中记录
  • 实时日志分析
  • 可视化和仪表板
javascriptCopyconst winston = require('winston');
const Elasticsearch = require('winston-elasticsearch');

const esTransportOpts = {
  level: 'info',
  clientOpts: { node: 'http://localhost:9200' }
};
const logger = winston.createLogger({
  transports: [
    new Elasticsearch(esTransportOpts)
  ]
});

8.Sentry:错误跟踪和性能监控

?工具:哨兵
?描述:实时错误跟踪和性能监控
?主要特点:

  • 自动错误捕获
  • 发布跟踪
  • 性能监控
javascriptCopyconst Sentry = require("@sentry/node");

Sentry.init({ dsn: "https://examplePublicKey@o0.ingest.sentry.io/0" });

try {
  someFunction();
} catch (e) {
  Sentry.captureException(e);
}

9. 新遗迹:应用程序性能监控

?工具:新遗物
?描述:全面的应用程序性能监控
?主要特点:

  • 实时性能指标
  • 错误分析
  • 定制仪器
javascriptCopyconst newrelic = require('newrelic');

newrelic.setTransactionName('myCustomTransaction');
// Your application code here

10. Loggly:基于云的日志管理

?工具:Loggly
?描述:基于云的日志管理和分析服务
?主要特点:

  • 集中日志管理
  • 实时日志搜索与分析
  • 自定义仪表板和警报
javascriptCopyconst winston = require('winston');
const { Loggly } = require('winston-loggly-bulk');

winston.add(new Loggly({
    token: "YOUR-TOKEN",
    subdomain: "YOUR-SUBDOMAIN",
    tags: ["Winston-NodeJS"],
    json: true
}));

winston.log('info', "来自 Node.js 的 Hello World!");

额外提示:结构化日志记录

无论您选择哪种工具,实现结构化日志记录都可以极大地提高您的日志分析能力:

javascriptCopylogger.info({
  event: 'user_login',
  userId: user.id,
  timestamp: new Date().toISOString(),
  ipAddress: req.ip
});

通过使用这些附加工具和实践,您将拥有全面的日志记录策略,涵盖从基本调试到高级应用程序性能监控的所有内容。请记住,有效日志记录的关键是根据您的特定需求选择正确的工具,并在整个代码库中持续应用最佳实践。

如果您在调试 Web 应用程序时需要帮助,请查看 https://alerty.ai 以了解有关简单前端监控的更多信息。

祝您日志记录愉快,祝您的 Node.js 应用程序顺利运行! ??

以上是记录 Node.js 应用程序的最佳实践的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn