使用winston，morgan和winston-daily-rotate-file实现记录器 [英] logger implementation using winston , morgan and winston-daily-rotate-file
问题描述
我正在尝试在节点js中实现一个记录器，它将在日志的自定义格式上每天创建一个新的日志文件
I am trying to implement a logger in node js which will create a new log file every day on a custom format for logs
为此我使用了三个包
- winston
- morgan
- winston-daily-rotate-file
所以最终输出应该每天都应该在logs文件夹中创建一个新的日志文件，它应该记录所有的http（摩根日志）和键入的日志（ winston logs）以下格式打印成单个文件
so the final output should every day a new log file should create in logs folder and it should log all the http(morgan logs) and typed logs (winston logs) into a single file in the below format
日期||文件名|| statusCode || logMessage || uuid（用于追踪）
例如： Fri Jan 18 2019 13:48:18 GMT + 0530（IST）|| [index.js] || 200 ||调用新路径|| 287dccb0-1afa-11e9-88a0-dfb1c665be9d
所以为此我写了三个文件index.js（nodejs的根文件）logger.js（logger）实现和配置）和logger.test.js（使用jest的记录器的测试用例）
so for this i have written three files index.js(root file of nodejs) logger.js(logger implementation and configuration) and logger.test.js(test cases for logger using jest)
附加包
- cors
- uuid
- http-context
- app-root-path
- express-http-context
- jest
我遇到的问题
- 如果我输入 logger.error（{message：{statusC ode：200，logMsg：服务器将在端口3000中启动}}}} 在 app.listen 上 app.listen ，然后再进行控制。 log（）uuid为null
- 我写的测试用例是错误的，我是新手，我只是想知道如何检查所有这些情况。
- 为什么当我测试套装uuid为null时，我如何通过uuid测试用例
- 如何检查新文件夹是否会创建，如果已经登录文件夹，那么新文件会被创建一种测试用例。
- 如何根据环境添加其他级别，信息，debuge，警告。如何改进此代码以实现记录器功能
- if i put a logger.error({message: {statusCode:200, logMsg: "the server will be starting in port 3000"}}) in the index.js on app.listen before to console.log() the uuid is null
- the test cases that i have written is wrong, i am new to jest i just want to know how can i check all that cases.
- why when i test the suits uuid is null, how can i pass the uuid for test cases also
- how can i check whether new folder will be created and if already logs folder are there new file is created kind of test cases.
- How can i add other levels , info, debuge , warn based on the env. How can i improve this code to implement the logger functionality
// index.js
const app = require('express')();
const cors = require('cors')
const morgan = require('morgan') // HTTP request logger middleware
const logger = require('./config/logger')(module) //Logger
const uuid = require('uuid')
const httpContext = require('express-http-context')
// Use any third party middleware that does not need access to the context here
// app.use(some3rdParty.middleware);
app.use(httpContext.middleware);
// all code from here on has access to the same context for each request
// Run the context for each request.
// Assigning a unique identifier to each request
app.use((req, res, next) => {
httpContext.set('reqId', uuid.v1());
next()
})
// using morgan with winston(logger)
app.use(morgan('combined', {
stream: {
write: (message) => logger.error(message)
}
}))
app.use(cors());
app.use("/new", (req, res) => {
logger.error({
message: {
statusCode: 400,
logMsg: "hitting new route"
}
})
nextLayer(res)
})
const nextLayer = (res) => {
logger.error({
message: {
statusCode: 400,
logMsg: "hitting in nextLayer function"
}
})
res.send("OK")
}
app.listen(4000, () => {
console.log('Server running on port 4000');
})
// Logger.js
const appRoot = require('app-root-path')
const {
createLogger,
format,
transports
} = require('winston')
const {
combine,
timestamp,
label,
printf
} = format
const path = require('path')
require('winston-daily-rotate-file');
const httpContext = require('express-http-context')
/**
* @method checkMessageProp
* @param {message} can be object if developer defined, else it will be string
* if its a network request
* @returns a fixed format how the status code and message should show
*/
const checkMessageProp = (message) => {
switch (typeof message) {
case "object":
const {
statusCode,
logMsg
} = message
return `${statusCode ? statusCode : "Not Defined"} || ${logMsg ? logMsg : "Not Defined"}`;
case "string":
let messageSplit = message.split(`"`)
var message = messageSplit ? `${messageSplit[2].trim().split(" ")[0]} || ${messageSplit[1]}` : null
return message
default:
return message
}
}
/**
* @method customFormat
* @param {log} the log passed by the developer or based on network requests
* @returns a customFormat how it should be logged to the log files
*/
const customFormat = printf(log => {
const now = new Date();
const reqId = httpContext.get('reqId');
return `${log.timestamp ? new Date(log.timestamp) : now} || [${log.label}] || ${checkMessageProp(log.message)} || ${reqId ? reqId : null}`
});
/**
* @method getFileName
* @param {moduleObj} the module realted object passed from the require of logger file
* @returns the file name where the logger was invoked
*/
const getFileName = moduleObj => {
if (Object.keys(moduleObj).length > 0) {
let parts = moduleObj.filename.split(path.sep)
return parts.pop()
} else {
return "Module not passed while requiring the logger"
}
}
// Custom settings for each transport
const options = moduleObj => {
return {
dailyRotateFile: {
filename: `${appRoot}/logs/TPS-UI-%DATE%.log`,
datePattern: 'YYYY-MM-DD',
prepend: true,
level: "error",
timestamp: new Date(),
localTime: true
}
}
}
// Instantiate a Winston Logger with the settings
let logger = moduleObj => {
return createLogger({
format: combine(
label({
label: getFileName(moduleObj)
}),
customFormat
),
transports: [
new transports.DailyRotateFile(options(moduleObj).dailyRotateFile)
],
exitOnError: false // do not exit on handled exceptions
})
}
module.exports = logger
// logger.test.js
const logger = require('./logger')
beforeEach(() => {
mockLoggerMessageObject = {
message: {
statusCode: 400,
logMsg: "Calling in test suite"
}
}
mockLoggerMessageString = `::ffff:127.0.0.1 - - [18/Jan/2019:04:50:57 +0000]
"GET /new HTTP/1.1" 200 2 "http://localhost/" "Mozilla/5.0
(linux) AppleWebKit/537.36 (KHTML, like Gecko) jsdom/11.12.0"`
mockLoggerMessageNumberFormat = 123
mockLoggerMessageArrayFormat = ["data", "test", 123]
})
describe(`Logger test cases`, () => {
test('should invoke the logger function with the mock Logger message object', () => {
expect(logger(module).error(mockLoggerMessageObject)).toBeDefined()
})
test(`should invoke the logger function with empty object`, () => {
expect(logger(module).error({})).toBeDefined()
})
test(`should invoke the logger function without any module object`, () => {
expect(logger({}).error(mockLoggerMessageObject)).toBeDefined()
})
test(`should invoke the logger function without any module and message object`, () => {
expect(logger({}).error({})).toBeDefined()
})
test(`should invoke the logger function with the http request`, () => {
expect(logger(module).error(mockLoggerMessageString)).toBeDefined()
})
test(`should invoke the logger function with the number format`, () => {
expect(logger(module).error(mockLoggerMessageNumberFormat)).toBeDefined()
})
test(`should invoke the logger function with the array format`, () => {
expect(logger(module).error(mockLoggerMessageArrayFormat)).toBeDefined()
})
})
推荐答案
对于winston我正在使用timestamp（），就像这样它会自动将timestamp（）属性添加到objec t
for winston i'm using timestamp(), like this it will automatically add timestamp() property to the object
const {transports, createLogger, format} = require('winston');
const logger = createLogger({
format: format.combine(
format.timestamp(),
format.json()
),
另外要检查它是否创建文件你可以模拟日期，比如说2019-01-01并检查它是否创建文件2019 -01-01.log
比将日期移动到2019-01-02并记录其他内容。
Winston将创建新文件夹和gzip存档，您可以检查文件是否存在且可以解压缩并包含信息
Also to check if it creates file you can mock date, to say 2019-01-01 and check is it create file 2019-01-01.log than move date to 2019-01-02 and log something else. Winston will create new folder and gzip archive and you can check is file exists and can be unzipped and contains information
尝试阅读winston的文档。
基本上我会说你可能需要使用
Try to read winston's documentation. Basically i would say that you may need to use
format.timestamp()
format.json()
colorize()
dailyRotate with zippedArchive：true
dailyRotate with zippedArchive:true
如果摩根不适合您的需求，您可以尝试直接登录
If morgan doesn't suits your needs you can try to log directly in
app.use((req, res, next) => {
logger.silly({ message:'start', req,res});
return next().then(r=>logger.silly({ message:'end', req,res}; return r;);
}
这篇关于使用winston，morgan和winston-daily-rotate-file实现记录器的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
