아래에는 로깅 라이브러리를 평가할 때 사용할 수 있는 평가 기준을 나열한 것이다.
- Drop Rate: 로그가 전달하는 과정 가운데 손실되는 비율
- Individual Request Handling Time: 하나의 리쿼스트를 처리하는데 소용되는 시간
- Average Total Request Handling Time: 예를 들어 100,000 만개의 처리를 하는데 드는 시간
해당 repo에서 소개하는 로깅 모듈은 위의 기준을 어느 정도 만족시키는 4가지를 소개하고자 한다.
그리고 각 모듈의 장단점을 설명하므로 node에서 logging 모듈을 선택할때 도움을 주려고 한다.
“A multi-transport async logging library for Node.js.”
장점: multiple transport를 지원하는 라이브러이다.
단점: json logging 구조화 작업에서는 불편함. 용량이 가장 큼
- Install
npm install winston
npm notice created a lockfile as package-lock.json. You should commit this file.
+ [email protected]
added 35 packages from 29 contributors and audited 35 packages in 1.26s
1 package is looking for funding
run `npm fund` for details
found 0 vulnerabilities
- Configuration
const { createLogger, format, transports } = require('winston')
const { printf, timestamp, combine } = format;
const jsonFormat = printf((info) => {
const logObject = {
logger: info.logger || 'root-logger',
level: info.level,
service: info.service,
message: info.message,
time: info.timestamp,
context: {
tenant: info.tenant || '',
project: info.project || '',
email: info.email || ''
}
};
if (info.stack) {
logObject.err = {
name: info.name,
stack: info.stack
};
}
return JSON.stringify(logObject);
});
exports.logger = createLogger({
level: 'info',
format: combine(timestamp(), jsonFormat),
defaultMeta: { service: 'service1' },
transports: [
new transports.Console()
],
});
- Run
$ node winstonTest.js
{"logger":"application-logger","level":"info","service":"civet","message":"Listen to 3000 port","time":"2020-08-20T05:14:09.783Z","meta":{"tenant":"","project":"","email":""}}
Bunyan is a simple and fast JSON logging library for node.js services
장점: 로깅 구조화가 쉽다. child 함수를 통하여 코드 중복을 제거하기 쉽다.
단점: 초기 사용자에게 불편하다.
여기서 child 라는 함수가 중요하다. middleware에서 공통적인 정보를 로깅에 추가하고 해당 엔드포인트에서 실제 로깅을 하는 것이 가능하므로
코드 중복을 피할 수 있다.
- Configuration
app.use(function(req, res, next){
req.log = logger.child({
context: {
tenant: 's2s2',
project: "hello"
}
})
next()
})
app.get('/', (req, res) => {
req.log.info({ req , message: 'root path call'})
res.send(service.helloWorld())
})
- Run
$ node bunyanTest.js
{"name":"myapp","hostname":"superb-aiui-MacBook-Pro.local","pid":60260,"level":30,"msg":"Listen to 3000 port","time":"2020-08-20T05:47:20.984Z","v":0}
{"name":"myapp","hostname":"superb-aiui-MacBook-Pro.local","pid":60260,"level":30,"req":{"method":"GET","url":"/","headers":{"host":"localhost:3000","user-agent":"curl/7.64.1","accept":"*/*"}},"context":{"tenant":"s2s2","project":"hello"},"msg":"","time":"2020-08-20T05:47:29.278Z","v":0}
근래 많은 사람들이 사용할만하다. 모듈이 경량화 되어 있고, 사용법은 bunyan처럼 간단하다.
장점: 경량화, 사용성이 좋음.
단점: 매번 모듈을 초기화해야하는 것으로 보임(?)
const logger = require('pino')()
const app = express()
app.use(function(req, res, next){
req.log = logger.child({
context: {
tenant: 's2s2',
project: "hello"
}
})
next()
})
app.get('/', (req, res) => {
req.log.info({ message: 'root path call'})
res.send(service.helloWorld())
})
"HTTP request logger middleware for node.js" 라고 해당 모듈을 소개한다.
그래서 Express에서는 주로 morgan과 winston을 함께 사용한다. morgan은 http 요청과 응답을 규칙적으로 로깅하기 위하여 사용한다.
단점: 너무 무겁다.
장점: http request에 특화되어 있다.
- Configuration
//logger.js
const appLogger = (type) => {
const init = createLogger({
format: combine(
label({ label: logType[type] }),
),
transports: [],
});
return init;
};
const httpLogger = createLogger({ // NOTE: http status 로그를 남기기 위함.
format: combine(
label({ label: 'http' })
),
transports: [],
});
const httpLogStream = {
write: (message) => { // NOTE: morgan에서 쓰기 위해 이 형태로 fix 되야함.
httpLogger.log({
level: 'info',
message: message,
});
},
};
exports.appLogger = appLogger;
exports.httpLogStream = httpLogStream;
// app.js
const morgan = require("morgan");
const logger = require('./logger');
const app = express();
const PORT = process.env.PORT || 3000;
const morganFormat = process.env.NODE_ENV !== "production" ? "dev" : "combined";