kong网关的http-log插件使用说明

一、插件Http-log

kong网关插件http-log 用于将请求和响应日志发送到HTTP服务器。该插件具有以下协议的请求兼容：

• http
• https
• grpc
• grpcs
• tcp
• tls
• udp

在安装成功kong gateway(OSS) 后，在插件列表中就可以找到http-log 插件。

http-log 在记录和统计请求响应情况上已完全满足业务需求。但存在无法获取请求和响应体的问题。也就是在做请求响应数据本地化时，无法查看响应的数据和请求的参数。

二、http-log-with-body 插件

http-log-with-body 插件在功能上与http-log 插件功能一致。但该插件在发送给http服务端的请求和响应中新增了body节点。客户端在通过网关请求其他后台应用时，可做到在网关节点数据本地存储的功能。

2.1 http-log-with-body 插件安装

http-log-with-body 插件本人以测试过，可以正常使用。

1. 下载自定义插件
2. 找到kong插件存放目录
   本人安装的kong网关版本为 ：kong gateway (SSO) 2.4.0,插件存放路径为：/usr/local/share/lua/5.1/kong/plugins
   将解压后 \kong\plugins 目录下的文件夹复制到 kong网关插件存放目录下
   
3. 修改kong.conf配置文件
   我安装kong 网关的 配置文件存储路径为： /etc/kong
   修改配置文件 kong.conf 节点： plugins = bundled , http-log-with-body
   后边为自定义插件名称。
   

5重启kong服务
执行命令： kong restart

自定义插件 http-log-with-body 安装成功

2.2 http-log-with-body 使用

在服务、路由上都可以添加给插件，也可添加为全局插件。默认情况下只需要配置
http_endpoint 和 method 即可。

添加成功后，每次请求都会将kong请求和响应的信息转发到 http_endpoint 上。

2.3HTTP服务器端代码

本人使用spring boot 搭建http 服务端代码：

@RestController
@RequestMapping("/api/kong/http")
public class ApiKongLogInfoController extends BaseController {

    @Autowired
    private IKongHttpLogService kongHttpLogService;

    @PostMapping("/log")
    @RequestBody
    @Log(title = "网关日志数据入库", businessType = BusinessType.INSERT)
    public ResponseEntity<Void> HttpLogRecode(HttpServletRequest request) {
        logger.info("接收到请求");
        try {
            String req = IoUtil.read(request.getInputStream(), "UTF-8");
            logger.info(req);

        } catch (Exception e) {
            logger.error(e.getMessage());
        }

        return ResponseEntity.status(HttpStatus.OK).body(null);
    }
}

三、日志格式说明

每个请求都单独记录在一个JSON 对象中，格式如下：

{
  "latencies": {
    "request": 515,
    "kong": 58,
    "proxy": 457
  },
  "service": {
    "host": "httpbin.org",
    "created_at": 1614232642,
    "connect_timeout": 60000,
    "id": "167290ee-c682-4ebf-bdea-e49a3ac5e260",
    "protocol": "http",
    "read_timeout": 60000,
    "port": 80,
    "path": "/anything",
    "updated_at": 1614232642,
    "write_timeout": 60000,
    "retries": 5,
    "ws_id": "54baa5a9-23d6-41e0-9c9a-02434b010b25"
  },
  "request": {
    "querystring": {},
    "size": 138,
    "uri": "/log",
    "url": "http://localhost:8000/log",
    "headers": {
      "host": "localhost:8000",
      "accept-encoding": "gzip, deflate",
      "user-agent": "HTTPie/2.4.0",
      "accept": "*/*",
      "connection": "keep-alive"
    },
    "method": "GET"
  },
  "tries": [
    {
      "balancer_latency": 0,
      "port": 80,
      "balancer_start": 1614232668399,
      "ip": "18.211.130.98"
    }
  ],
  "client_ip": "192.168.144.1",
  "workspace": "54baa5a9-23d6-41e0-9c9a-02434b010b25",
  "upstream_uri": "/anything",
  "response": {
    "headers": {
      "content-type": "application/json",
      "date": "Thu, 25 Feb 2021 05:57:48 GMT",
      "connection": "close",
      "access-control-allow-credentials": "true",
      "content-length": "503",
      "server": "gunicorn/19.9.0",
      "via": "kong/2.2.1.0-enterprise-edition",
      "x-kong-proxy-latency": "57",
      "x-kong-upstream-latency": "457",
      "access-control-allow-origin": "*"
    },
    "status": 200,
    "size": 827
  },
  "route": {
    "id": "78f79740-c410-4fd9-a998-d0a60a99dc9b",
    "paths": [
      "/log"
    ],
    "protocols": [
      "http"
    ],
    "strip_path": true,
    "created_at": 1614232648,
    "ws_id": "54baa5a9-23d6-41e0-9c9a-02434b010b25",
    "request_buffering": true,
    "updated_at": 1614232648,
    "preserve_host": false,
    "regex_priority": 0,
    "response_buffering": true,
    "https_redirect_status_code": 426,
    "path_handling": "v0",
    "service": {
      "id": "167290ee-c682-4ebf-bdea-e49a3ac5e260"
    }
  },
  "started_at": 1614232668342
}

JSON 对象的一些说明：

• request 包含有关客户端发送的请求的属性。
• response 包含有关发送到客户端的响应的属性。
• tries 包含负载均衡器为此请求所做的（重）尝试（成功和失败）列表。
• route 包含有关请求的特定路由的 Kong 网关属性。
• service 包含有关与请求的路由关联的服务的 Kong 网关属性。
• authenticated_entity 包含有关经过身份验证的凭据的 Kong 网关属性（如果已启用身份验证插件）。
  workspaces包含与请求的路由关联的工作区的 Kong 网关属性。仅在 Kong Gateway 版本 >= 0.34.x 中。对于 Kong Gateway 版本 >= 2.1.x，有一个ws_id引用工作区 ID 的服务和路由。
• consumer 包含经过身份验证的消费者（如果已启用身份验证插件）。
• latencies 包含有关所涉及的延迟的一些数据：
  • proxy 是最终服务处理请求所用的时间。
  • kong 是运行所有插件所需的内部 Kong 延迟。
  • request是从客户端读取第一个字节和最后一个字节发送到客户端之间经过的时间。用于检测慢客户端。
• client_ip 包含原始客户端 IP 地址。
• started_at 包含开始处理请求时的 UTC 时间戳。