log4js node日志管理

一时失言乱红尘 2022-12-21 02:26 142阅读 0赞

## 安装 ##

npm install --save log4js

## 增加配置文件 ##

根目录下新建config目录 conifg目录下全为配置文件  
config目录下 新建文件 logs.js

var path = require('path');
    
    //日志根目录
    var baseLogPath = path.resolve(__dirname, '../logs')
    
    /*报错输出日志*/
    
    // 请求日志目录
    let reqPath = '/request';
    // 请求日志文件名
    let reqFileName = 'request';
    // 请求日志输出完整路径
    let reqLogPath = baseLogPath + reqPath + '/' + reqFileName;
    
    //错误日志目录、文件名、输出完整路径
    var errorPath = "/error";
    var errorFileName = "error";
    var errorLogPath = baseLogPath + errorPath + "/" + errorFileName;
    
    //响应日志目录、文件名、输出完整路径
    var responsePath = "/response";
    var responseFileName = "response";
    var responseLogPath = baseLogPath + responsePath + "/" + responseFileName;
    
    /*操作数据库进行增删改等敏感操作记录日志*/
    //操作日志目录、文件名、输出完整路径
    var handlePath = "/handle";
    var handleFileName = "handle";
    var handleLogPath = baseLogPath + handlePath + "/" + handleFileName;
    
    
    module.exports = { 
        //日志格式等设置
        appenders:
            { 
                "rule-console": { "type": "console"},
                "errorLogger": { 
                    "type": "dateFile", // 日志类型
                    "filename": errorLogPath, // 输出文件名
                    "pattern": "-yyyy-MM-dd-hh.log", // 后缀
                    "alwaysIncludePattern": true, // 上面两个参数是否合并
                    "encoding": "utf-8", // 编码格式
                    "maxLogSize": 1000, // 最大存储内容
                    "numBackups": 3, // 当文件内容超过文件存储空间时，备份文件的数量
                    "path": errorPath
                },
                "resLogger": { 
                    "type": "dateFile",
                    "filename": responseLogPath,
                    "pattern": "-yyyy-MM-dd-hh.log",
                    "alwaysIncludePattern": true,
                    "encoding": "utf-8",
                    "maxLogSize": 1000,
                    "numBackups": 3,
                    "path": responsePath
                },
                "handleLogger": { 
                    "type": "dateFile",
                    "filename": handleLogPath,
                    "pattern": "-yyyy-MM-dd-hh.log",
                    "alwaysIncludePattern": true,
                    "encoding": "utf-8",
                    "maxLogSize": 1000,
                    "numBackups": 3,
                    "path": responsePath
                },
                // 请求日志
                'reqLogger': { 
                    "type": 'dateFile', // 日志类型
                    "filename": reqLogPath, // 输出文件名
                    "pattern": '-yyyy-MM-dd-hh.log', // 后缀
                    "alwaysIncludePattern": true, // 上面两个参数是否合并
                    "encoding": 'utf-8', // 编码格式
                    "maxLogSize": 1000, // 最大存储内容
                },
            },
        // 分类以及日志等级
        categories: { 
            "reqLogger": { "appenders": ['reqLogger'], "level": 'info'},
            "default": { "appenders": ["rule-console"], "level": "all"},
            "resLogger": { "appenders": ["resLogger"], "level": "info"},
            "errorLogger": { "appenders": ["errorLogger"], "level": "error"},
            "handleLogger": { "appenders": ["handleLogger"], "level": "all"},
            "http": { "appenders": ["resLogger"], "level": "info"}
        },
        "baseLogPath": baseLogPath
    }

## 增加工具方法 ##

新建 utils 目录， utils 目录下放置工具类方法  
utils 下新建 logs.js 放置输出日志的工具方法

