首頁  >  文章  >  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