NodeJS 인기있는 Logging 모듈 Winston

Nodejs로 Express 서버를 만드는데 Debugging 용도로 console.log를 사용했었다. 그냥 이게 편하고 익숙해서...ㅎ

하지만 Project를 실제 수행하다보면 서버의 동작을 파악하거나 오류를 찾아야 할때 로그파일을 뒤져보는 것이 가장 1순위일 것이다.

Nodejs로 Log를 남기고 관리하는 모듈은 많이 있다. morgan, winston 등등...

두가지를 함께 사용하는 것도 가능하다. 

하지만 여기서는 가장 인기 있는 winston 라이브러리를 사용하는 방법을 간단하게 소개한다.

01. npm으로 설치하기

아래 명령어로 설치 가능하다.

npm install --save winston

02. winston.js 작성

로그를 관리하는 모듈을 따로 패키지 형태로 작성하려한다.

우선 아래와 같은 파일을 작성했다.

winsoton-test/config/winston.js

const appRoot = require('app-root-path');    // app root 경로를 가져오는 lib
const winston = require('winston');            // winston lib
const process = require('process');
 
const { combine, timestamp, label, printf } = winston.format;
 
const myFormat = printf(({ level, message, label, timestamp }) => {
  return `${timestamp} [${label}] ${level}: ${message}`;    // log 출력 포맷 정의
});
 
const options = {
  // log파일
  file: {
    level: 'info',
    filename: `${appRoot}/logs/winston-test.log`, // 로그파일을 남길 경로
    handleExceptions: true,
    json: false,
    maxsize: 5242880, // 5MB
    maxFiles: 5,
    colorize: false,
    format: combine(
      label({ label: 'winston-test' }),
      timestamp(),
      myFormat    // log 출력 포맷
    )
  },
  // 개발 시 console에 출력
  console: {
    level: 'debug',
    handleExceptions: true,
    json: false, // 로그형태를 json으로도 뽑을 수 있다.
    colorize: true,
    format: combine(
      label({ label: 'nba_express' }),
      timestamp(),
      myFormat
    )
  }
}
 
let logger = new winston.createLogger({
  transports: [
    new winston.transports.File(options.file) // 중요! 위에서 선언한 option으로 로그 파일 관리 모듈 transport
  ],
  exitOnError: false, 
});
 
if(process.env.NODE_ENV !== 'production'){
  logger.add(new winston.transports.Console(options.console)) // 개발 시 console로도 출력
}
 
module.exports = logger;

log 파일 경로 지정하기 위해 app-root-path 모듈을 이용했다.(npm install --save app-root-path 필요)

[시간] [label(app이름으로 했음)] [log level] : 내용

위와 같은 포맷으로 정의를 하고

options를 작성한다.(유용한 옵션들 많음. 더 보려면 https://github.com/winstonjs/winston/tree/2.x)

그리고 logger를 createLogger를 이용해서 선언해준다.(3버젼이 되면서 winston.Logger로는 error가 뜰것이다.)

파일로 출력을 하였고, 개발용도를 위해 console출력도 추가하였다. transport 추가시 logger.add(~~) 해주면 된다.

마지막으로 module.exports = logger

02. app.js에 logger 추가하기

express app 정의 부분에 logger를 추가해보자.

winston-test/app.js

const express = require('express');
const bodyParser = require('body-parser')
const app = express();
const api = require('./routes/index');
const winston = require('./config/winston')
 
app.use(bodyParser.json());
app.use('/api', api);
 
const port = process.env.PORT || 3001;
app.listen(port, () => winston.info(`Listening on port ${port}...`));

위에서 만든 모듈을 임포트하고

winston.info(message) 형식으로 사용하면 된다.(간단ㅎㅎ)

로그 레벨을 아래와 같은 종류가 있다.

{ emerg: 0, alert: 1, crit: 2, error: 3, warning: 4, notice: 5, info: 6, debug: 7 }

03. app 실행

아래 명령어로 app을 실행 시켜보자.

PS C:\node-project\winston-test> node app.js
2019-02-19T14:48:48.785Z [winston-test] info: Listening on port 3001...

console에 log가 위에서 정의한 format으로 출력된 것을 확인 할 수 있다.

또한 로그파일도 생성되어 로그가 쓰여진것을 확인 할 수 있다.

winston-test/logs/winston-test.log

2019-02-19T14:48:48.784Z [winston-test] info: Listening on port 3001...
 

04. morgan과 함께 사용

morgan은 http 요청에 대한 logging을 하는 모듈로 일종의 미들웨어로 동작한다.

여기서는 단순히 함께 사용하는 방법만 소개하려고한다.(log 모양이 안이쁘다...ㅎ 설정을 통해 조정할 수 있을 듯하지만 따로 알아보지는 않았다.)

아래 명령어로 morgan 설치

npm install --save morgan

winston-test/config/winston.js 에 아래 코드 추가

...
logger.stream = {
  write: function(message, encoding) {
    logger.info(message); // 단순히 message를 default 포맷으로 출력
  },
};
 
module.exports = logger

winston-test/app.js에 미들웨어 추가

...
app.use(bodyParser.json());
app.use(morgan('combined', {stream: winston.stream})); // morgan http 로그 미들웨어 추가
...

app 실행 후, http 요청을 보내보자.

2019-02-19T14:55:45.138Z [winston-test] info: ::ffff:127.0.0.1 - - [19/Feb/2019:14:55:45 +0000] "POST /api/hello HTTP/1.1" 400 65 "-" "PostmanRuntime/7.6.0"

로그의 message에 morgan이 뱉은 로그를 확인 할 수 있다.

실제 결합하여 사용하려면 log format을 맞출 필요가 있어보인다...(@@)