var log4js = require('log4js');
    var logsConfig = require('../config/logs.js');
    //加载配置文件
    log4js.configure(logsConfig);
    //调用预先定义的日志名称
    var reqLogger = log4js.getLogger("reqLogger");
    var resLogger = log4js.getLogger("resLogger");
    var errorLogger = log4js.getLogger("errorLogger");
    var handleLogger = log4js.getLogger("handleLogger");
    var consoleLogger = log4js.getLogger();
    
    // 格式化日志文本 加上日志头尾和换行方便查看 ==> 普通日志、请求日志、响应日志、操作日志、错误日志
    var formatText = { 
        info: function(info) { 
            var logText = new String();
            //响应日志头信息
            logText += "\n" + "***************info log start ***************" + "\n";
            //响应内容
            logText += "info detail: " + "\n" + JSON.stringify(info) + "\n";
            //响应日志结束信息
            logText += "*************** info log end ***************" + "\n";
            return logText;
        },
        request: function(req, resTime) { 
            var logText = new String();
            var method = req.method;
            //访问方法
            logText += "request method: " + method + "\n";
            //请求原始地址
            logText += "request originalUrl: " + req.originalUrl + "\n";
            //客户端ip
            logText += "request client ip: " + req.ip + "\n";
            //开始时间
            var startTime;
            //请求参数
            if (method === 'GET') { 
                logText += "request query: " + JSON.stringify(req.query) + "\n";
                // startTime = req.query.requestStartTime;
            } else { 
                logText += "request body: " + "\n" + JSON.stringify(req.body) + "\n";
                // startTime = req.body.requestStartTime;
            }
            //服务器响应时间
            logText += "request time: " + resTime + "\n";
            return logText;
        },
        response: function(ctx, resTime) { 
            var logText = new String();
            //响应日志开始
            logText += "\n" + "*************** response log start ***************" + "\n";
            //添加请求日志
            logText += formatText.request(ctx.request, resTime);
            //响应状态码
            logText += "response status: " + ctx.status + "\n";
            //响应内容
            logText += "response body: " + "\n" + JSON.stringify(ctx.body) + "\n";
            //响应日志结束
            logText += "*************** response log end ***************" + "\n";
            return logText;
        },
        handle: function(info) { 
            var logText = new String();
            //响应日志开始
            logText += "\n" + "***************info log start ***************" + "\n";
            //响应内容
            logText += "handle info detail: " + "\n" + JSON.stringify(info).replace(/\\n/g, "\n") + "\n";
            //响应日志结束
            logText += "*************** info log end ***************" + "\n";
            return logText;
        },
        error: function(ctx, err, resTime) { 
            var logText = new String();
            //错误信息开始
            logText += "\n" + "*************** error log start ***************" + "\n";
            //添加请求日志
            logText += formatText.request(ctx.request, resTime);
            //错误名称
            logText += "err name: " + err.name + "\n";
            //错误信息
            logText += "err message: " + err.message + "\n";
            //错误详情
            logText += "err stack: " + err.stack + "\n";
            //错误信息结束
            logText += "*************** error log end ***************" + "\n";
            return logText;
        }
    }
    
    module.exports = { 
        //封装普通日志
        logInfo: function(info) { 
            if (info) { 
                consoleLogger.info(formatText.info(info));
            }
        },
        //封装请求日志
        logRequest: function(ctx, resTime) { 
            if (ctx) { 
                reqLogger.info(formatText.request(ctx, resTime));
            }
        },
        //封装响应日志
        logResponse: function(ctx, resTime) { 
            if (ctx) { 
                resLogger.info(formatText.response(ctx, resTime));
            }
        },
        //封装操作日志
        logHandle: function(res) { 
            if (res) { 
                handleLogger.info(formatText.handle(res));
            }
        },
        //封装错误日志
        logError: function(ctx, error, resTime) { 
            if (ctx && error) { 
                errorLogger.error(formatText.error(ctx, error, resTime));
            }
        }
    };

## 改造app.js ##

app.use(async (ctx, next) => { 
      const start = new Date();					          // 开始时间
      let intervals;								              // 间隔时间
      try { 
        await next();
        intervals = new Date() - start;
        logsUtil.logRequest(ctx, intervals);  // 记录请求日志
        logsUtil.logResponse(ctx, intervals);	  //记录响应日志
      } catch (error) { 
        intervals = new Date() - start;
        logsUtil.logError(ctx, error, intervals);//记录异常日志
      }
    });

## 新建logs目录 ##

## 运行、使用日志系统 ##

![在这里插入图片描述][20201113183317582.png_pic_center]

## 如何打印操作日志 ##

