You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shenyu.apache.org by xi...@apache.org on 2022/07/02 14:10:29 UTC
[incubator-shenyu-website] branch main updated: [type:refactor] add logging-elasticsearch and logging-rocketmq (#627)
This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new 3b4ed66704 [type:refactor] add logging-elasticsearch and logging-rocketmq (#627)
3b4ed66704 is described below
commit 3b4ed66704034bca6da71e394324e8035094912f
Author: moremind <he...@hotmail.com>
AuthorDate: Sat Jul 2 22:10:24 2022 +0800
[type:refactor] add logging-elasticsearch and logging-rocketmq (#627)
* [type:refactor] add logging-elasticsearch plugin and logging-rocketmq plugin doc
* [type:refactor] add logging-elasticsearch plugin and logging-rocketmq plugin doc
* [type:refactor] add logging-elasticsearch plugin and logging-rocketmq plugin doc
---
.../observability/logging-elasticsearch.md | 92 ++++++++++++-----
docs/plugin-center/observability/logging-plugin.md | 2 +-
.../observability/logging-rocketmq.md | 114 ++++++++++++++++-----
.../observability/logging-elasticsearch.md | 100 +++++++++++++-----
.../observability/logging-rocketmq.md | 100 ++++++++++++++----
.../logging/logging-rocketmq/call-service.png | Bin 0 -> 26557 bytes
.../logging/logging-rocketmq/log-rule-en.jpg | Bin 0 -> 77617 bytes
.../logging/logging-rocketmq/log-rule-zh.jpg | Bin 0 -> 70871 bytes
.../logging-rocket-disabled-en.jpg | Bin 0 -> 205902 bytes
.../logging-rocket-disabled-zh.jpg | Bin 0 -> 195864 bytes
10 files changed, 315 insertions(+), 93 deletions(-)
diff --git a/docs/plugin-center/observability/logging-elasticsearch.md b/docs/plugin-center/observability/logging-elasticsearch.md
index e854b16b1b..cd4a718a06 100644
--- a/docs/plugin-center/observability/logging-elasticsearch.md
+++ b/docs/plugin-center/observability/logging-elasticsearch.md
@@ -3,37 +3,66 @@ title: Logging-ElasticSearch Plugin
keywords: ["Logging", "ElasticSearch"]
description: Logging-ElasticSearch Plugin
---
+# 1. Overview
-## Description
+## 1.1 Plugin Name
+
+* Logging-ElasticSearch Plugin
+
+## 1.2 Appropriate Scenario
+
+* collect http request info to elasticsearch, query or display request info by another application(kibana).
+
+## 1.3 Plugin functionality
>`Apache ShenYu` The gateway receives requests from the client, forwards them to the server, and returns the server results to the client. The gateway can record the details of each request，
>The list includes: request time, request parameters, request path, response result, response status code, time consumption, upstream IP, exception information waiting.
>Shenyu gateway can record access logs through logging-elasticsearch-plugin and send access logs to elasticsearch database.
+## 1.4 Plugin code
+
+* Core Module `shenyu-plugin-logging-elasticsearch`
+
+* Core Class `org.apache.shenyu.plugin.logging.elasticsearch.LoggingElasticSearchPlugin`
+* Core Class `org.apache.shenyu.plugin.logging.elasticsearch.client.ElasticSearchLogCollectClient`
-## Technical Solutions
+## 1.5 Added Since Which shenyu version
+
+* Since 2.5.0
+
+## 1.6 Technical Solutions
* Architecture Diagram
-## Plugin Usage
+# 2. How to use plugin
+
+## 2.1 Plugin-use procedure chart
-### 1.Add the dependency of logging-elasticsearch to the Shenyu-bootstrap-module 's `pom.xml` file.
+
+
+## 2.2 Import pom
+
+* Add the dependency of logging-elasticsearch to the Shenyu-bootstrap-module 's `pom.xml` file.
```xml
<!--shenyu logging-elasticsearch plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-logging-elasticsearch</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!--shenyu logging-elasticsearch plugin end-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-logging-elasticsearch</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!--shenyu logging-elasticsearch plugin end-->
```
-### 2.In `shenyu-admin` --> Basic Configuration --> Plugin Management --> `loggingElasticSearch`, configure the ElasticSearch parameter and set it to on.
+## 2.3 Enable plugin
+
+* In `shenyu-admin` --> Basic Configuration --> Plugin Management --> `loggingElasticSearch`, configure the ElasticSearch parameter and set it to on.
-#### 2.1Open the plugin and configure elasticsearch, configure it as follows.
+## 2.4 Config plugin
+
+### 2.4.1 Open the plugin and configure elasticsearch, configure it as follows.
@@ -49,7 +78,7 @@ description: Logging-ElasticSearch Plugin
| maxRequestBody | Ingeter | Maximum request body size, above the threshold no request body will be collected | Optional, default 512KB |
Except for host, port, all others are optional, in most cases only these 3 items need to be configured.
-#### 2.2 Configuring Selectors and Rulers
+### 2.4.2 Configuring Selectors and Rulers
For detailed configuration of selectors and rules, please refer to: [Selector and rule management](../../user-guide/admin-usage/selector-and-rule)。
In addition sometimes a large gateway cluster corresponds to multiple applications (business), different applications (business) corresponds to different topics, related to isolation,
@@ -58,9 +87,9 @@ The operation is shown below:
-## Logging information
+## 2.5 Logging information
-The fields of the captured access log are as follows.
+The fields of the captured access log are as follows.
| Field Name | Meaning | Description | Remarks |
| :-------------------- | :----------------------------------------------------------: | :----------------------------------------------------------- | :------ |
@@ -84,11 +113,16 @@ The fields of the captured access log are as follows.
| path | The requested path | | |
| traceId | Requested Link Tracking ID | Need to access link tracking plugins, such as skywalking,zipkin | |
-## Collect Logging
+
+## 2.6 Examples
+
+### 2.6.1 Collect Http Log by ElasticSearch
+
+#### 2.6.1.1 Install ElasticSearch
Users need to deploy the `ElasticSearch` service to collect
-### Installing ElasticSearch under Windows Environment
+##### 2.6.1.1.1 Installing ElasticSearch under Windows Environment
- To [download address](https://www.elastic.co/downloads/elasticsearch) Select Windows version to download
- After downloading the installation package, unzip it, enter the `bin` directory, and double-click to execute `elasticsearch.bat` to start
@@ -96,7 +130,7 @@ Users need to deploy the `ElasticSearch` service to collect
-### Installing ElasticSearch in MacOS environment
+##### 2.6.1.1.2 Installing ElasticSearch in MacOS environment
- To [download address](https://www.elastic.co/downloads/elasticsearch) Select Windows version to download
- After downloading the installation package, unzip it, enter the `bin` directory and execute the startup command on the terminal: `./elasticsearch`
@@ -104,7 +138,9 @@ Users need to deploy the `ElasticSearch` service to collect
-### Installing Kibana under Windows Environment
+#### 2.6.1.2 Install Kibana
+
+##### 2.6.1.2.1 Installing Kibana under Windows Environment
- To [download address](https://www.elastic.co/cn/downloads/kibana) Select Windows version to download
- After downloading the installation package, unzip it, enter the `bin` directory, and double-click to execute `kibana.bat` to start
@@ -112,7 +148,7 @@ Users need to deploy the `ElasticSearch` service to collect
-### Installing Kibana in MacOS environment
+##### 2.6.1.2.2 Installing Kibana in MacOS environment
- To [download address](https://www.elastic.co/cn/downloads/kibana) Select Windows version to download
- After downloading the installation package, unzip it, enter the `bin` directory and execute the startup command on the terminal: `./kibana`
@@ -120,13 +156,19 @@ Users need to deploy the `ElasticSearch` service to collect
-### Initiate a request, and the elasticsearch java client collects logs and stores them in the elasticsearch database
+#### 2.6.1.3 Plugin Configuration
-#### Using postman to initiate a request
+
+
+#### 2.6.1.4 Selector and Rule Configuration
+
+* For detailed configuration of selectors and rules, please refer to:[Selector and rule management](../../user-guide/admin-usage/selector-and-rule)。
+
+#### 2.6.1.5 Using postman to initiate a request
-#### Querying data using kibaba
+#### 2.6.1.6 Querying data using kibaba
@@ -135,3 +177,7 @@ Users need to deploy the `ElasticSearch` service to collect
- Using ES query statement, the requested log information can be queried
+
+# 3. How to disable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `LoggingElasticSearch` set Status disable.
diff --git a/docs/plugin-center/observability/logging-plugin.md b/docs/plugin-center/observability/logging-plugin.md
index aea7f4655e..a95cc6fcd8 100644
--- a/docs/plugin-center/observability/logging-plugin.md
+++ b/docs/plugin-center/observability/logging-plugin.md
@@ -26,7 +26,7 @@ description: logging plugin
## 1.5 Added Since Which shenyu version
-* Since shenyu 2.4.0
+* Since ShenYu 2.4.0
# 2. How to use plugin
diff --git a/docs/plugin-center/observability/logging-rocketmq.md b/docs/plugin-center/observability/logging-rocketmq.md
index 131183a68f..93f42136a4 100644
--- a/docs/plugin-center/observability/logging-rocketmq.md
+++ b/docs/plugin-center/observability/logging-rocketmq.md
@@ -4,40 +4,71 @@ keywords: ["Logging", "RocketMQ"]
description: Logging-RocketMQ Plugin
---
-## Description
+# 1. Overview
+
+## 1.1 Plugin Name
+
+* Logging-RocketMQ Plugin
+
+## 1.2 Appropriate Scenario
+
+* collect http request log to rocketmq, consume rocketmq message to another application and analysis.
+
+## 1.3 Plugin functionality
>`Apache ShenYu` The gateway receives requests from the client, forwards them to the server, and returns the server results to the client. The gateway can record the details of each request，
> The list includes: request time, request parameters, request path, response result, response status code, time consumption, upstream IP, exception information waiting.
> The Logging-RocketMQ plugin is a plugin that records access logs and sends them to the RocketMQ cluster.
+## 1.4 Plugin code
-## Technical Solutions
+* Core Module `shenyu-plugin-logging-rocketmq`.
+
+* Core Class `org.apache.shenyu.plugin.logging.rocketmq.LoggingRocketMQPlugin`
+* Core Claas `org.apache.shenyu.plugin.logging.rocketmq.client.RocketMQLogCollectClient`
+
+## 1.5 Added Since Which shenyu version
+
+* Since ShenYu 2.5.0
+
+## 1.6 Technical Solutions
* Architecture Diagram
- 
+
+
* Full asynchronous collection and delivery of `Logging` inside the `Apache ShenYu` gateway
-* Logging platform by consuming the logs in the `RocketMQ` cluster for repository, and then using `Grafana`, `Kibana` or other visualization platform to display
+* Logging platform by consuming the logs in the `RocketMQ` cluster for repository, and then using `Grafana`, `Kibana` or other visualization platform to display
-## Plugin Usage
+# 2. How to use plugin
-### 1.Add the `Logging-RocketMQ` dependency to the gateway's `pom.xml` file.
+## 2.1 Plugin-use procedure chart
+
+
+
+## 2.2 Import pom
+
+* Add the `Logging-RocketMQ` dependency to the gateway's `pom.xml` file.
```xml
- <!--shenyu logging-rocketmq plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-logging-rocketmq</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!--shenyu logging-rocketmq plugin end-->
+<!--shenyu logging-rocketmq plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-logging-rocketmq</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!--shenyu logging-rocketmq plugin end-->
```
-### 2.In `shenyu-admin` --> Basic Configuration --> Plugin Management --> `loggingRocketMQ`, configure the rocketMQ parameter and set it to on.
+## 2.3 Enable plugin
+
+* In `shenyu-admin` --> Basic Configuration --> Plugin Management --> `loggingRocketMQ`, configure the rocketMQ parameter and set it to on.
+
+## 2.4 Config plugin
-#### 2.1Open the plugin and configure rocketmq, configure it as follows.
+### 2.4.1 Open the plugin and configure rocketmq, configure it as follows.
@@ -55,18 +86,18 @@ description: Logging-RocketMQ Plugin
| maxRequestBody | Ingeter | Maximum request body size, above the threshold no request body will be collected | Optional, default 512KB |
Except for topic, namesrvAddr, producerGroup, all others are optional, in most cases only these 3 items need to be configured.
-#### 2.2 Configuring Selectors and Rulers
+### 2.4.2 Configuring Selectors and Rulers
+
+* For detailed configuration of selectors and rules, please refer to: [Selector and rule management](../../user-guide/admin-usage/selector-and-rule)。
-For detailed configuration of selectors and rules, please refer to: [Selector and rule management](../../user-guide/admin-usage/selector-and-rule)。
In addition sometimes a large gateway cluster corresponds to multiple applications (business), different applications (business) corresponds to different topics, related to isolation,
then you can configure different topics (optional) and sampling rate (optional) by selector, the meaning of the configuration items as shown in the table above.
-The operation is shown below:
+The operation is shown below:
+## 2.5 Logging Info
-## Logging information
-
-The fields of the captured access log are as follows.
+collect request info as follows
| Field Name | Meaning | Description | Remarks |
|:----------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------|:----|
@@ -91,13 +122,41 @@ The fields of the captured access log are as follows.
| traceId | Requested Link Tracking ID | Need to access link tracking plugins, such as skywalking,zipkin | |
-## Consumption and display of Logging
+## 2.6 Examples
+
+### 2.6.1 Collect Http Log by RocketMQ
+
+#### 2.6.1.1 Plugin Configuration
+
+Open the plugin and configure rocketmq, configure it as follows.
+
+
+
+#### 2.6.1.2 Selector Configuration
+
+For detailed configuration of selectors and rules, please refer to: [Selector and rule management](../../user-guide/admin-usage/selector-and-rule)。
+
+In addition sometimes a large gateway cluster corresponds to multiple applications (business), different applications (business) corresponds to different topics, related to isolation,
+then you can configure different topics (optional) and sampling rate (optional) by selector, the meaning of the configuration items as shown in the table above.
+The operation is shown below:
+
+
+#### 2.6.1.3 Rule Configuration
+
+
+
+#### 2.6.1.4 Request Service
+
+
+
+#### 2.6.1.5 Consumption and display of Logging
As each logging platform has differences, such as storage available clickhouse, ElasticSearch, etc., visualization has self-developed or open source Grafana, Kibana, etc..
-Logging-RocketMQ plugin uses RocketMQ to decouple production and consumption, while outputting logs in json format,
+Logging-RocketMQ plugin uses RocketMQ to decouple production and consumption, while outputting logs in json format,
consumption and visualization require users to choose different technology stacks to achieve their own situation.
-## Panel Display
+
+#### 2.6.1.6 Panel Display
Users can choose to visualize the implementation according to their own situation.
The following shows the effect of `Grafana`:
@@ -105,3 +164,10 @@ The following shows the effect of `Grafana`:
+# 3. How to disable plugin
+
+- In `shenyu-admin` --> BasicConfig --> Plugin --> `loggingRocketMQ` set Status disable.
+
+
+
+
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-elasticsearch.md b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-elasticsearch.md
index 5804479c30..75e9d552c4 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-elasticsearch.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-elasticsearch.md
@@ -4,35 +4,66 @@ keywords: ["Logging", "ElasticSearch"]
description: Logging-ElasticSearch插件
---
-## 说明
+# 1. 概述
+
+## 1.1 插件名称
+
+* Logging-ElasticSearch
+
+## 1.2 适用场景
+
+* 通过shenyu网关收集http请求日志，通过其他平台(Kibana)查询或者展示日志。
+
+## 1.3 插件功能
>`Apache ShenYu` 网关接收客户端请求，向服务端转发请求，并将服务端结果返回给客户端。网关可以记录下每次请求对应的详细信息，
> 列如： 请求时间、请求参数、请求路径、响应结果、响应状态码、耗时、上游IP、异常信息等待.
> ShenYu网关可以通过Logging-ElasticSearch插件记录访问日志并将访问日志发送到ElasticSearch数据库。
-## 技术方案
+## 1.4 插件代码
+
+* 核心模块 `shenyu-plugin-logging-elasticsearch`
+
+* 核心类 `org.apache.shenyu.plugin.logging.elasticsearch.LoggingElasticSearchPlugin`
+* 核心类 `org.apache.shenyu.plugin.logging.elasticsearch.client.ElasticSearchLogCollectClient`
+
+## 1.5 添加自哪个shenyu版本
+
+* ShenYu 2.5.0
+
+## 1.6 技术方案
* 架构图
- 
+
+
+# 2. 如何使用插件
+
+## 2.1 插件使用流程图
+
+
-## 插件使用
+## 2.2 导入pom
-### 1.在shenyu-bootstrap模块的 `pom.xml` 文件中添加 `Logging-ElasticSearch`的依赖。
+* 在shenyu-bootstrap模块的 `pom.xml` 文件中添加 `Logging-ElasticSearch`的依赖。
```xml
- <!--shenyu logging-elasticsearch plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-logging-elasticsearch</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!--shenyu logging-elasticsearch plugin end-->
+<!--shenyu logging-elasticsearch plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-logging-elasticsearch</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!--shenyu logging-elasticsearch plugin end-->
```
-### 2.在 `shenyu-admin`--> 基础配置 --> 插件管理-> `loggingElasticSearch` ，配置ElasticSearch参数，并设置为开启。
+## 2.3 启用插件
-#### 2.1开插件，并配置elasticsearch,配置如下：
+* 在 `shenyu-admin`--> 基础配置 --> 插件管理-> `loggingElasticSearch` ，配置ElasticSearch参数，并设置为开启。
+
+## 2.4 配置插件
+
+### 2.4.1 开启插件，并配置elasticsearch,配置如下：
@@ -49,17 +80,17 @@ description: Logging-ElasticSearch插件
| maxRequestBody | Ingeter | 最大请求体大小，超过阈值将不采集请求体 | 可选，默认512KB |
*除了host、port其它都是可选*，大部分情况下只需要配置这2项就可以了。
-#### 2.2 配置选择器和规则器
+### 2.4.2 配置选择器和规则器
选择器和规则详细配置，请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
另外有时候一个大网关集群对应多个应用程序（业务），不同应用程序（业务）对应不同的主题，相关隔离，这时候可以按选择器配置不同的主题(可选)和采样率(可选)，配置项的含义如上表所示。
-操作如下图：
+操作如下图：
-## Logging信息
+## 2.5 Logging信息
-采集的access log的字段如下：
+采集的access log的字段如下：
| 字段名称 | 含义 | 说明 | 备注 |
| :-------------------- | :----------------------------------------------------------: | :---------------------------------------- | :--- |
@@ -83,11 +114,16 @@ description: Logging-ElasticSearch插件
| path | 请求的路径path | | |
| traceId | 请求的链路追踪ID | 需要接入链路追踪插件，如skywalking,zipkin | |
-## 收集Logging
+
+## 2.6 示例
+
+### 2.6.1 通过ElasticSearch收集http请求日志
+
+#### 2.6.1.1 安装ElasticSearch
用户需要部署`ElasticSearch`服务来采集
-### windows 环境下安装ElasticSearch
+##### 2.6.1.1.1 windows 环境下安装ElasticSearch
- 到[下载地址](https://www.elastic.co/downloads/elasticsearch)选择windows版本进行下载
- 下载安装包后解压，进入`bin`目录下,双击执行`elasticsearch.bat`进行启动
@@ -95,7 +131,7 @@ description: Logging-ElasticSearch插件
-### macos 环境下安装ElasticSearch
+##### 2.6.1.1.2 macos 环境下安装ElasticSearch
- 到[下载地址](https://www.elastic.co/downloads/elasticsearch)选择macos版本进行下载
- 下载安装包后解压，进入`bin`目录下,在终端执行启动命令: `./elasticsearch`
@@ -103,7 +139,9 @@ description: Logging-ElasticSearch插件
-### windows 环境下安装Kibana
+#### 2.6.1.2 安装Kibana
+
+##### 2.6.1.2.1 windows 环境下安装Kibana
- 到[下载地址](https://www.elastic.co/cn/downloads/kibana)选择windows版本进行下载
- 下载安装包后解压，进入`bin`目录下,双击执行`kibana.bat`进行启动
@@ -111,7 +149,7 @@ description: Logging-ElasticSearch插件
-### macos 环境下安装Kibana
+##### 2.6.1.2.2 macos 环境下安装Kibana
- 到[下载地址](https://www.elastic.co/cn/downloads/kibana)选择windows版本进行下载
- 下载安装包后解压，进入`bin`目录下,在终端执行启动命令: `./kibana`
@@ -119,13 +157,19 @@ description: Logging-ElasticSearch插件
-### 发起请求，ElasticSearch的Java客户端收集日志并存储进ElasticSearch数据库
+#### 2.6.1.3 插件配置
-#### 使用postman发起请求
+
+
+#### 2.6.1.4 选择器和规则的配置
+
+* 选择器和规则详细配置，请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+
+#### 2.6.1.5 使用postman发起请求
-#### 使用Kibaba查询数据
+#### 2.6.1.6 使用Kibana查询数据
@@ -134,3 +178,7 @@ description: Logging-ElasticSearch插件
- 利用es查询语句可以查询到请求的日志信息
+
+# 3. 如何禁用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理-> `LoggingElasticSearch` ，设置为关闭。
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-rocketmq.md b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-rocketmq.md
index b123fd6360..33a259b367 100644
--- a/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-rocketmq.md
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/plugin-center/observability/logging-rocketmq.md
@@ -4,14 +4,34 @@ keywords: ["Logging", "RocketMQ"]
description: Logging-RocketMQ插件
---
-## 说明
+# 1. 概述
+
+## 1.1 插件名称
+
+* Logging-RocketMQ Plugin
+
+## 1.2 适用场景
+
+* 通过rocketmq收集网关http请求日志，通过其他应用消费rocketmq消息，并且对日志进行分析。
+
+## 1.3 插件功能
>`Apache ShenYu` 网关接收客户端请求，向服务端转发请求，并将服务端结果返回给客户端.网关可以记录下每次请求对应的详细信息，
> 列如： 请求时间、请求参数、请求路径、响应结果、响应状态码、耗时、上游IP、异常信息等待.
> Logging-RocketMQ插件便是记录访问日志并将访问日志发送到RocketMQ集群的插件.
+## 1.4 插件代码
+
+* 核心模块 `shenyu-plugin-logging-rocketmq`.
+
+* 核心类 `org.apache.shenyu.plugin.logging.rocketmq.LoggingRocketMQPlugin`
+* 核心类 `org.apache.shenyu.plugin.logging.rocketmq.client.RocketMQLogCollectClient`
+
+## 1.5 添加自哪个shenyu版本
+
+* ShenYu 2.5.0
-## 技术方案
+## 1.6 技术方案
* 架构图
@@ -20,24 +40,33 @@ description: Logging-RocketMQ插件
* 日志平台通过消费`RocketMQ`集群中的日志进行落库，再使用`Grafana`、`Kibana`或者其它可视化平台展示
+# 2. 如何使用插件
-## 插件使用
+## 2.1 插件使用流程图
-### 1.在网关的 `pom.xml` 文件中添加 `Logging-RocketMQ` 的依赖。
+
+
+## 2.2 导入pom
+
+* 在网关的 `pom.xml` 文件中添加 `Logging-RocketMQ` 的依赖。
```xml
- <!--shenyu logging-rocketmq plugin start-->
- <dependency>
- <groupId>org.apache.shenyu</groupId>
- <artifactId>shenyu-spring-boot-starter-plugin-logging-rocketmq</artifactId>
- <version>${project.version}</version>
- </dependency>
- <!--shenyu logging-rocketmq plugin end-->
+ <!--shenyu logging-rocketmq plugin start-->
+<dependency>
+ <groupId>org.apache.shenyu</groupId>
+ <artifactId>shenyu-spring-boot-starter-plugin-logging-rocketmq</artifactId>
+ <version>${project.version}</version>
+</dependency>
+<!--shenyu logging-rocketmq plugin end-->
```
-### 2.在 `shenyu-admin`--> 基础配置 --> 插件管理-> `loggingRocketMQ` ，配置rocketMQ参数，并设置为开启。
+## 2.3 启用插件
+
+* 在 `shenyu-admin`--> 基础配置 --> 插件管理-> `loggingRocketMQ` ，配置rocketMQ参数，并设置为开启。
+
+## 2.4 配置插件
-#### 2.1开启插件，并配置rocketmq,配置如下：
+### 2.4.1 开启插件，并配置rocketmq,配置如下
@@ -55,17 +84,18 @@ description: Logging-RocketMQ插件
| maxRequestBody | Ingeter | 最大请求体大小，超过阈值将不采集请求体 | 可选，默认512KB |
*除了topic、namesrvAddr, producerGroup其它都是可选*，大部分情况下只需要配置这3项就可以了。
-#### 2.2 配置选择器和规则器
+### 2.4.2 配置选择器和规则器
+
+* 选择器和规则详细配置，请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
-选择器和规则详细配置，请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
另外有时候一个大网关集群对应多个应用程序（业务），不同应用程序（业务）对应不同的主题，相关隔离，这时候可以按选择器配置不同的主题(可选)和采样率(可选)，配置项的含义如上表所示。
操作如下图：
-## Logging信息
+## 2.5 Logging信息
-采集的access log的字段如下：
+采集的access log的字段如下：
| 字段名称 | 含义 | 说明 | 备注 |
|:----------------------|:----------------------------------------------:|:------------------------------|:----|
@@ -89,13 +119,38 @@ description: Logging-RocketMQ插件
| path | 请求的路径path | | |
| traceId | 请求的链路追踪ID | 需要接入链路追踪插件，如skywalking,zipkin | |
+## 2.6 示例
+
+### 2.6.1 通过RocketMQ收集请求日志
-## 消费以及展示Logging
+#### 2.6.1.1 插件配置
+
+开启插件，并配置rocketmq,配置如下：
+
+
+
+#### 2.6.1.2 选择器配置
+
+* 选择器和规则详细配置，请参考: [选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+
+另外有时候一个大网关集群对应多个应用程序（业务），不同应用程序（业务）对应不同的主题，相关隔离，这时候可以按选择器配置不同的主题(可选)和采样率(可选)，配置项的含义如上表所示。
+操作如下图：
+
+
+#### 2.6.1.3 规则配置
+
+
+
+#### 2.6.1.4 请求服务
+
+
+
+#### 2.6.1.5 消费以及展示Logging
由于各个日志平台有差异，如存储可用clickhouse,ElasticSearch等待，可视化有自研的或开源的Grafana、Kibana等。
Logging-RocketMQ插件利用RocketMQ进行生产和消费解耦，同时以json格式输出日志，消费和可视化需要用户结合自身情况选择不同的技术栈来实现。
-## 面板展示
+#### 2.6.1.6 面板展示
用户可根据自身情况选择可视化实现。
下面展示下 `Grafana` 效果：
@@ -103,3 +158,10 @@ Logging-RocketMQ插件利用RocketMQ进行生产和消费解耦，同时以json
+# 3. 如何禁用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理-> loggingRocketMQ ，设置为关闭。
+
+
+
+
diff --git a/static/img/shenyu/plugin/logging/logging-rocketmq/call-service.png b/static/img/shenyu/plugin/logging/logging-rocketmq/call-service.png
new file mode 100644
index 0000000000..35fb056b24
Binary files /dev/null and b/static/img/shenyu/plugin/logging/logging-rocketmq/call-service.png differ
diff --git a/static/img/shenyu/plugin/logging/logging-rocketmq/log-rule-en.jpg b/static/img/shenyu/plugin/logging/logging-rocketmq/log-rule-en.jpg
new file mode 100644
index 0000000000..d1c1bb3124
Binary files /dev/null and b/static/img/shenyu/plugin/logging/logging-rocketmq/log-rule-en.jpg differ
diff --git a/static/img/shenyu/plugin/logging/logging-rocketmq/log-rule-zh.jpg b/static/img/shenyu/plugin/logging/logging-rocketmq/log-rule-zh.jpg
new file mode 100644
index 0000000000..183dac00af
Binary files /dev/null and b/static/img/shenyu/plugin/logging/logging-rocketmq/log-rule-zh.jpg differ
diff --git a/static/img/shenyu/plugin/logging/logging-rocketmq/logging-rocket-disabled-en.jpg b/static/img/shenyu/plugin/logging/logging-rocketmq/logging-rocket-disabled-en.jpg
new file mode 100644
index 0000000000..c4d2c3fe71
Binary files /dev/null and b/static/img/shenyu/plugin/logging/logging-rocketmq/logging-rocket-disabled-en.jpg differ
diff --git a/static/img/shenyu/plugin/logging/logging-rocketmq/logging-rocket-disabled-zh.jpg b/static/img/shenyu/plugin/logging/logging-rocketmq/logging-rocket-disabled-zh.jpg
new file mode 100644
index 0000000000..be8adddce7
Binary files /dev/null and b/static/img/shenyu/plugin/logging/logging-rocketmq/logging-rocket-disabled-zh.jpg differ