winston 被設計為一個簡單且通用的日誌庫，支援多種傳輸。 傳輸本質上是日誌的儲存裝置。 每個 winston 記錄器都可以在不同級別配置多個儲存渠道。例如，人們可能希望將錯誤日誌儲存在持久的遠端位置（如資料庫），但所有除錯日誌都輸出到控制檯或本地檔案。

使用 winston 的推薦方法是建立您自己的記錄器。 最簡單的方法是使用 winston.createLogger：

```typescript
const winston = require('winston');
 
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  defaultMeta: { service: 'user-service' },
  transports: [
    //
    // - Write all logs with level `error` and below to `error.log`
    // - Write all logs with level `info` and below to `combined.log`
    //
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' }),
  ],
});
 
//
// If we're not in production then log to the `console` with the format:
// `${info.level}: ${info.message} JSON.stringify({ ...rest }) `
//
if (process.env.NODE_ENV !== 'production') {
  logger.add(new winston.transports.Console({
    format: winston.format.simple(),
  }));
}
```

# winston 的日誌等級

```typescript
const levels = { 
  error: 0,
  warn: 1,
  info: 2,
  http: 3,
  verbose: 4,
  debug: 5,
  silly: 6
};
```

# 如何建立 logger

```typescript
const logger = winston.createLogger({
  transports: [
    new winston.transports.Console(),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});
```

即使 logger 例項建立之後，也能容易地刪除或者增添新的 transport：

```typescript
const files = new winston.transports.File({ filename: 'combined.log' });
const console = new winston.transports.Console();
 
logger
  .clear()          // Remove all transports
  .add(console)     // Add console transport
  .add(files)       // Add file transport
  .remove(console); // Remove console transport
```

也能使用 logger 的 configure 方法，重新配置新的 transport：

```typescript
const logger = winston.createLogger({
  level: 'info',
  transports: [
    new winston.transports.Console(),
    new winston.transports.File({ filename: 'combined.log' })
  ]
});
 
//
// Replaces the previous transports with those in the
// new configuration wholesale.
//
const DailyRotateFile = require('winston-daily-rotate-file');
logger.configure({
  level: 'verbose',
  transports: [
    new DailyRotateFile(opts)
  ]
});
```

在 winston 中，Logger 和 Transport 例項都被視為接受 info 物件的 objectMode 流。

提供給給定格式的 info 參數列示單個日誌訊息。 物件本身是可變的。 每個資訊必須至少具有 level 和 message 屬性：

```typescript
const info = {
  level: 'info',                 // Level of the logging message  
  message: 'Hey! Log something?' // Descriptive message being logged.
};
```

除了級別和訊息之外的屬性被視為“元屬性”：

```typescript
const { level, message, ...meta } = info;
```

我們來動手寫一個實際的例子。

主程式：

```typescript
// @ts-nocheck
var express = require('express');
var app = express();
var DEFAULTPORT = 3003;
var port = process.env.PORT || DEFAULTPORT;
var winstonTest = require("./winstonTest");

app.get('/', function(_req, res){
   res.send("Hello world");
   winstonTest.logMessage('234');
});

app.listen(port, function(){
     console.log("App listens on port: " + port);
});
```

winstonTest 的實現：

```typescript
const winston = require('winston');
 
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.json(),
  defaultMeta: { service: 'user-service' },
  transports: [
    //
    // - Write all logs with level `error` and below to `error.log`
    // - Write all logs with level `info` and below to `combined.log`
    //
    new winston.transports.File({ filename: 'data/error.log', level: 'error' }),
    new winston.transports.File({ filename: 'data/combined.log' }),
  ]
});

if (process.env.NODE_ENV !== 'production') {
    logger.add(new winston.transports.Console({
      format: winston.format.simple(),
    }));
}

console.log('Logger initialized successfully!');

function log(content){
    logger.info('hello', { message: content });
}

module.exports = {
    logMessage: log
};
```

瀏覽器裡輸入如下 url：
http://localhost:3003/
在 combined.log 裡生成了如下 log 檔案：

![](https://img-blog.csdnimg.cn/img_convert/26dcbcefd4ecb020f2604f127c2e28ae.png)

這就是 winston 最基本的使用方法。

日誌庫 winston 的學習筆記 - 建立一個使用 winston 的 Node.js 應用

相關文章