https://github.com/zhike-team/log-express-middleware

日志打印中间件
https://github.com/zhike-team/log-express-middleware

Last synced: 4 days ago
JSON representation

日志打印中间件

• Host: GitHub
• URL: https://github.com/zhike-team/log-express-middleware
• Owner: zhike-team
• License: mit
• Created: 2018-12-26T04:16:43.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-05-15T10:09:50.000Z (over 5 years ago)
• Last Synced: 2024-12-23T16:47:01.481Z (about 1 month ago)
• Language: JavaScript
• Size: 133 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# log-express-middleware

日志打印中间件

![image](example.png)

# Install

```

$ npm install @zhike/log-express-middleware

```

# Example

```

const logger = require('@zhike/log-express-middleware')

const Express = require('express')

var bodyParser = require('body-parser')

const app = new Express()

app.use(bodyParser.json())

//只打印requestBody

app.use(logger())

// 打印所有路径的headers中的content-type。只打印以/player2开头的路径的responseBody

app.use(logger({

    requestHeaders: ['content-type'],

    responseHeaders: ['content-type'],

    responseBodyWhiteList: ['/^\/player2/']

}))

// 对密码进行隐藏

app.use(logger({

  handler: function(req, res, _log) {

    if (req.path === '/signin') {

      _log.requestBody.password = '****1**'

    }

  }

}))

```

## Configuration Options

| 参数名                 | 类型                          |  说明  |

| --------              | -----                         | ------ |

| reqId                    | String                           | 响应标识id(使用自定义的reqId需放在日志中间件前。如果为空且ctx.reqId为空则使用uuidv4自动生成reqId)                            |

| requestHeaders | Array                      | 需要打印的request头部   (默认不打印)            |

| responseHeaders | Array                      | 需要打印的response头部 (默认不打印)                 |

| responseBodyWhiteList               | Array                           | 白名单,字符串数组，可为正则(对于正则匹配剔除部分路由,可在业务代码中的ctx.useResponseBodyOption=false跳过路由规则)                            |

| responseBodyBlackList       | Array                           | 黑名单,字符串数组,可为正则(对于正则匹配剔除部分路由,可在业务代码中使用ctx.useResponseBodyOption=false跳过路由规则)                      |

| handler       | Function(req, res, _log)                           | 特殊处理函数。_log目前有requestBody属性，可以用来调整requestBody打印（是req.body的副本，进行修改，不会影响req.body）                     |

注意： 

1. 必会打印reqId,路径，方法，响应时间。

2. 默认打印requestBody。

3. 默认不打印responseBody。

4. responseBodyWhiteList和不能和responseBodyBlackList同时传值

5. responseBodyWhiteList和responseBodyBlackList暂未支持同一path不同method,后续会完善。

6. 在express的中间件函数中 ，可以通过 req._reqId 取到reqId。可以在使用console.log时带上。