基于postman/newman实现的HTTP接口监控

20 July 2017

本文主要分两部分，第一部分是介绍postman的一些使用tips，第二部分是简单介绍下自己基于postman/newman写的一个HTTP接口监控的程序～

postman

postman作为一个http请求模拟工具相信很多人都已经用到了。postman有pc app，也有基于chrome 的app，在使用体验上，pc app会更好（比如打开太多tab时可以方便地关掉，跑collection时展示效果更好）。

目前，有一点chrome app更好用的就是，它可以利用附带的一个chrome扩展Postman Interceptor，方便地捕获chrome的请求。而pc app需要通过它的proxy功能来捕获请求。

1、使用Collection、Floder管理你的http请求，并为Collection添加一些描述信息

2、使用Header Presets管理公用的http请求头

3、如果使用的是chrome app，那么通过Postman Interceptor还可以发送带浏览器cookie的请求

4、顺序的组织你的请求，这样可以测试一些与请求顺序相关的功能（保存在collection中的请求可以直接拖动以改变顺序）

5、可以将某个请求的响应结果保存下来，作为其响应示例

6、使用环境变量（可用于切换开发环境/生产环境、设置动态参数），有4个作用域（优先级由高到低）：Global, Environment, Local, Data。同名变量会使用优先级高的。环境变量可以在请求的url、参数、header、script中访问到。具体可查看文档：Variables

7、postman还提供3个动态变量可以直接使用：

{{$guid}} : v4格式的guid
{{$timestamp}}: 当前的时间戳
{{$randomInt}}: [0, 1000]的随机数

8、使用Script，你能够（通过修改环境变量）：

为请求构造一些动态的参数
在请求之间传递数据
测试响应结果是否正常

一个单一的请求在postman的执行流程如下：

newman

newman 是一个nodejs写的命令行工具，用于执行postman的collection。

newman run examples/sample-collection.json

基于这个命令行工具，可以写一些脚本定时的跑，然后根据newman的执行结果，判断接口是否正常，如果出现错误，则可以进行告警。

monitor-man

postman 提供的监控只能监控公网上的接口，而且还不支持使用data file。monitor-man 是一个基于newman的nodejs模块写的带webui的HTTP接口监控程序，你可以上传postman的collection，并设置一个时间间隔，这样就会起一个定时器去定时的跑collection了，而且通过配置错误处理的handler，还能对错误进行告警处理。

monitor-man设计如下：

依赖于Redis存储上传的collection、environment、data file，以及collection执行状态信息。

在monitor-man 的distribute分支，是为多机房部署开发的，只需在一个机房部署的monitor-man上创建collection，并设置用于区分机房的环境变量名称（表单中的distribute name），以及相应的值（表单中的distribute value），monitor-man会自动从redis存储中同步当前机房需要跑的collection（同步的时间间隔为1分钟）。

如下collection配置示例：

#collection1
{
  "distributeName": "IDC"
  "distribute": {
    "IDC 1" : { "status": "run" },
    "IDC 2" : { "status": "run" }
  }
}
#collection2
{
  "distributeName": "IDC"
  "distribute": {
    "IDC 1" : { "status": "run" }
  }
}
#collection3
{
  "distributeName": "IDC"
  "distribute": {
    "IDC 2" : { "status": "run" }
  }
}

监控运行情况：

http 2