1. 概述

1.1 插件名称

  • Logging-Pulsar Plugin

1.2 适用场景

  • 通过Pulsar收集网关http请求日志,通过其他应用消费Pulsar消息,并且对日志进行分析。

1.3 插件功能

Apache ShenYu 网关接收客户端请求,向服务端转发请求,并将服务端结果返回给客户端.网关可以记录下每次请求对应的详细信息,
列如: 请求时间、请求参数、请求路径、响应结果、响应状态码、耗时、上游IP、异常信息等待.
Logging-Pulsar插件便是记录访问日志并将访问日志发送到Pulsar集群的插件.

1.4 插件代码

  • 核心模块 shenyu-plugin-logging-pulsar.

  • 核心类 org.apache.shenyu.plugin.logging.pulsar.LoggingPulsarPlugin

  • 核心类 org.apache.shenyu.plugin.logging.pulsar.client.PulsarLogCollectClient

1.5 添加自哪个shenyu版本

  • ShenYu 2.5.1

1.6 技术方案

  • 架构图
    Logging-Pulsar插件 - 图1

  • Apache ShenYu 网关里面进行 Logging 全程异步采集、异步发送

  • 日志平台通过消费Pulsar集群中的日志进行落库

2. 如何使用插件

2.1 插件使用流程图

Logging-Pulsar插件 - 图2

2.2 导入pom

  • 在网关的 pom.xml 文件中添加 Logging-Pulsar 的依赖。
  1. <!--shenyu logging-pulsar plugin start-->
  2. <dependency>
  3. <groupId>org.apache.shenyu</groupId>
  4. <artifactId>shenyu-spring-boot-starter-plugin-logging-pulsar</artifactId>
  5. <version>${project.version}</version>
  6. </dependency>
  7. <!--shenyu logging-pulsar plugin end-->

2.3 启用插件

  • shenyu-admin--> 基础配置 —> 插件管理-> loggingPulsar ,配置pulsar参数,并设置为开启。

2.4 配置插件

2.4.1 开启插件,并配置Pulsar,配置如下

Logging-Pulsar插件 - 图3

  • 各个配置项说明如下:
配置项类型说明备注
config-itemtypedescriptionremarks
topicString消息队列主题必须
serviceUrlString消息队列服务器地址必须
sampleRateString采样率,范围0~1,0:关闭,0.01:采集1%,1:采集100%可选,默认1,全部采集
compressAlgString压缩算法,默认不压缩,目前支持LZ4压缩可选,默认不压缩
maxResponseBodyIngeter最大响应体大小,超过阈值将不采集响应体可选,默认512KB
maxRequestBodyIngeter最大请求体大小,超过阈值将不采集请求体可选,默认512KB

除了topic、namesrvAddr其它都是可选,大部分情况下只需要配置这2项就可以了。默认的Group-id是”shenyu-access-logging”。

2.4.2 配置选择器和规则器

另外有时候一个大网关集群对应多个应用程序(业务),不同应用程序(业务)对应不同的主题,相关隔离,这时候可以按选择器配置不同的主题(可选)和采样率(可选),配置项的含义如上表所示。
操作如下图:
Logging-Pulsar插件 - 图4

2.5 Logging信息

采集的access log的字段如下:

字段名称含义说明备注
clientIp客户端IP
timeLocal请求时间字符串, 格式:yyyy-MM-dd HH:mm:ss.SSS
method请求方法(不同rpc类型不一样,http类的为:get,post等待,rpc类的为接口名称)
requestHeader请求头(json格式)
responseHeader响应头(json格式)
queryParams请求查询参数
requestBody请求Body(二进制类型的body不会采集)
requestUri请求uri
responseBody响应body
responseContentLength响应body大小
rpcTyperpc类型
status响应码
upstreamIp上游(提供服务的程序)IP
upstreamResponseTime上游(提供服务的程序)响应请求的耗时(毫秒ms)
userAgent请求的用户代理
host请求的host
module请求的模块
path请求的路径path
traceId请求的链路追踪ID需要接入链路追踪插件,如skywalking,zipkin

2.6 示例

2.6.1 通过Pulsar收集请求日志

2.6.1.1 插件配置

开启插件,并配置Pulsar,配置如下:

Logging-Pulsar插件 - 图5

2.6.1.2 选择器配置

另外有时候一个大网关集群对应多个应用程序(业务),不同应用程序(业务)对应不同的主题,相关隔离,这时候可以按选择器配置不同的主题(可选)和采样率(可选),配置项的含义如上表所示。
操作如下图:
Logging-Pulsar插件 - 图6

2.6.1.3 规则配置

Logging-Pulsar插件 - 图7

2.6.1.4 请求服务

Logging-Pulsar插件 - 图8

2.6.1.5 消费以及展示Logging

由于各个日志平台有差异,如存储可用clickhouse,ElasticSearch等待,可视化有自研的或开源的Grafana、Kibana等。
Logging-Pulsar插件利用Pulsar进行生产和消费解耦,同时以json格式输出日志,消费和可视化需要用户结合自身情况选择不同的技术栈来实现。

3. 如何禁用插件

  • shenyu-admin —> 基础配置 —> 插件管理-> loggingPulsar ,设置为关闭。