我们打开 routes 文件夹。 然后打开 index.js 如图所示  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMyMTg0_size_16_color_FFFFFF_t_70_pic_center]  
![在这里插入图片描述][20201113183453381.png_pic_center]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMyMTg0_size_16_color_FFFFFF_t_70_pic_center 1]  
参考文章：  
[https://www.cnblogs.com/Joans/p/9647601.html][https_www.cnblogs.com_Joans_p_9647601.html]  
[https://www.jb51.net/article/165431.htm][https_www.jb51.net_article_165431.htm]  
[https://blog.csdn.net/qq\_39834073/article/details/107986691][https_blog.csdn.net_qq_39834073_article_details_107986691]

[20201113183317582.png_pic_center]: /images/20221120/44accdda8bb64368953153dd461c8951.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMyMTg0_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/f8d1037807cb4710911f73b931db3176.png
[20201113183453381.png_pic_center]: /images/20221120/0f9a863ade3f442390ecb1e9283c0975.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMzMyMTg0_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/90f07aa51e124218845ac8a4ab612fc6.png
[https_www.cnblogs.com_Joans_p_9647601.html]: https://www.cnblogs.com/Joans/p/9647601.html
[https_www.jb51.net_article_165431.htm]: https://www.jb51.net/article/165431.htm
[https_blog.csdn.net_qq_39834073_article_details_107986691]: https://blog.csdn.net/qq_39834073/article/details/107986691

发表评论取消回复

表情：

评论列表（有 0 条评论，142人围观）

还没有评论，来说两句吧...

相关阅读

相关 log4js node日志管理

安装 npm install --save log4js 增加配置文件根目录下新建config目录 conifg目录下全为配置文件 config目录

一时失言乱红尘/ 2022年12月21日 02:26/ 0 赞/ 143 阅读

相关 log4js

log4js：是一种node日志管理工具，可以将自定义格式的日志输出到各种渠道。对于控制台的日志输出可以呈现彩色日志，对于文件方式的日志输出，可以根据文件大小或者日期进

落日映苍穹つ/ 2022年10月24日 01:59/ 0 赞/ 193 阅读

相关 log4js为日志等级分别创建日志文件

目录一、简介二、本文导读三、示例 3.1 最基础的写法 3.2 添加logLevelFilter 3

迷南。/ 2022年10月21日 11:54/ 0 赞/ 323 阅读

相关 MongoDB log4j 日志整合，统一管理

在分布式系统当中，这些服务可能分别部署在不同的服务器上，并且有各自的日志输出。为了方便对这些日志进行统一管理和分析。我们可以将日志统一输出到指定的数据库系统中，而再由日志分析系

超、凢脫俗/ 2022年08月07日 06:46/ 0 赞/ 228 阅读

相关 Log4J日志管理类使用详解

一、前言： log4j是一个开放源码项目，是广泛使用的以Java编写的日志记录包。由于log4j出色的表现，当时在log4j完成时，log4j开发组织曾建议sun

àì夳堔傛蜴生んèń/ 2022年08月06日 11:15/ 0 赞/ 200 阅读

相关玩转Nodejs日志管理log4js

从零开始nodejs系列文章从零开始nodejs系列文章，将介绍如何利Javascript做为服务端脚本，通过Nodejs框架web开发。Nodejs框架是基于V8的引

左手的ㄟ右手/ 2022年07月13日 12:40/ 0 赞/ 138 阅读

相关 Node.js npm log4js

译自 [https://www.npmjs.com/package/log4js][https_www.npmjs.com_package_log4js] log4js

忘是亡心i/ 2022年07月12日 06:50/ 0 赞/ 201 阅读

相关 Node.js npm log4js

译自 [https://www.npmjs.com/package/log4js][https_www.npmjs.com_package_log4js] log4js

一时失言乱红尘/ 2022年07月12日 06:50/ 0 赞/ 192 阅读

相关日志log4j

classapth 新建log4j.properties 内容 pom.xml <dependency> <gr

╰半夏微凉°/ 2022年05月31日 02:45/ 0 赞/ 360 阅读

相关 log4j日志管理

新建log4j.properties: \\\ \\u8BBE\\u7F6E\\\ log4j.rootLogger = debug,stdout,D,E \\\ \\

Myth丶恋晨/ 2022年03月18日 09:56/ 0 赞/ 305 阅读