前言

没有日志系统的后台应用是没有灵魂的，

平时工作中每次我们遇到接口报错的时候，

都会叫后台的童鞋看下怎么回事，

这时后台的童鞋都会不慌不忙的打开一个骚骚的黑窗口。

一串噼里啪啦的命令输进去，

哐哐哐，一堆报错信息出现了... 不明觉厉~

so, 我们今天也为我们的应用加上日志系统。

正文

node中写日志一般都用 log4js 具体不详细介绍

请移步 https://www.npmjs.com/package/log4js

废话不多说直接上代码

1.1 安装log4js

npm install --save log4js

1.2 增加配置文件

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

config目录下新建文件 logs.js

var path = require('path');

//日志根目录

var baseLogPath = path.resolve(__dirname, '../logs')

/*报错输出日志*/

//错误日志目录、文件名、输出完整路径

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

            },

        },

    //供外部调用的名称和对应设置定义

    categories: {

        "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

}

1.3 增加工具方法

新建 utils 目录， utils 目录下放置工具类方法

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

var log4js = require('log4js');

var logsConfig = require('../config/logs.js');

//加载配置文件

log4js.configure(logsConfig);

//调用预先定义的日志名称

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 += "response 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));

        }

    },

    //封装响应日志

    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));

        }

    }

};

1.4 改造app.js

// logger

const logsUtil = require('./utils/logs.js');

app.use(async (ctx, next) => {

    const start = new Date();					          // 响应开始时间

    let intervals;								              // 响应间隔时间

    try {

        await next();

        intervals = new Date() - start;

        logsUtil.logResponse(ctx, intervals);	  //记录响应日志

    } catch (error) {

        intervals = new Date() - start;

        logsUtil.logError(ctx, error, intervals);//记录异常日志

    }

})

如图：

1.5 运行、使用日志系统

大工告成，运行一下项目吧，看是否自动在根目录下创建了一个logs目录。如下

目前我们现在只记录的响应日志和错误日志。

下面演示一下如何打印操作日志。

我们打开 routes 文件夹。然后打开 index.js 如图所示。

假装我们做了这些操作。访问 http://localhost:3000/json

看一下日志文件夹和控制台是否和下面一样？

这就是我们在utils中写的四个输出日志的方法。

如果觉得不够用还可以仿照格式继续写其他方法。

ps: .gitignore中已设置忽略上传logs文件夹，git中不可见。

作者 HoChine

2019 年 04月 03日

GitHub地址：https://github.com/HoChine/Koa2-demo/tree/02

koa2学习笔记02 - 给koa2添加系统日志 —— node日志管理模块log4js

前言

正文

1.1 安装log4js

1.2 增加配置文件

1.3 增加工具方法

1.4 改造app.js

1.5 运行、使用日志系统

koa2学习笔记02 - 给koa2添加系统日志 —— node日志管理模块log4js的相关教程结束。

相关推荐

详解Redis的慢查询日志

Selenium 学习笔记

「学习笔记」gdb 调试的简单操作

python教程入门学习笔记第2天第一个python程序代码规范用默认的IDLE (Python GUI)编辑器编写

python教程入门学习笔记第1天初识python python语言环境安装 python编写器

机器学习实战（Machine Learning in Action）学习笔记————03.决策树原理、源码解析及测试

python的日志模块：logging；django的日志系统；django日志输出时间修改

Django 日志输出及打印--logging

koa2学习笔记02 - 给koa2添加系统日志 —— node日志管理模块log4js

前言

正文

1.1 安装log4js

1.2 增加配置文件

1.3 增加工具方法

1.4 改造app.js

1.5 运行、使用日志系统

koa2学习笔记02 - 给koa2添加系统日志 —— node日志管理模块log4js的相关教程结束。

相关推荐

详解Redis的慢查询日志

Selenium 学习笔记

「学习笔记」gdb 调试的简单操作

python教程 入门学习笔记 第2天 第一个python程序 代码规范 用默认的IDLE (Python GUI)编辑器编写

python教程 入门学习笔记 第1天 初识python python语言环境安装 python编写器

机器学习实战（Machine Learning in Action）学习笔记————03.决策树原理、源码解析及测试

python的日志模块：logging；django的日志系统；django日志输出时间修改

Django 日志输出及打印--logging

python教程入门学习笔记第2天第一个python程序代码规范用默认的IDLE (Python GUI)编辑器编写

python教程入门学习笔记第1天初识python python语言环境安装 python编写器