You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by GitBox <gi...@apache.org> on 2020/03/27 16:10:38 UTC
[GitHub] [incubator-doris] morningman opened a new pull request #3219:
[Plugin] Make audit logger pluggable
morningman opened a new pull request #3219: [Plugin] Make audit logger pluggable
URL: https://github.com/apache/incubator-doris/pull/3219
Currently we have implemented the plugin framework in FE.
This CL make the original audit log logic pluggable.
The following classes are mainly implemented:
1. AuditPlugin
The interface of audit plugin
2. AuditEvent
An AuditEvent contains all information about an audit event, such as a query, or a connection.
3. AuditLogBuilder
A built-in audit plugin implements the `AuditPlugin`, it will make the audit event as a string
and log it to the `fe.audit.log`, which act just same as the origin.
4. AuditEventProcessor
Audit event processor receive all audit event and deliver them to all installed audit plugins.
This CL has not changed what was originally recorded in audit.log.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399927035
##########
File path: docs/documentation/cn/extending-doris/plugin-development-manual.md
##########
@@ -0,0 +1,291 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 插件开发手册
+
+## 介绍
+
+Doris 支持动态加载插件。用户可以通过开发自己的插件来扩展Doris的功能。这个手册主要介绍如何开发、编译和部署 Frontend 端的插件。
+
+`fe_plugins` 目录是 FE 插件的根模块。这个根模块统一管理插件所需的依赖。添加一个新的插件，相当于在这个根模块添加一个子模块。
+
+## 插件组成
+
+一个FE的插件可以使一个**zip压缩包**或者是一个**目录**。其内容至少包含两个文件：`plugin.properties` 和 `.jar` 文件。`plugin.properties`用于描述插件信息。
+
+文件结构如下：
+
+```
+# plugin .zip
+auditodemo.zip:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+
+# plugin local directory
+auditodemo/:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+```
+
+`plugin.properties` 内容示例:
+
+```
+### required:
+#
+# the plugin name
+name = audit_plugin_demo
+#
+# the plugin type
+type = AUDIT
+#
+# simple summary of the plugin
+description = just for test
+#
+# Doris's version, like: 0.11.0
+version = 0.11.0
+
+### FE-Plugin optional:
+#
+# version of java the code is built against
+# use the command "java -version" value, like 1.8.0, 9.0.1, 13.0.4
+java.version = 1.8.31
+#
+# the name of the class to load, fully-qualified.
+classname = AuditPluginDemo
+
+### BE-Plugin optional:
+# the name of the so to load
+soName = example.so
+```
+
+## 编写一个插件
+
+插件的开发环境依赖Doris的开发编译环境。所以请先确保Doris的编译开发环境运行正常。
+
+### 创建一个模块
+
+我们可以通过以下命令在 `fe_plugins` 目录创建一个子模块用户实现创建和创建工程。其中 `doris-fe-test` 为插件名称。
+
+```
+mvn archetype: generate -DarchetypeCatalog = internal -DgroupId = org.apache -DartifactId = doris-fe-test -DinteractiveMode = false
+```
+
+这个命令会创建一个新的 maven 工程，并且自动向 `fe_plugins/pom.xml` 中添加一个子模块：
+
+```
+ .....
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <modules>
+ <module>auditdemo</module>
+ # new plugin module
+ <module>doris-fe-test</module>
+ </modules>
+ .....
+```
+
+新的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+ ---- main/java/org/apache/
+ ------- App.java # mvn auto generate, ignore
+ ---- test/java/org/apache
+```
+
+接下来我们在 `main` 目录下添加一个 `assembly` 目录来存放 `plugin.properties` 和 `zip.xml`。最终的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+---- main/
+------ assembly/
+-------- plugin.properties
+-------- zip.xml
+------ java/org/apache/
+--------App.java # mvn auto generate, ignore
+---- test/java/org/apache
+```
+
+### 添加 zip.xml
+
+`zip.xml` 用于描述最终生成的 zip 压缩包中的文件内容。（如 .jar file, plugin.properties 等等）
+
+```
+<assembly>
+ <id>plugin</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+ <!-IMPORTANT: must be false->
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <includes>
+ <include>*.jar</include>
+ </ ncludes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+
+ <fileSet>
+ <directory>src/main/assembly</directory>
+ <includes>
+ <include>plugin.properties</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+ </fileSets>
+</assembly>
+```
+
+### 更新 pom.xml
+
+接下来我们需要更新子模块的 `pom.xml` 文件，添加 doris-fe 依赖：
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>auditloader</artifactId>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe</artifactId>
+ </dependency>
+
+ <!-- other dependencies -->
+ <dependency>
+ ...
+ </dependency>
+ </dependencies>
+
+
+ <build>
+ <finalName>auditloader</finalName>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>2.4.1</version>
+ <configuration>
+ <appendAssemblyId>false</appendAssemblyId>
+ <descriptors>
+ <descriptor>src/main/assembly/zip.xml</descriptor>
+ </descriptors>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+```
+
+### 实现插件
+
+之后我们就可以开始愉快的进行插件功能的开发啦。插件需要实现 `Plugin` 接口。具体可以参阅 Doris 自带的 `auditdemo` 插件示例代码。
+
+### 编译
+
+在编译插件之前，需要先执行 `sh build.sh --fe` 进行 Doris FE 代码的编译，并确保编译成功。
+
+之后，执行 `sh build_plugin.sh` 编译所有插件。最终的产出会存放在 `fe_plugins/output` 目录中。
+
+或者也可以执行 `sh build_plugin.sh --p your_plugin_name` 来仅编译指定的插件。
+
+### 另一种开发方式
+
+您可以直接通过修改自带的 `auditdemo` 插件示例代码进行开发。
+
+## 部署
+
+插件可以通过以下三种方式部署。
+
+* 将 `.zip` 文件放在 Http 或 Https 服务器上。如：`http://xxx.xxxxxx.com/data/plugin.zip`, Doris 会下载这个文件。
+* 本地 `.zip` 文件。 如：`/home/work/data/plugin.zip`。需要在所有 FE 和 BE 节点部署。
+* 本都目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
Review comment:
```suggestion
* 本都目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
```
* 本地目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399940421
##########
File path: fe/src/main/java/org/apache/doris/plugin/PluginContext.java
##########
@@ -18,4 +18,14 @@
package org.apache.doris.plugin;
public class PluginContext {
+
+ private String pluginJarPath;
+
+ public void setPluginJarPath(String pluginJarPath) {
Review comment:
```suggestion
protected void setPluginJarPath(String pluginJarPath) {
```
Let user use the method is not a good idea
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399927035
##########
File path: docs/documentation/cn/extending-doris/plugin-development-manual.md
##########
@@ -0,0 +1,291 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 插件开发手册
+
+## 介绍
+
+Doris 支持动态加载插件。用户可以通过开发自己的插件来扩展Doris的功能。这个手册主要介绍如何开发、编译和部署 Frontend 端的插件。
+
+`fe_plugins` 目录是 FE 插件的根模块。这个根模块统一管理插件所需的依赖。添加一个新的插件，相当于在这个根模块添加一个子模块。
+
+## 插件组成
+
+一个FE的插件可以使一个**zip压缩包**或者是一个**目录**。其内容至少包含两个文件：`plugin.properties` 和 `.jar` 文件。`plugin.properties`用于描述插件信息。
+
+文件结构如下：
+
+```
+# plugin .zip
+auditodemo.zip:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+
+# plugin local directory
+auditodemo/:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+```
+
+`plugin.properties` 内容示例:
+
+```
+### required:
+#
+# the plugin name
+name = audit_plugin_demo
+#
+# the plugin type
+type = AUDIT
+#
+# simple summary of the plugin
+description = just for test
+#
+# Doris's version, like: 0.11.0
+version = 0.11.0
+
+### FE-Plugin optional:
+#
+# version of java the code is built against
+# use the command "java -version" value, like 1.8.0, 9.0.1, 13.0.4
+java.version = 1.8.31
+#
+# the name of the class to load, fully-qualified.
+classname = AuditPluginDemo
+
+### BE-Plugin optional:
+# the name of the so to load
+soName = example.so
+```
+
+## 编写一个插件
+
+插件的开发环境依赖Doris的开发编译环境。所以请先确保Doris的编译开发环境运行正常。
+
+### 创建一个模块
+
+我们可以通过以下命令在 `fe_plugins` 目录创建一个子模块用户实现创建和创建工程。其中 `doris-fe-test` 为插件名称。
+
+```
+mvn archetype: generate -DarchetypeCatalog = internal -DgroupId = org.apache -DartifactId = doris-fe-test -DinteractiveMode = false
+```
+
+这个命令会创建一个新的 maven 工程，并且自动向 `fe_plugins/pom.xml` 中添加一个子模块：
+
+```
+ .....
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <modules>
+ <module>auditdemo</module>
+ # new plugin module
+ <module>doris-fe-test</module>
+ </modules>
+ .....
+```
+
+新的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+ ---- main/java/org/apache/
+ ------- App.java # mvn auto generate, ignore
+ ---- test/java/org/apache
+```
+
+接下来我们在 `main` 目录下添加一个 `assembly` 目录来存放 `plugin.properties` 和 `zip.xml`。最终的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+---- main/
+------ assembly/
+-------- plugin.properties
+-------- zip.xml
+------ java/org/apache/
+--------App.java # mvn auto generate, ignore
+---- test/java/org/apache
+```
+
+### 添加 zip.xml
+
+`zip.xml` 用于描述最终生成的 zip 压缩包中的文件内容。（如 .jar file, plugin.properties 等等）
+
+```
+<assembly>
+ <id>plugin</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+ <!-IMPORTANT: must be false->
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <includes>
+ <include>*.jar</include>
+ </ ncludes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+
+ <fileSet>
+ <directory>src/main/assembly</directory>
+ <includes>
+ <include>plugin.properties</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+ </fileSets>
+</assembly>
+```
+
+### 更新 pom.xml
+
+接下来我们需要更新子模块的 `pom.xml` 文件，添加 doris-fe 依赖：
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>auditloader</artifactId>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe</artifactId>
+ </dependency>
+
+ <!-- other dependencies -->
+ <dependency>
+ ...
+ </dependency>
+ </dependencies>
+
+
+ <build>
+ <finalName>auditloader</finalName>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>2.4.1</version>
+ <configuration>
+ <appendAssemblyId>false</appendAssemblyId>
+ <descriptors>
+ <descriptor>src/main/assembly/zip.xml</descriptor>
+ </descriptors>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+```
+
+### 实现插件
+
+之后我们就可以开始愉快的进行插件功能的开发啦。插件需要实现 `Plugin` 接口。具体可以参阅 Doris 自带的 `auditdemo` 插件示例代码。
+
+### 编译
+
+在编译插件之前，需要先执行 `sh build.sh --fe` 进行 Doris FE 代码的编译，并确保编译成功。
+
+之后，执行 `sh build_plugin.sh` 编译所有插件。最终的产出会存放在 `fe_plugins/output` 目录中。
+
+或者也可以执行 `sh build_plugin.sh --p your_plugin_name` 来仅编译指定的插件。
+
+### 另一种开发方式
+
+您可以直接通过修改自带的 `auditdemo` 插件示例代码进行开发。
+
+## 部署
+
+插件可以通过以下三种方式部署。
+
+* 将 `.zip` 文件放在 Http 或 Https 服务器上。如：`http://xxx.xxxxxx.com/data/plugin.zip`, Doris 会下载这个文件。
+* 本地 `.zip` 文件。 如：`/home/work/data/plugin.zip`。需要在所有 FE 和 BE 节点部署。
+* 本都目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
Review comment:
```suggestion
* 本地目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399927035
##########
File path: docs/documentation/cn/extending-doris/plugin-development-manual.md
##########
@@ -0,0 +1,291 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 插件开发手册
+
+## 介绍
+
+Doris 支持动态加载插件。用户可以通过开发自己的插件来扩展Doris的功能。这个手册主要介绍如何开发、编译和部署 Frontend 端的插件。
+
+`fe_plugins` 目录是 FE 插件的根模块。这个根模块统一管理插件所需的依赖。添加一个新的插件，相当于在这个根模块添加一个子模块。
+
+## 插件组成
+
+一个FE的插件可以使一个**zip压缩包**或者是一个**目录**。其内容至少包含两个文件：`plugin.properties` 和 `.jar` 文件。`plugin.properties`用于描述插件信息。
+
+文件结构如下：
+
+```
+# plugin .zip
+auditodemo.zip:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+
+# plugin local directory
+auditodemo/:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+```
+
+`plugin.properties` 内容示例:
+
+```
+### required:
+#
+# the plugin name
+name = audit_plugin_demo
+#
+# the plugin type
+type = AUDIT
+#
+# simple summary of the plugin
+description = just for test
+#
+# Doris's version, like: 0.11.0
+version = 0.11.0
+
+### FE-Plugin optional:
+#
+# version of java the code is built against
+# use the command "java -version" value, like 1.8.0, 9.0.1, 13.0.4
+java.version = 1.8.31
+#
+# the name of the class to load, fully-qualified.
+classname = AuditPluginDemo
+
+### BE-Plugin optional:
+# the name of the so to load
+soName = example.so
+```
+
+## 编写一个插件
+
+插件的开发环境依赖Doris的开发编译环境。所以请先确保Doris的编译开发环境运行正常。
+
+### 创建一个模块
+
+我们可以通过以下命令在 `fe_plugins` 目录创建一个子模块用户实现创建和创建工程。其中 `doris-fe-test` 为插件名称。
+
+```
+mvn archetype: generate -DarchetypeCatalog = internal -DgroupId = org.apache -DartifactId = doris-fe-test -DinteractiveMode = false
+```
+
+这个命令会创建一个新的 maven 工程，并且自动向 `fe_plugins/pom.xml` 中添加一个子模块：
+
+```
+ .....
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <modules>
+ <module>auditdemo</module>
+ # new plugin module
+ <module>doris-fe-test</module>
+ </modules>
+ .....
+```
+
+新的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+ ---- main/java/org/apache/
+ ------- App.java # mvn auto generate, ignore
+ ---- test/java/org/apache
+```
+
+接下来我们在 `main` 目录下添加一个 `assembly` 目录来存放 `plugin.properties` 和 `zip.xml`。最终的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+---- main/
+------ assembly/
+-------- plugin.properties
+-------- zip.xml
+------ java/org/apache/
+--------App.java # mvn auto generate, ignore
+---- test/java/org/apache
+```
+
+### 添加 zip.xml
+
+`zip.xml` 用于描述最终生成的 zip 压缩包中的文件内容。（如 .jar file, plugin.properties 等等）
+
+```
+<assembly>
+ <id>plugin</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+ <!-IMPORTANT: must be false->
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <includes>
+ <include>*.jar</include>
+ </ ncludes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+
+ <fileSet>
+ <directory>src/main/assembly</directory>
+ <includes>
+ <include>plugin.properties</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+ </fileSets>
+</assembly>
+```
+
+### 更新 pom.xml
+
+接下来我们需要更新子模块的 `pom.xml` 文件，添加 doris-fe 依赖：
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>auditloader</artifactId>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe</artifactId>
+ </dependency>
+
+ <!-- other dependencies -->
+ <dependency>
+ ...
+ </dependency>
+ </dependencies>
+
+
+ <build>
+ <finalName>auditloader</finalName>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>2.4.1</version>
+ <configuration>
+ <appendAssemblyId>false</appendAssemblyId>
+ <descriptors>
+ <descriptor>src/main/assembly/zip.xml</descriptor>
+ </descriptors>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+```
+
+### 实现插件
+
+之后我们就可以开始愉快的进行插件功能的开发啦。插件需要实现 `Plugin` 接口。具体可以参阅 Doris 自带的 `auditdemo` 插件示例代码。
+
+### 编译
+
+在编译插件之前，需要先执行 `sh build.sh --fe` 进行 Doris FE 代码的编译，并确保编译成功。
+
+之后，执行 `sh build_plugin.sh` 编译所有插件。最终的产出会存放在 `fe_plugins/output` 目录中。
+
+或者也可以执行 `sh build_plugin.sh --p your_plugin_name` 来仅编译指定的插件。
+
+### 另一种开发方式
+
+您可以直接通过修改自带的 `auditdemo` 插件示例代码进行开发。
+
+## 部署
+
+插件可以通过以下三种方式部署。
+
+* 将 `.zip` 文件放在 Http 或 Https 服务器上。如：`http://xxx.xxxxxx.com/data/plugin.zip`, Doris 会下载这个文件。
+* 本地 `.zip` 文件。 如：`/home/work/data/plugin.zip`。需要在所有 FE 和 BE 节点部署。
+* 本都目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
Review comment:
本地目录
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r400092413
##########
File path: fe/src/main/java/org/apache/doris/plugin/PluginContext.java
##########
@@ -18,4 +18,14 @@
package org.apache.doris.plugin;
public class PluginContext {
+
+ private String pluginJarPath;
+
+ public void setPluginJarPath(String pluginJarPath) {
Review comment:
OK
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399930246
##########
File path: fe/src/main/java/org/apache/doris/plugin/PluginMgr.java
##########
@@ -76,14 +87,21 @@ public PluginInfo installPlugin(InstallPluginStmt stmt) throws IOException, User
try {
PluginInfo info = pluginLoader.getPluginInfo();
- if (plugins[info.getTypeId()].putIfAbsent(info.getName(), pluginLoader) != null) {
- pluginLoader.uninstall();
+ if (plugins[info.getTypeId()].containsKey(info.getName())) {
throw new UserException("plugin " + info.getName() + " has already been installed.");
}
-
+
// install plugin
pluginLoader.install();
pluginLoader.setStatus(PluginStatus.INSTALLED);
+
+ if (plugins[info.getTypeId()].putIfAbsent(info.getName(), pluginLoader) != null) {
+ pluginLoader.uninstall();
Review comment:
We can't uninstall the plugin here, because it may cause the actual plugin to be uninstalled by mistake
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r400092217
##########
File path: fe/src/main/java/org/apache/doris/plugin/PluginContext.java
##########
@@ -18,4 +18,14 @@
package org.apache.doris.plugin;
public class PluginContext {
+
+ private String pluginJarPath;
Review comment:
OK
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r400093870
##########
File path: docs/documentation/cn/extending-doris/plugin-development-manual.md
##########
@@ -0,0 +1,291 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 插件开发手册
+
+## 介绍
+
+Doris 支持动态加载插件。用户可以通过开发自己的插件来扩展Doris的功能。这个手册主要介绍如何开发、编译和部署 Frontend 端的插件。
+
+`fe_plugins` 目录是 FE 插件的根模块。这个根模块统一管理插件所需的依赖。添加一个新的插件，相当于在这个根模块添加一个子模块。
+
+## 插件组成
+
+一个FE的插件可以使一个**zip压缩包**或者是一个**目录**。其内容至少包含两个文件：`plugin.properties` 和 `.jar` 文件。`plugin.properties`用于描述插件信息。
+
+文件结构如下：
+
+```
+# plugin .zip
+auditodemo.zip:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+
+# plugin local directory
+auditodemo/:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+```
+
+`plugin.properties` 内容示例:
+
+```
+### required:
+#
+# the plugin name
+name = audit_plugin_demo
+#
+# the plugin type
+type = AUDIT
+#
+# simple summary of the plugin
+description = just for test
+#
+# Doris's version, like: 0.11.0
+version = 0.11.0
+
+### FE-Plugin optional:
+#
+# version of java the code is built against
+# use the command "java -version" value, like 1.8.0, 9.0.1, 13.0.4
+java.version = 1.8.31
+#
+# the name of the class to load, fully-qualified.
+classname = AuditPluginDemo
+
+### BE-Plugin optional:
+# the name of the so to load
+soName = example.so
+```
+
+## 编写一个插件
+
+插件的开发环境依赖Doris的开发编译环境。所以请先确保Doris的编译开发环境运行正常。
+
+### 创建一个模块
+
+我们可以通过以下命令在 `fe_plugins` 目录创建一个子模块用户实现创建和创建工程。其中 `doris-fe-test` 为插件名称。
+
+```
+mvn archetype: generate -DarchetypeCatalog = internal -DgroupId = org.apache -DartifactId = doris-fe-test -DinteractiveMode = false
+```
+
+这个命令会创建一个新的 maven 工程，并且自动向 `fe_plugins/pom.xml` 中添加一个子模块：
+
+```
+ .....
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <modules>
+ <module>auditdemo</module>
+ # new plugin module
+ <module>doris-fe-test</module>
+ </modules>
+ .....
+```
+
+新的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+ ---- main/java/org/apache/
+ ------- App.java # mvn auto generate, ignore
+ ---- test/java/org/apache
+```
+
+接下来我们在 `main` 目录下添加一个 `assembly` 目录来存放 `plugin.properties` 和 `zip.xml`。最终的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+---- main/
+------ assembly/
+-------- plugin.properties
+-------- zip.xml
+------ java/org/apache/
+--------App.java # mvn auto generate, ignore
+---- test/java/org/apache
+```
+
+### 添加 zip.xml
+
+`zip.xml` 用于描述最终生成的 zip 压缩包中的文件内容。（如 .jar file, plugin.properties 等等）
+
+```
+<assembly>
+ <id>plugin</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+ <!-IMPORTANT: must be false->
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <includes>
+ <include>*.jar</include>
+ </ ncludes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+
+ <fileSet>
+ <directory>src/main/assembly</directory>
+ <includes>
+ <include>plugin.properties</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+ </fileSets>
+</assembly>
+```
+
+### 更新 pom.xml
+
+接下来我们需要更新子模块的 `pom.xml` 文件，添加 doris-fe 依赖：
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>auditloader</artifactId>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe</artifactId>
+ </dependency>
+
+ <!-- other dependencies -->
+ <dependency>
+ ...
+ </dependency>
+ </dependencies>
+
+
+ <build>
+ <finalName>auditloader</finalName>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>2.4.1</version>
+ <configuration>
+ <appendAssemblyId>false</appendAssemblyId>
+ <descriptors>
+ <descriptor>src/main/assembly/zip.xml</descriptor>
+ </descriptors>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+```
+
+### 实现插件
+
+之后我们就可以开始愉快的进行插件功能的开发啦。插件需要实现 `Plugin` 接口。具体可以参阅 Doris 自带的 `auditdemo` 插件示例代码。
+
+### 编译
+
+在编译插件之前，需要先执行 `sh build.sh --fe` 进行 Doris FE 代码的编译，并确保编译成功。
+
+之后，执行 `sh build_plugin.sh` 编译所有插件。最终的产出会存放在 `fe_plugins/output` 目录中。
+
+或者也可以执行 `sh build_plugin.sh --p your_plugin_name` 来仅编译指定的插件。
Review comment:
OK
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399930246
##########
File path: fe/src/main/java/org/apache/doris/plugin/PluginMgr.java
##########
@@ -76,14 +87,21 @@ public PluginInfo installPlugin(InstallPluginStmt stmt) throws IOException, User
try {
PluginInfo info = pluginLoader.getPluginInfo();
- if (plugins[info.getTypeId()].putIfAbsent(info.getName(), pluginLoader) != null) {
- pluginLoader.uninstall();
+ if (plugins[info.getTypeId()].containsKey(info.getName())) {
throw new UserException("plugin " + info.getName() + " has already been installed.");
}
-
+
// install plugin
pluginLoader.install();
pluginLoader.setStatus(PluginStatus.INSTALLED);
+
+ if (plugins[info.getTypeId()].putIfAbsent(info.getName(), pluginLoader) != null) {
+ pluginLoader.uninstall();
Review comment:
We can't uninstall the plugin here, because it may cause the actual plugin to be uninstalled by mistake
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399934817
##########
File path: fe/src/main/java/org/apache/doris/plugin/PluginContext.java
##########
@@ -18,4 +18,14 @@
package org.apache.doris.plugin;
public class PluginContext {
+
+ private String pluginJarPath;
Review comment:
Maybe pluginPath is better ?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r400093100
##########
File path: fe/src/main/java/org/apache/doris/qe/AuditEventProcessor.java
##########
@@ -0,0 +1,118 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.apache.doris.qe;
+
+import org.apache.doris.plugin.AuditEvent;
+import org.apache.doris.plugin.AuditPlugin;
+import org.apache.doris.plugin.Plugin;
+import org.apache.doris.plugin.PluginInfo.PluginType;
+import org.apache.doris.plugin.PluginMgr;
+
+import com.google.common.collect.Queues;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import java.util.List;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+
+/*
+ * Class for processing all audit events.
+ * It will receive audit events and handle them to all AUDIT type plugins.
+ */
+public class AuditEventProcessor {
+ private static final Logger LOG = LogManager.getLogger(AuditEventProcessor.class);
+ private static final long UPDATE_PLUGIN_INTERVAL_MS = 60 * 1000; // 1min
+
+ private PluginMgr pluginMgr;
+
+ private List<Plugin> auditPlugins;
+ private long lastUpdateTime = 0;
+
+ private BlockingQueue<AuditEvent> eventQueue = Queues.newLinkedBlockingDeque(10000);
+ private Thread workerThread;
+
+ private volatile boolean isStopped = false;
+
+ public AuditEventProcessor(PluginMgr pluginMgr) {
+ this.pluginMgr = pluginMgr;
+ }
+
+ public void start() {
+ workerThread = new Thread(new Worker(), "AuditEventProcessor");
+ workerThread.start();
+ }
+
+ public void stop() {
+ isStopped = true;
+ if (workerThread != null) {
+ try {
+ workerThread.join();
+ } catch (InterruptedException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
Review comment:
I will add a LOG.warn here
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] wutiangan commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
wutiangan commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399958291
##########
File path: docs/documentation/cn/extending-doris/audit-plugin.md
##########
@@ -0,0 +1,108 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 审计日志插件
+
+Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一个可选插件。用户可以在运行是安装或卸载这个插件。
Review comment:
运行时
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] wutiangan commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
wutiangan commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399959281
##########
File path: docs/documentation/cn/extending-doris/audit-plugin.md
##########
@@ -0,0 +1,108 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 审计日志插件
+
+Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一个可选插件。用户可以在运行是安装或卸载这个插件。
+
+该插件可以将 FE 的审计日志定期的导入到指定 Doris 集群中，以方便用户通过 SQL 对审计日志进行查看和分析。
+
+## 编译、配置和部署
+
+### 编译
+
+在 Doris 代码目录下执行 `sh build_plugin.sh` 后，会在 `fe_plugins/output` 目录下得到 `auditloader.zip` 文件。
+
+### 配置
+
+解压 `auditloader.zip` 可以看到三个文件：
+
+```
+auditloader.jar
+plugin.properties
+plugin.conf
+```
+
+打开 `plugin.conf` 进行配置。配置项说明参见注释。
+
+配置完成后，重新将三个文件打包为 `auditloader.zip`.
+
+### 部署
+
+您可以将这个文件放置在一个 http 下载服务器上，或者拷贝到所有 FE 的指定目录下。这里我们使用后者。
+
+### 安装
+
+部署完成后，安装插件前，需要创建之前在 `plugin.conf` 中指定的审计数据库和表。其中建表语句如下：
+
+```
+create table doris_audit_tbl__
+(
+ query_id varchar(48) comment "Unique query id",
+ time datetime not null comment "Query start time",
+ client_ip varchar(32) comment "Client IP",
+ user varchar(64) comment "User name",
+ db varchar(96) comment "Database of this query",
+ state varchar(8) comment "Query result state. EOF, ERR, OK",
+ query_time bigint comment "Query execution time in millisecond",
+ scan_bytes bigint comment "Total scan bytes of this query",
+ scan_rows bigint comment "Total scan rows of this query",
+ return_rows bigint comment "Returned rows of this query",
+ stmt_id int comment "An incremental id of statement",
+ is_query tinyint comment "Is this statemt a query. 1 or 0",
+ frontend_ip varchar(32) comment "Frontend ip of executing this statement",
+ stmt varchar(2048) comment "The original statement, trimed if longer than 2048 bytes"
+)
+partition by range(time) ()
Review comment:
```suggestion
partition by range(time)
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r400093813
##########
File path: docs/documentation/cn/extending-doris/audit-plugin.md
##########
@@ -0,0 +1,108 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 审计日志插件
+
+Doris 的审计日志插件是在 FE 的插件框架基础上开发的。是一个可选插件。用户可以在运行是安装或卸载这个插件。
+
+该插件可以将 FE 的审计日志定期的导入到指定 Doris 集群中，以方便用户通过 SQL 对审计日志进行查看和分析。
+
+## 编译、配置和部署
+
+### 编译
+
+在 Doris 代码目录下执行 `sh build_plugin.sh` 后，会在 `fe_plugins/output` 目录下得到 `auditloader.zip` 文件。
+
+### 配置
+
+解压 `auditloader.zip` 可以看到三个文件：
+
+```
+auditloader.jar
+plugin.properties
+plugin.conf
+```
+
+打开 `plugin.conf` 进行配置。配置项说明参见注释。
+
+配置完成后，重新将三个文件打包为 `auditloader.zip`.
+
+### 部署
+
+您可以将这个文件放置在一个 http 下载服务器上，或者拷贝到所有 FE 的指定目录下。这里我们使用后者。
+
+### 安装
+
+部署完成后，安装插件前，需要创建之前在 `plugin.conf` 中指定的审计数据库和表。其中建表语句如下：
+
+```
+create table doris_audit_tbl__
+(
+ query_id varchar(48) comment "Unique query id",
+ time datetime not null comment "Query start time",
+ client_ip varchar(32) comment "Client IP",
+ user varchar(64) comment "User name",
+ db varchar(96) comment "Database of this query",
+ state varchar(8) comment "Query result state. EOF, ERR, OK",
+ query_time bigint comment "Query execution time in millisecond",
+ scan_bytes bigint comment "Total scan bytes of this query",
+ scan_rows bigint comment "Total scan rows of this query",
+ return_rows bigint comment "Returned rows of this query",
+ stmt_id int comment "An incremental id of statement",
+ is_query tinyint comment "Is this statemt a query. 1 or 0",
+ frontend_ip varchar(32) comment "Frontend ip of executing this statement",
+ stmt varchar(2048) comment "The original statement, trimed if longer than 2048 bytes"
+)
+partition by range(time) ()
Review comment:
This is not a typo, there IS a `()` here, which means no partitions created in this statement.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] morningman commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
morningman commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r400090687
##########
File path: docs/documentation/cn/extending-doris/plugin-development-manual.md
##########
@@ -0,0 +1,291 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 插件开发手册
+
+## 介绍
+
+Doris 支持动态加载插件。用户可以通过开发自己的插件来扩展Doris的功能。这个手册主要介绍如何开发、编译和部署 Frontend 端的插件。
+
+`fe_plugins` 目录是 FE 插件的根模块。这个根模块统一管理插件所需的依赖。添加一个新的插件，相当于在这个根模块添加一个子模块。
+
+## 插件组成
+
+一个FE的插件可以使一个**zip压缩包**或者是一个**目录**。其内容至少包含两个文件：`plugin.properties` 和 `.jar` 文件。`plugin.properties`用于描述插件信息。
+
+文件结构如下：
+
+```
+# plugin .zip
+auditodemo.zip:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+
+# plugin local directory
+auditodemo/:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+```
+
+`plugin.properties` 内容示例:
+
+```
+### required:
+#
+# the plugin name
+name = audit_plugin_demo
+#
+# the plugin type
+type = AUDIT
+#
+# simple summary of the plugin
+description = just for test
+#
+# Doris's version, like: 0.11.0
+version = 0.11.0
+
+### FE-Plugin optional:
+#
+# version of java the code is built against
+# use the command "java -version" value, like 1.8.0, 9.0.1, 13.0.4
+java.version = 1.8.31
+#
+# the name of the class to load, fully-qualified.
+classname = AuditPluginDemo
+
+### BE-Plugin optional:
+# the name of the so to load
+soName = example.so
+```
+
+## 编写一个插件
+
+插件的开发环境依赖Doris的开发编译环境。所以请先确保Doris的编译开发环境运行正常。
+
+### 创建一个模块
+
+我们可以通过以下命令在 `fe_plugins` 目录创建一个子模块用户实现创建和创建工程。其中 `doris-fe-test` 为插件名称。
+
+```
+mvn archetype: generate -DarchetypeCatalog = internal -DgroupId = org.apache -DartifactId = doris-fe-test -DinteractiveMode = false
+```
+
+这个命令会创建一个新的 maven 工程，并且自动向 `fe_plugins/pom.xml` 中添加一个子模块：
+
+```
+ .....
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <modules>
+ <module>auditdemo</module>
+ # new plugin module
+ <module>doris-fe-test</module>
+ </modules>
+ .....
+```
+
+新的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+ ---- main/java/org/apache/
+ ------- App.java # mvn auto generate, ignore
+ ---- test/java/org/apache
+```
+
+接下来我们在 `main` 目录下添加一个 `assembly` 目录来存放 `plugin.properties` 和 `zip.xml`。最终的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+---- main/
+------ assembly/
+-------- plugin.properties
+-------- zip.xml
+------ java/org/apache/
+--------App.java # mvn auto generate, ignore
+---- test/java/org/apache
+```
+
+### 添加 zip.xml
+
+`zip.xml` 用于描述最终生成的 zip 压缩包中的文件内容。（如 .jar file, plugin.properties 等等）
+
+```
+<assembly>
+ <id>plugin</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+ <!-IMPORTANT: must be false->
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <includes>
+ <include>*.jar</include>
+ </ ncludes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+
+ <fileSet>
+ <directory>src/main/assembly</directory>
+ <includes>
+ <include>plugin.properties</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+ </fileSets>
+</assembly>
+```
+
+### 更新 pom.xml
+
+接下来我们需要更新子模块的 `pom.xml` 文件，添加 doris-fe 依赖：
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>auditloader</artifactId>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe</artifactId>
+ </dependency>
+
+ <!-- other dependencies -->
+ <dependency>
+ ...
+ </dependency>
+ </dependencies>
+
+
+ <build>
+ <finalName>auditloader</finalName>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>2.4.1</version>
+ <configuration>
+ <appendAssemblyId>false</appendAssemblyId>
+ <descriptors>
+ <descriptor>src/main/assembly/zip.xml</descriptor>
+ </descriptors>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+```
+
+### 实现插件
+
+之后我们就可以开始愉快的进行插件功能的开发啦。插件需要实现 `Plugin` 接口。具体可以参阅 Doris 自带的 `auditdemo` 插件示例代码。
+
+### 编译
+
+在编译插件之前，需要先执行 `sh build.sh --fe` 进行 Doris FE 代码的编译，并确保编译成功。
+
+之后，执行 `sh build_plugin.sh` 编译所有插件。最终的产出会存放在 `fe_plugins/output` 目录中。
+
+或者也可以执行 `sh build_plugin.sh --p your_plugin_name` 来仅编译指定的插件。
+
+### 另一种开发方式
+
+您可以直接通过修改自带的 `auditdemo` 插件示例代码进行开发。
+
+## 部署
+
+插件可以通过以下三种方式部署。
+
+* 将 `.zip` 文件放在 Http 或 Https 服务器上。如：`http://xxx.xxxxxx.com/data/plugin.zip`, Doris 会下载这个文件。
+* 本地 `.zip` 文件。 如：`/home/work/data/plugin.zip`。需要在所有 FE 和 BE 节点部署。
+* 本都目录。如：`/home/work/data/plugin/`。这个相当于 `.zip` 文件解压后的目录。需要在所有 FE 和 BE 节点部署。
Review comment:
OK
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] Seaven commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
Seaven commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399941119
##########
File path: fe/src/main/java/org/apache/doris/qe/AuditEventProcessor.java
##########
@@ -0,0 +1,118 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package org.apache.doris.qe;
+
+import org.apache.doris.plugin.AuditEvent;
+import org.apache.doris.plugin.AuditPlugin;
+import org.apache.doris.plugin.Plugin;
+import org.apache.doris.plugin.PluginInfo.PluginType;
+import org.apache.doris.plugin.PluginMgr;
+
+import com.google.common.collect.Queues;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+
+import java.util.List;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.TimeUnit;
+
+/*
+ * Class for processing all audit events.
+ * It will receive audit events and handle them to all AUDIT type plugins.
+ */
+public class AuditEventProcessor {
+ private static final Logger LOG = LogManager.getLogger(AuditEventProcessor.class);
+ private static final long UPDATE_PLUGIN_INTERVAL_MS = 60 * 1000; // 1min
+
+ private PluginMgr pluginMgr;
+
+ private List<Plugin> auditPlugins;
+ private long lastUpdateTime = 0;
+
+ private BlockingQueue<AuditEvent> eventQueue = Queues.newLinkedBlockingDeque(10000);
+ private Thread workerThread;
+
+ private volatile boolean isStopped = false;
+
+ public AuditEventProcessor(PluginMgr pluginMgr) {
+ this.pluginMgr = pluginMgr;
+ }
+
+ public void start() {
+ workerThread = new Thread(new Worker(), "AuditEventProcessor");
+ workerThread.start();
+ }
+
+ public void stop() {
+ isStopped = true;
+ if (workerThread != null) {
+ try {
+ workerThread.join();
+ } catch (InterruptedException e) {
+ // TODO Auto-generated catch block
+ e.printStackTrace();
Review comment:
LOG.error ?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] chaoyli merged pull request #3219: [Plugin]
Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
chaoyli merged pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org
[GitHub] [incubator-doris] wutiangan commented on a change in pull request
#3219: [Plugin] Making FE audit module pluggable
Posted by GitBox <gi...@apache.org>.
wutiangan commented on a change in pull request #3219: [Plugin] Making FE audit module pluggable
URL: https://github.com/apache/incubator-doris/pull/3219#discussion_r399961183
##########
File path: docs/documentation/cn/extending-doris/plugin-development-manual.md
##########
@@ -0,0 +1,291 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+# 插件开发手册
+
+## 介绍
+
+Doris 支持动态加载插件。用户可以通过开发自己的插件来扩展Doris的功能。这个手册主要介绍如何开发、编译和部署 Frontend 端的插件。
+
+`fe_plugins` 目录是 FE 插件的根模块。这个根模块统一管理插件所需的依赖。添加一个新的插件，相当于在这个根模块添加一个子模块。
+
+## 插件组成
+
+一个FE的插件可以使一个**zip压缩包**或者是一个**目录**。其内容至少包含两个文件：`plugin.properties` 和 `.jar` 文件。`plugin.properties`用于描述插件信息。
+
+文件结构如下：
+
+```
+# plugin .zip
+auditodemo.zip:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+
+# plugin local directory
+auditodemo/:
+ -plugin.properties
+ -auditdemo.jar
+ -xxx.config
+ -data/
+ -test_data/
+```
+
+`plugin.properties` 内容示例:
+
+```
+### required:
+#
+# the plugin name
+name = audit_plugin_demo
+#
+# the plugin type
+type = AUDIT
+#
+# simple summary of the plugin
+description = just for test
+#
+# Doris's version, like: 0.11.0
+version = 0.11.0
+
+### FE-Plugin optional:
+#
+# version of java the code is built against
+# use the command "java -version" value, like 1.8.0, 9.0.1, 13.0.4
+java.version = 1.8.31
+#
+# the name of the class to load, fully-qualified.
+classname = AuditPluginDemo
+
+### BE-Plugin optional:
+# the name of the so to load
+soName = example.so
+```
+
+## 编写一个插件
+
+插件的开发环境依赖Doris的开发编译环境。所以请先确保Doris的编译开发环境运行正常。
+
+### 创建一个模块
+
+我们可以通过以下命令在 `fe_plugins` 目录创建一个子模块用户实现创建和创建工程。其中 `doris-fe-test` 为插件名称。
+
+```
+mvn archetype: generate -DarchetypeCatalog = internal -DgroupId = org.apache -DartifactId = doris-fe-test -DinteractiveMode = false
+```
+
+这个命令会创建一个新的 maven 工程，并且自动向 `fe_plugins/pom.xml` 中添加一个子模块：
+
+```
+ .....
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <packaging>pom</packaging>
+ <version>1.0-SNAPSHOT</version>
+ <modules>
+ <module>auditdemo</module>
+ # new plugin module
+ <module>doris-fe-test</module>
+ </modules>
+ .....
+```
+
+新的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+ ---- main/java/org/apache/
+ ------- App.java # mvn auto generate, ignore
+ ---- test/java/org/apache
+```
+
+接下来我们在 `main` 目录下添加一个 `assembly` 目录来存放 `plugin.properties` 和 `zip.xml`。最终的工程目录结构如下：
+
+```
+-doris-fe-test/
+-pom.xml
+-src/
+---- main/
+------ assembly/
+-------- plugin.properties
+-------- zip.xml
+------ java/org/apache/
+--------App.java # mvn auto generate, ignore
+---- test/java/org/apache
+```
+
+### 添加 zip.xml
+
+`zip.xml` 用于描述最终生成的 zip 压缩包中的文件内容。（如 .jar file, plugin.properties 等等）
+
+```
+<assembly>
+ <id>plugin</id>
+ <formats>
+ <format>zip</format>
+ </formats>
+ <!-IMPORTANT: must be false->
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>target</directory>
+ <includes>
+ <include>*.jar</include>
+ </ ncludes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+
+ <fileSet>
+ <directory>src/main/assembly</directory>
+ <includes>
+ <include>plugin.properties</include>
+ </includes>
+ <outputDirectory>/</outputDirectory>
+ </fileSet>
+ </fileSets>
+</assembly>
+```
+
+### 更新 pom.xml
+
+接下来我们需要更新子模块的 `pom.xml` 文件，添加 doris-fe 依赖：
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://maven.apache.org/POM/4.0.0"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe-plugins</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>auditloader</artifactId>
+ <packaging>jar</packaging>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache</groupId>
+ <artifactId>doris-fe</artifactId>
+ </dependency>
+
+ <!-- other dependencies -->
+ <dependency>
+ ...
+ </dependency>
+ </dependencies>
+
+
+ <build>
+ <finalName>auditloader</finalName>
+ <plugins>
+ <plugin>
+ <artifactId>maven-assembly-plugin</artifactId>
+ <version>2.4.1</version>
+ <configuration>
+ <appendAssemblyId>false</appendAssemblyId>
+ <descriptors>
+ <descriptor>src/main/assembly/zip.xml</descriptor>
+ </descriptors>
+ </configuration>
+ <executions>
+ <execution>
+ <id>make-assembly</id>
+ <phase>package</phase>
+ <goals>
+ <goal>single</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+```
+
+### 实现插件
+
+之后我们就可以开始愉快的进行插件功能的开发啦。插件需要实现 `Plugin` 接口。具体可以参阅 Doris 自带的 `auditdemo` 插件示例代码。
+
+### 编译
+
+在编译插件之前，需要先执行 `sh build.sh --fe` 进行 Doris FE 代码的编译，并确保编译成功。
+
+之后，执行 `sh build_plugin.sh` 编译所有插件。最终的产出会存放在 `fe_plugins/output` 目录中。
+
+或者也可以执行 `sh build_plugin.sh --p your_plugin_name` 来仅编译指定的插件。
Review comment:
一般命令都是-p(一个-，并且p是单个字母)或者--plugin-name（两个--，并且plugin-name is full name）
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org