Summary of how to use nodejs log module winston
This time I will bring you a summary of how to use the nodejs log module winston. What are the precautions when using the nodejs log module winston? The following is a practical case, let's take a look.
winston log module
In using the nodejs winston module, adding the two related modules will get twice the result with half the effort.
express-winston
winston-daily-rotate-file
express -winston
is an increased version of express-winston's winston. It is used as express's middleware to print logs. It not only has request header information, but also has response time.
As middleware, why is there a response time? Because express-winston rewrites express's res.end method, the log is generated after the request is completed.
Code snippet
var end = res.end;
res.end = function(chunk, encoding) {
res.responseTime = (new Date) - req._startTime;
res.end = end;
res.end(chunk, encoding);
...
}express-winston does not modify or extend winston's transport, and winston-daily-rotate-file just enhances winston's transport method
winston-daily-rotate-file
winston-daily-rotate-file is an extension of winston, which adds a transport method so that winston has the ability to roll logs.
Combined use
We have a requirement: How to make express-winston print the log, and also print out the request parameters of the interface/api and response data?
The log middleware should be behind the call chain api and before api/* business processing. like: app.use('/api', apiRequestLogger, apiHandler)
To get the response data, it can only be captured after the business is processed and sent out. All express The final request response is res.send. We can start from here to capture the response data
The code is as follows
import winston from 'winston'
import expressWinston from 'express-winston'
import 'winston-daily-rotate-file'
import path from 'path'
export let DailyRotateFileTransport = (fileName) => {
return new (winston.transports.DailyRotateFile)({
filename: path.join(process.env.LOGPATH, `${fileName}-%DATE%.log`),
datePattern: 'YYYY-MM-DD-HH',
// maxSize: '20m',
maxFiles: '7d',
timestamp: () => new Date().format('yyyy-MM-dd hh:mm:ss.S')
})
}
export let pageRequestLogger = expressWinston.logger({
transports: [
DailyRotateFileTransport('page-request')
],
meta: true, // optional: control whether you want to log the meta data about the request (default to true)
msg: 'HTTP {{req.method}} {{req.url}}', // optional: customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}"
expressFormat: true, // Use the default Express/morgan request formatting. Enabling this will override any msg if true. Will only output colors with colorize set to true
colorize: false, // Color the text and status code, using the Express/morgan color palette (text: gray, status: default green, 3XX cyan, 4XX yellow, 5XX red).
ignoreRoute: function (req, res) {
// 只打印页面请求信息
let notPageRequest = false
let ignoreArr = ['/api', '.js', '.css', '.png', '.jpg', '.gif']
ignoreArr.forEach(item => {
if (req.url.indexOf(item) > -1) notPageRequest = true
})
return notPageRequest
} // optional: allows to skip some log messages based on request and/or response
})
export let apiRequestLogger = (req, res, next) => {
let send = res.send
let content = ''
let query = req.query || {}
let body = req.body || {}
res.send = function () {
content = arguments[0]
send.apply(res, arguments)
}
expressWinston.logger({
transports: [
DailyRotateFileTransport('api-request')
],
meta: true, // optional: control whether you want to log the meta data about the request (default to true)
msg () {
return `HTTP ${req.method} ${req.url} query ${JSON.stringify(query)} body ${JSON.stringify(body)} resData ${content} `
},
colorize: true, // Color the text and status code, using the Express/morgan color palette (text: gray, status: default green, 3XX cyan, 4XX yellow, 5XX red).
ignoreRoute: function (req, res) {
if (req.headers.self) return true
return false
} // optional: allows to skip some log messages based on request and/or response
})(req, res, next)
}I believe you have mastered the method after reading the case in this article, and more How exciting, please pay attention to other related articles on php Chinese website!
Recommended reading:
react router4 redux detailed explanation of the steps to control routing permissions
Detailed explanation of the advantages and disadvantages of using Webpack path and publicPath
The above is the detailed content of Summary of how to use nodejs log module winston. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Undress AI Tool
Undress images for free
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
Hot Topics
Is nodejs a backend framework?
Apr 21, 2024 am 05:09 AM
Node.js can be used as a backend framework as it offers features such as high performance, scalability, cross-platform support, rich ecosystem, and ease of development.
How to connect nodejs to mysql database
Apr 21, 2024 am 06:13 AM
To connect to a MySQL database, you need to follow these steps: Install the mysql2 driver. Use mysql2.createConnection() to create a connection object that contains the host address, port, username, password, and database name. Use connection.query() to perform queries. Finally use connection.end() to end the connection.
What are the global variables in nodejs
Apr 21, 2024 am 04:54 AM
The following global variables exist in Node.js: Global object: global Core module: process, console, require Runtime environment variables: __dirname, __filename, __line, __column Constants: undefined, null, NaN, Infinity, -Infinity
What is the difference between npm and npm.cmd files in the nodejs installation directory?
Apr 21, 2024 am 05:18 AM
There are two npm-related files in the Node.js installation directory: npm and npm.cmd. The differences are as follows: different extensions: npm is an executable file, and npm.cmd is a command window shortcut. Windows users: npm.cmd can be used from the command prompt, npm can only be run from the command line. Compatibility: npm.cmd is specific to Windows systems, npm is available cross-platform. Usage recommendations: Windows users use npm.cmd, other operating systems use npm.
Is there a big difference between nodejs and java?
Apr 21, 2024 am 06:12 AM
The main differences between Node.js and Java are design and features: Event-driven vs. thread-driven: Node.js is event-driven and Java is thread-driven. Single-threaded vs. multi-threaded: Node.js uses a single-threaded event loop, and Java uses a multi-threaded architecture. Runtime environment: Node.js runs on the V8 JavaScript engine, while Java runs on the JVM. Syntax: Node.js uses JavaScript syntax, while Java uses Java syntax. Purpose: Node.js is suitable for I/O-intensive tasks, while Java is suitable for large enterprise applications.
Is nodejs a back-end development language?
Apr 21, 2024 am 05:09 AM
Yes, Node.js is a backend development language. It is used for back-end development, including handling server-side business logic, managing database connections, and providing APIs.
Which one to choose between nodejs and java?
Apr 21, 2024 am 04:40 AM
Node.js and Java each have their pros and cons in web development, and the choice depends on project requirements. Node.js excels in real-time applications, rapid development, and microservices architecture, while Java excels in enterprise-grade support, performance, and security.
How to deploy nodejs project to server
Apr 21, 2024 am 04:40 AM
Server deployment steps for a Node.js project: Prepare the deployment environment: obtain server access, install Node.js, set up a Git repository. Build the application: Use npm run build to generate deployable code and dependencies. Upload code to the server: via Git or File Transfer Protocol. Install dependencies: SSH into the server and use npm install to install application dependencies. Start the application: Use a command such as node index.js to start the application, or use a process manager such as pm2. Configure a reverse proxy (optional): Use a reverse proxy such as Nginx or Apache to route traffic to your application
