This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 412b09c [INLONG-2361] add the guide for configure audit (#274)
412b09c is described below
commit 412b09cc7c004a70fdf7fcaaf6e745e3170aff81
Author: dockerzhang <[email protected]>
AuthorDate: Sun Feb 6 18:22:07 2022 +0800
[INLONG-2361] add the guide for configure audit (#274)
Co-authored-by: dockerzhang(张超) <[email protected]>
---
docs/deployment/standalone.md | 57 ++------
docs/modules/agent/quick_start.md | 11 +-
docs/modules/audit/quick_start.md | 152 +++------------------
docs/modules/dataproxy/quick_start.md | 8 +-
docs/modules/manager/quick_start.md | 6 +-
docs/modules/sort/quick_start.md | 3 +-
docs/quick_start/how_to_build.md | 1 +
.../current/deployment/standalone.md | 58 +-------
.../current/modules/agent/quick_start.md | 11 +-
.../current/modules/audit/quick_start.md | 150 +++-----------------
.../current/modules/dataproxy/quick_start.md | 8 +-
.../current/modules/manager/quick_start.md | 6 +-
.../current/modules/sort/quick_start.md | 3 +-
.../current/quick_start/how_to_build.md | 1 +
14 files changed, 82 insertions(+), 393 deletions(-)
diff --git a/docs/deployment/standalone.md b/docs/deployment/standalone.md
index 40b811a..5e6a1d4 100644
--- a/docs/deployment/standalone.md
+++ b/docs/deployment/standalone.md
@@ -12,45 +12,8 @@ sidebar_position: 1
## Configure
-Add relevant global configuration parameters to the conf file in
conf/standalone.conf:
-
-```ini
-# Selection of message queue source: tubemq or pulsar
-source_type=tubemq
-# Selection of sort sink: hive or clickhouse
-sink_type=hive
-# MySQL service, IP, port, user and password
-spring_datasource_hostname=MYSQL_HOSTNAME
-spring_datasource_port=MYSQL_PORT
-spring_datasource_username=MYSQL_USERNAME
-spring_datasource_password=MYSQL_PASSWORD
-###############################################################################
-# zookeeper address
-zkServerAddr=127.0.0.1:2181
-###############################################################################
-# tubemq (Optional)
-tubemqMaster_hostName=YOU_LOCAL_IP
-tubemqBroker_hostName=YOU_LOCAL_IP
-TUBE_MANAGER_IP=YOU_LOCAL_IP
-metaDataPath=/stage/meta_data
-primaryPath=/stage/msg_data
-###############################################################################
-# pulsar (Optional)
-###############################################################################
-# Service address of pulsar (Required)
-pulsar_adminUrl=http://pulsar_ip:web_port
-# Pulsar broker address（Required）
-pulsar_serviceUrl=pulsar://pulsar_ip:api_port
-# Default tenant of Pulsar
-pulsar_defaultTenant=public
-###############################################################################
-# local_ip(Required)
-###############################################################################
-local_ip=YOU_LOCAL_IP
-###############################################################################
-```
-
- Initialization inlong global configuration parameters of each component:
+Add relevant global configuration parameters to the conf file in
conf/standalone.conf,
+and initialize inlong global configuration parameters of each component:
```shell
bin/init-config.sh
@@ -70,7 +33,7 @@ bin/inlong-daemon.sh stop standalone
## Check
-1.After the startup script is completed, JPS checks whether there are the
following processes:
+After the startup script is completed, JPS checks whether there are the
following processes:
```
1393 QuorumPeerMain
@@ -84,13 +47,9 @@ bin/inlong-daemon.sh stop standalone
23149 BrokerStartup
```
-2.If you use tubemq as the message middleware and visit the web page provided
by it, you can get the information shown in the figure:
-
-
+After all component run successfully, you can access `http://localhost` with
default account:
-
-3.Whether the inlong web page can be accessed normally:
-
-
-
-If there is no problem, the inlong standalone deployment is successful.
+```shell
+User: admin
+Password: inlong
+```
\ No newline at end of file
diff --git a/docs/modules/agent/quick_start.md
b/docs/modules/agent/quick_start.md
index c8b1556..f3a2d5a 100644
--- a/docs/modules/agent/quick_start.md
+++ b/docs/modules/agent/quick_start.md
@@ -11,14 +11,11 @@ cd inlong-agent
Online operation needs to pull the configuration from inlong-manager, the
configuration conf/agent.properties is as follows:
```ini
-# whether enable http service
-agent.http.enable=true
-# http default port
-agent.http.port=Available ports
-agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher
(the class name for fetch tasks, default ManagerFetcher）
agent.local.ip=Write local ip
-agent.manager.vip.http.host=manager web host
-agent.manager.vip.http.port=manager web port
+agent.manager.vip.http.host=manager host
+agent.manager.vip.http.port=manager port
+# audit proxy address
+audit.proxys=127.0.0.1:10081
```
## Start
diff --git a/docs/modules/audit/quick_start.md
b/docs/modules/audit/quick_start.md
index 8df5fee..7e669ae 100644
--- a/docs/modules/audit/quick_start.md
+++ b/docs/modules/audit/quick_start.md
@@ -2,160 +2,46 @@
title: Deployment
---
-## audit-source Deployment
-### Configure
-The configuration file is `inlong-audit/audit-source/conf/audit.conf`.
-
-#### total configuration
-```Shell
-agent1.sources = tcp-source
-agent1.channels = ch-msg1 ch-msg2
-agent1.sinks = pulsar-sink-msg1 pulsar-sink-msg2
-```
+All deploying files at `inlong-audit` directory, if you use MySQL to store
audit data, you need to first create the database through
`sql/apache_inlong_audit.sql`.
-#### sources configuration
+## Audit Proxy
+### Configure Pulsar
+The configuration file is `conf/audit.conf`.
```Shell
-agent1.sources.tcp-source.channels = ch-msg1 ch-msg2
-agent1.sources.tcp-source.type = org.apache.inlong.audit.source.SimpleTcpSource
-agent1.sources.tcp-source.msg-factory-name =
org.apache.inlong.audit.source.ServerMessageFactory
agent1.sources.tcp-source.host = 0.0.0.0
agent1.sources.tcp-source.port = 46801
-agent1.sources.tcp-source.max-msg-length = 524288
-agent1.sources.tcp-source.connections = 30000
-agent1.sources.tcp-source.max-threads = 64
-agent1.sources.tcp-source.receiveBufferSize = 1048576
-agent1.sources.tcp-source.sendBufferSize = 1048576
-agent1.sources.tcp-source.custom-cp = true
-agent1.sources.tcp-source.selector.type =
org.apache.inlong.audit.channel.FailoverChannelSelector
-agent1.sources.tcp-source.selector.master = ch-msg1
-agent1.sources.tcp-source.metric-recovery-path=/data/tdbank/audit/flume/recovery
-agent1.sources.tcp-source.metric-agent-port=8003
-agent1.sources.tcp-source.metric-cache-size=1000000
-agent1.sources.tcp-source.set=10
-```
-
-#### channels configuration
-```Shell
-agent1.channels.ch-msg1.type = memory
-agent1.channels.ch-msg1.capacity = 10000
-agent1.channels.ch-msg1.keep-alive = 0
-agent1.channels.ch-msg1.transactionCapacity = 200
-agent1.channels.ch-msg2.type = file
-agent1.channels.ch-msg2.capacity = 100000000
-agent1.channels.ch-msg2.maxFileSize = 1073741824
-agent1.channels.ch-msg2.minimumRequiredSpace = 1073741824
-agent1.channels.ch-msg2.checkpointDir = /data/tdbank/audit/file/ch-msg5/check
-agent1.channels.ch-msg2.dataDirs = /data/tdbank/audit/file/ch-msg5/data
-agent1.channels.ch-msg2.fsyncPerTransaction = false
-agent1.channels.ch-msg2.fsyncInterval = 10
+agent1.sinks.pulsar-sink-msg1.pulsar_server_url= pulsar://PULSAR_BROKER_LIST
+agent1.sinks.pulsar-sink-msg1.topic = persistent://public/default/inlong-audit
+agent1.sinks.pulsar-sink-msg2.pulsar_server_url = pulsar://PULSAR_BROKER_LIST
+agent1.sinks.pulsar-sink-msg2.topic = persistent://public/default/inlong-audit
```
-#### sinks configuration
+### Start
```Shell
-agent1.sinks.pulsar-sink-msg1.channel = ch-msg1
-agent1.sinks.pulsar-sink-msg1.type = org.apache.inlong.audit.sink.PulsarSink
-agent1.sinks.pulsar-sink-msg1.pulsar_server_url = pulsar://PULSAR_BROKER_LIST
-agent1.sinks.pulsar-sink-msg1.topic = persistent://PULSAR_TOPIC
-agent1.sinks.pulsar-sink-msg1.send_timeout_ms = 30000
-agent1.sinks.pulsar-sink-msg1.client_op_timeout_second = 30000
-agent1.sinks.pulsar-sink-msg1.stat_interval_sec = 60
-agent1.sinks.pulsar-sink-msg1.enable_batch = true
-agent1.sinks.pulsar-sink-msg1.block_if_queue_full = true
-agent1.sinks.pulsar-sink-msg1.max_pending_messages = 10000
-agent1.sinks.pulsar-sink-msg1.max_batching_messages = 1000
-agent1.sinks.pulsar-sink-msg1.retry_interval_when_send_error_ms = 30000
-agent1.sinks.pulsar-sink-msg1.thread_num = 8
-agent1.sinks.pulsar-sink-msg1.log_every_n_events = 100000
-agent1.sinks.pulsar-sink-msg1.disk_io_rate_per_sec= 20000000
+sh ./bin/proxy-start.sh
```
-### run
-The startup script file `inlong-audit/audit-source/bin/start.sh`
-```Shell
-sh bin/start.sh
-```
-
-### stop
-The stop script file is `inlong-audit/audit-source/bin/stop.sh`
-```Shell
-sh bin/stop.sh
-```
-
-
-## audit-store Deployment
+## Audit Store
### Configure
-The configuration file is
`inlong-audit/audit-store/conf/aapplication.properties`.
+The configuration file is `conf/application.properties`.
-#### Configure Store Modle
```Shell
# store.server: mysql / elasticsearch
audit.config.store.mode=mysql
-```
-
-#### onfigure Message Queue
-```Shell
+# audit pulsar topic
audit.pulsar.server.url=pulsar://127.0.0.1:6650
-audit.pulsar.topic=persistent://public/default/audit
+audit.pulsar.topic=persistent://public/default/inlong-audit
audit.pulsar.consumer.sub.name=sub-audit
-```
-
-#### config server
-```Shell
-audit.config.file.check.enable=false
-audit.config.manager.server.url=http://127.0.0.1:8000
-```
-
-#### Configure MySQL(optional)
-```Shell
-spring.datasource.driver-class-name=com.mysql.jdbc.Driver
-spring.datasource.name=druidDataSource
-spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
-spring.datasource.druid.driver-class-name= com.mysql.cj.jdbc.Driver
+# mysql
spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL
spring.datasource.druid.username=root
spring.datasource.druid.password=inlong
-spring.datasource.druid.filters=stat,log4j,config
-spring.datasource.druid.max-active=100
-spring.datasource.druid.initial-size=1
-spring.datasource.druid.max-wait=60000
-spring.datasource.druid.min-idle=1
-spring.datasource.druid.time-between-eviction-runs-millis=60000
-spring.datasource.druid.min-evictable-idle-time-millis=300000
-spring.datasource.druid.validation-query=select 'x'
-spring.datasource.druid.test-while-idle=true
-spring.datasource.druid.test-on-borrow=false
-spring.datasource.druid.test-on-return=false
-spring.datasource.druid.pool-prepared-statements=true
-spring.datasource.druid.filter.wall.config.multi-statement-allow=true
-spring.datasource.druid.max-open-prepared-statements=50
-spring.datasource.druid.max-pool-prepared-statement-per-connection-size=20
-mybatis.mapper-locations=classpath*:mapper/*.xml
-mybatis.type-aliases-package=org.apache.inlong.store.db.entities
-```
-
-#### Configure Elasticsearch(optional)
-```Shell
-elasticsearch.host=127.0.0.1
-elasticsearch.port=9200
-elasticsearch.username=elastic
-elasticsearch.password=inlong123INLONG
-elasticsearch.shardsNum=5
-elasticsearch.replicaNum=1
-elasticsearch.indexDeleteDay=5
-elasticsearch.enableCustomDocId=true
-elasticsearch.bulkInterval=10
-elasticsearch.bulkThreshold=10
-elasticsearch.auditIdSet=1,2,3,4,5,6,7,8
```
-### run
-The startup script file `inlong-audit/audit-store/bin/start.sh`
+### Start
+The startup script file `./bin/store-start.sh`
```Shell
-sh bin/start.sh
+sh ./bin/store-start.sh
```
-### stop
-The stop script file `inlong-audit/audit-store/bin/stop.sh`
-```Shell
-sh bin/stop.sh
-```
\ No newline at end of file
+The default listen port is `46801`.
\ No newline at end of file
diff --git a/docs/modules/dataproxy/quick_start.md
b/docs/modules/dataproxy/quick_start.md
index ed9b6b2..ef313e3 100644
--- a/docs/modules/dataproxy/quick_start.md
+++ b/docs/modules/dataproxy/quick_start.md
@@ -12,7 +12,7 @@ All deploying files at `inlong-dataproxy` directory.
$ sed -i 's/TUBE_LIST/tubemq_master_list/g' conf/flume.conf
```
-- If you use Apache Pulsar, replace `pulsar_server_url_list` in
`conf/flume-mulit-pulsar-demo.conf` and overwrite `conf/flume.conf`.
+- If you use Apache Pulsar, replace `pulsar_server_url_list` in
`conf/flume-mulit-pulsar-tcp-example.conf` and overwrite `conf/flume.conf`.
notice that conf/flume.conf FLUME_HOME is proxy the directory for proxy inner
data
@@ -20,8 +20,10 @@ notice that conf/flume.conf FLUME_HOME is proxy the
directory for proxy inner da
configuration file: `conf/common.properties`:
```
-# manager web
-manager_hosts=ip:port
+# manager address
+manager_hosts=127.0.0.1:8083
+# audit proxy address
+audit.proxys=127.0.0.1:10081
```
## run
diff --git a/docs/modules/manager/quick_start.md
b/docs/modules/manager/quick_start.md
index b7082c4..2b0a99d 100644
--- a/docs/modules/manager/quick_start.md
+++ b/docs/modules/manager/quick_start.md
@@ -34,9 +34,9 @@ The dev configuration is specified above, then modify the
`conf/application-dev.
1) Modify the database URL, username and password:
```properties
-
spring.datasource.jdbc-url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
- spring.datasource.username=DB_USER
- spring.datasource.password=DB_PASSWD
+
spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
+ spring.datasource.druid.username=root
+ spring.datasource.druid.password=inlong
```
2) Configure the Message Queue Service, you could choose InLong TubeMQ or
Apache Pulsar:
diff --git a/docs/modules/sort/quick_start.md b/docs/modules/sort/quick_start.md
index 6941f65..b4c1328 100644
--- a/docs/modules/sort/quick_start.md
+++ b/docs/modules/sort/quick_start.md
@@ -21,7 +21,7 @@ Example：
```
./bin/flink run -c org.apache.inlong.sort.flink.Entrance
inlong-sort/sort-core-[version].jar \
--cluster-id inlong_app --zookeeper.quorum 127.0.0.1:2181
--zookeeper.path.root /inlong_sort \
---source.type tubemq --sink.type hive
+--source.type tubemq --metrics.audit.proxy.hosts 127.0.0.1:10081 --sink.type
hive
```
Notice：
@@ -35,6 +35,7 @@ Notice：
- `--zookeeper.quorum` zk quorum, same as the configuration of
`cluster.zk.url` in inlong-manager
- `--zookeeper.path.root` zk root path, same as the configuration of
`cluster.zk.root` in inlong-manager
- `--source.type` source of the application, currently "tubemq" and "pulsar"
are supported
+- `--metrics.audit.proxy.hosts` audit proxy host address for reporting audit
metrics
- `--sink.type` sink of the application, currently "clickhouse" and "hive" are
supported
**Example**
diff --git a/docs/quick_start/how_to_build.md b/docs/quick_start/how_to_build.md
index 7ce1307..8e5313e 100644
--- a/docs/quick_start/how_to_build.md
+++ b/docs/quick_start/how_to_build.md
@@ -20,6 +20,7 @@ $ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8
mvn clean install
after compile successfully, you could find distribution file at
`inlong-distribution/target` with `tar.gz` format, it includes following files:
```
inlong-agent
+inlong-audit
inlong-dataproxy
inlong-manager
inlong-sort
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
index 7829e14..e9dd852 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/deployment/standalone.md
@@ -13,45 +13,7 @@ sidebar_position: 1
## 配置
-在conf/standalone.conf文件中添加相关全局配置参数：
-
-```ini
-# Selection of message queue source: tubemq or pulsar
-source_type=tubemq
-# Selection of sort sink: hive or clickhouse
-sink_type=hive
-# MySQL service, IP, port, user and password
-spring_datasource_hostname=MYSQL_HOSTNAME
-spring_datasource_port=MYSQL_PORT
-spring_datasource_username=MYSQL_USERNAME
-spring_datasource_password=MYSQL_PASSWORD
-###############################################################################
-# zookeeper address
-zkServerAddr=127.0.0.1:2181
-###############################################################################
-# tubemq (Optional)
-tubemqMaster_hostName=YOU_LOCAL_IP
-tubemqBroker_hostName=YOU_LOCAL_IP
-TUBE_MANAGER_IP=YOU_LOCAL_IP
-metaDataPath=/stage/meta_data
-primaryPath=/stage/msg_data
-###############################################################################
-# pulsar (Optional)
-###############################################################################
-# Service address of pulsar (Required)
-pulsar_adminUrl=http://pulsar_ip:web_port
-# Pulsar broker address（Required）
-pulsar_serviceUrl=pulsar://pulsar_ip:api_port
-# Default tenant of Pulsar
-pulsar_defaultTenant=public
-###############################################################################
-# local_ip(Required)
-###############################################################################
-local_ip=YOU_LOCAL_IP
-###############################################################################
-```
-
-一键初始化inlong各组件全局配置参数
+在conf/standalone.conf文件中添加相关全局配置参数，然后一键初始化inlong各组件全局配置参数
```shell
bin/init-config.sh
@@ -71,7 +33,7 @@ bin/inlong-daemon.sh stop standalone
## 检查
-1.启动脚本完成后，jps查看是否都有如下进程：
+启动脚本完成后，jps查看是否都有如下进程：
```
1393 QuorumPeerMain
@@ -85,16 +47,10 @@ bin/inlong-daemon.sh stop standalone
23149 BrokerStartup
```
-2.如果用tubemq作为消息中间件，访问其提供的web页面，可以得到如图所示信息 ：
-
-
-3.是否能正常访问inlong web页面：
-
-
-
-都没问题的话，至此inlong单机部署成功。
-
-
-
+当所有组件都成功启动后，可以访问`http://localhost`，并使用以下默认账号登录:
+```
+User: admin
+Password: inlong
+```
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
index 7eb4676..e104818 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/agent/quick_start.md
@@ -11,14 +11,11 @@ cd inlong-agent
线上运行需要从inlong-manager拉取配置，配置conf/agent.properties如下：
```ini
-# whether enable http service
-agent.http.enable=true
-# http default port
-agent.http.port=可用端口
-agent.fetcher.classname=org.apache.inlong.agent.plugin.fetcher.ManagerFetcher
(设置任务获取的类名，默认为ManagerFetcher）
agent.local.ip=写入本机ip
-agent.manager.vip.http.host=manager web host
-agent.manager.vip.http.port=manager web port
+agent.manager.vip.http.host=manager host
+agent.manager.vip.http.port=manager port
+# audit proxy 地址
+audit.proxys=127.0.0.1:10081
```
## 启动
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
index 2c14e3c..59a25e6 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/quick_start.md
@@ -2,160 +2,46 @@
title: 安装部署
---
-## audit-source安装与部署
-### 配置
-配置文件`inlong-audit/audit-source/conf/audit.conf`.
-
-#### 总配置
-```Shell
-agent1.sources = tcp-source
-agent1.channels = ch-msg1 ch-msg2
-agent1.sinks = pulsar-sink-msg1 pulsar-sink-msg2
-```
+所有的安装文件都在 `inlong-audit` 目录下，如果使用 MySQL
存储审计数据，需要先通过`sql/apache_inlong_audit.sql`出生数据库。
-#### sources参数配置
+## Audit Proxy
+### 配置 Pulsar
+配置文件 `conf/audit-proxy.conf`.
```Shell
-agent1.sources.tcp-source.channels = ch-msg1 ch-msg2
-agent1.sources.tcp-source.type = org.apache.inlong.audit.source.SimpleTcpSource
-agent1.sources.tcp-source.msg-factory-name =
org.apache.inlong.audit.source.ServerMessageFactory
agent1.sources.tcp-source.host = 0.0.0.0
-agent1.sources.tcp-source.port = 46801
-agent1.sources.tcp-source.max-msg-length = 524288
-agent1.sources.tcp-source.connections = 30000
-agent1.sources.tcp-source.max-threads = 64
-agent1.sources.tcp-source.receiveBufferSize = 1048576
-agent1.sources.tcp-source.sendBufferSize = 1048576
-agent1.sources.tcp-source.custom-cp = true
-agent1.sources.tcp-source.selector.type =
org.apache.inlong.audit.channel.FailoverChannelSelector
-agent1.sources.tcp-source.selector.master = ch-msg1
-agent1.sources.tcp-source.metric-recovery-path=/data/tdbank/audit/flume/recovery
-agent1.sources.tcp-source.metric-agent-port=8003
-agent1.sources.tcp-source.metric-cache-size=1000000
-agent1.sources.tcp-source.set=10
-```
-
-#### channels参数配置
-```Shell
-agent1.channels.ch-msg1.type = memory
-agent1.channels.ch-msg1.capacity = 10000
-agent1.channels.ch-msg1.keep-alive = 0
-agent1.channels.ch-msg1.transactionCapacity = 200
-agent1.channels.ch-msg2.type = file
-agent1.channels.ch-msg2.capacity = 100000000
-agent1.channels.ch-msg2.maxFileSize = 1073741824
-agent1.channels.ch-msg2.minimumRequiredSpace = 1073741824
-agent1.channels.ch-msg2.checkpointDir = /data/tdbank/audit/file/ch-msg5/check
-agent1.channels.ch-msg2.dataDirs = /data/tdbank/audit/file/ch-msg5/data
-agent1.channels.ch-msg2.fsyncPerTransaction = false
-agent1.channels.ch-msg2.fsyncInterval = 10
-```
-
-#### sinks参数配置
-```Shell
-agent1.sinks.pulsar-sink-msg1.channel = ch-msg1
-agent1.sinks.pulsar-sink-msg1.type = org.apache.inlong.audit.sink.PulsarSink
-agent1.sinks.pulsar-sink-msg1.pulsar_server_url = pulsar://PULSAR_BROKER_LIST
-agent1.sinks.pulsar-sink-msg1.topic = persistent://PULSAR_TOPIC
-agent1.sinks.pulsar-sink-msg1.send_timeout_ms = 30000
-agent1.sinks.pulsar-sink-msg1.client_op_timeout_second = 30000
-agent1.sinks.pulsar-sink-msg1.stat_interval_sec = 60
-agent1.sinks.pulsar-sink-msg1.enable_batch = true
-agent1.sinks.pulsar-sink-msg1.block_if_queue_full = true
-agent1.sinks.pulsar-sink-msg1.max_pending_messages = 10000
-agent1.sinks.pulsar-sink-msg1.max_batching_messages = 1000
-agent1.sinks.pulsar-sink-msg1.retry_interval_when_send_error_ms = 30000
-agent1.sinks.pulsar-sink-msg1.thread_num = 8
-agent1.sinks.pulsar-sink-msg1.log_every_n_events = 100000
-agent1.sinks.pulsar-sink-msg1.disk_io_rate_per_sec= 20000000
+agent1.sources.tcp-source.port = 10081
+agent1.sinks.pulsar-sink-msg1.pulsar_server_url= pulsar://PULSAR_BROKER_LIST
+agent1.sinks.pulsar-sink-msg1.topic = persistent://public/default/inlong-audit
+agent1.sinks.pulsar-sink-msg2.pulsar_server_url = pulsar://PULSAR_BROKER_LIST
+agent1.sinks.pulsar-sink-msg2.topic = persistent://public/default/inlong-audit
```
### 启动
-启动脚本 `inlong-audit/audit-source/bin/start.sh`
```Shell
-sh bin/start.sh
+sh ./bin/proxy-start.sh
```
-### 停止
-停止脚本 `inlong-audit/audit-source/bin/stop.sh`
-```Shell
-sh bin/stop.sh
-```
-
-
-## audit-store安装与部署
+## Audit Store
### 配置
-配置文件 `inlong-audit/audit-store/conf/aapplication.properties`.
+配置文件 `conf/application.properties`.
-#### 配置存储类型
```Shell
# store.server: mysql / elasticsearch
audit.config.store.mode=mysql
-```
-
-#### 配置消息队列
-```Shell
+# audit pulsar topic
audit.pulsar.server.url=pulsar://127.0.0.1:6650
-audit.pulsar.topic=persistent://public/default/audit
+audit.pulsar.topic=persistent://public/default/inlong-audit
audit.pulsar.consumer.sub.name=sub-audit
-```
-
-#### 配置服务
-```Shell
-audit.config.file.check.enable=false
-audit.config.manager.server.url=http://127.0.0.1:8000
-```
-
-#### 配置MySQL(可选)
-```Shell
-spring.datasource.driver-class-name=com.mysql.jdbc.Driver
-spring.datasource.name=druidDataSource
-spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
-spring.datasource.druid.driver-class-name= com.mysql.cj.jdbc.Driver
+# mysql
spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL
spring.datasource.druid.username=root
spring.datasource.druid.password=inlong
-spring.datasource.druid.filters=stat,log4j,config
-spring.datasource.druid.max-active=100
-spring.datasource.druid.initial-size=1
-spring.datasource.druid.max-wait=60000
-spring.datasource.druid.min-idle=1
-spring.datasource.druid.time-between-eviction-runs-millis=60000
-spring.datasource.druid.min-evictable-idle-time-millis=300000
-spring.datasource.druid.validation-query=select 'x'
-spring.datasource.druid.test-while-idle=true
-spring.datasource.druid.test-on-borrow=false
-spring.datasource.druid.test-on-return=false
-spring.datasource.druid.pool-prepared-statements=true
-spring.datasource.druid.filter.wall.config.multi-statement-allow=true
-spring.datasource.druid.max-open-prepared-statements=50
-spring.datasource.druid.max-pool-prepared-statement-per-connection-size=20
-mybatis.mapper-locations=classpath*:mapper/*.xml
-mybatis.type-aliases-package=org.apache.inlong.store.db.entities
-```
-
-#### 配置ES(可选)
-```Shell
-elasticsearch.host=127.0.0.1
-elasticsearch.port=9200
-elasticsearch.username=elastic
-elasticsearch.password=inlong123INLONG
-elasticsearch.shardsNum=5
-elasticsearch.replicaNum=1
-elasticsearch.indexDeleteDay=5
-elasticsearch.enableCustomDocId=true
-elasticsearch.bulkInterval=10
-elasticsearch.bulkThreshold=10
-elasticsearch.auditIdSet=1,2,3,4,5,6,7,8
```
### 启动
-启动脚本 `inlong-audit/audit-store/bin/start.sh`
+启动脚本 `./bin/store-start.sh`
```Shell
-sh bin/start.sh
+sh ./bin/store-start.sh
```
-### 停止
-停止脚本 `inlong-audit/audit-store/bin/stop.sh`
-```Shell
-sh bin/stop.sh
-```
\ No newline at end of file
+Audit Proxy 默认监听端口为 `10081`。
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
index dd1bfa3..83718ec 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/dataproxy/quick_start.md
@@ -12,7 +12,7 @@ title: 安装部署
```
$ sed -i 's/TUBE_LIST/tubemq_master_list/g' conf/flume.conf
```
-- 如果使用Apache Pulsar,
替换`conf/flume-mulit-pulsar-demo.conf`中`pulsar_server_url_list`并覆盖`conf/flume.conf`。
+- 如果使用Apache Pulsar,
替换`conf/flume-mulit-pulsar-tcp-example.conf`中`pulsar_server_url_list`并覆盖`conf/flume.conf`。
注意conf/flume.conf中FLUME_HOME为proxy的中间数据文件存放地址
@@ -20,8 +20,10 @@ $ sed -i 's/TUBE_LIST/tubemq_master_list/g' conf/flume.conf
配置文件：`conf/common.properties`:
```
-# manager web url
-manager_hosts=ip:port
+# manager 地址
+manager_hosts=127.0.0.1:8083
+# audit proxy 地址
+audit.proxys=127.0.0.1:10081
```
## 启动
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
index 7af49ae..13870c0 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/manager/quick_start.md
@@ -33,9 +33,9 @@ spring.profiles.active=dev
1) 修改数据库 URL、用户名和密码：
```properties
-
spring.datasource.jdbc-url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
- spring.datasource.username=DB_USER
- spring.datasource.password=DB_PASSWD
+
spring.datasource.druid.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_manager?useSSL=false&allowPublicKeyRetrieval=true&characterEncoding=UTF-8&nullCatalogMeansCurrent=true&serverTimezone=GMT%2b8
+ spring.datasource.druid.username=root
+ spring.datasource.druid.password=inlong
```
2) 配置消息队列服务，可以使用InLong TubeMQ 或者 Apache Pulsar：
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
index d3d7011..5a5b01f 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/sort/quick_start.md
@@ -20,7 +20,7 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
```
./bin/flink run -c org.apache.inlong.sort.flink.Entrance
inlong-sort/sort-core-[version].jar \
--cluster-id inlong_app --zookeeper.quorum 127.0.0.1:2181
--zookeeper.path.root /inlong_sort \
---source.type tubemq --sink.type hive
+--source.type tubemq --metrics.audit.proxy.hosts 127.0.0.1:10081 --sink.type
hive
```
注意：
@@ -33,6 +33,7 @@ flink环境配置完成后，可以通过浏览器访问flink的web ui，对应
- `--cluster-id ` 用来唯一标识一个inlong-sort作业，同inlong-manager中`sort.appName`配置一致
- `--zookeeper.quorum` zk quorum，同inlong-manager中`cluster.zk.url`配置一致
- `--zookeeper.path.root` zk根目录，同inlong-manager中`cluster.zk.root`配置一致
+- `--metrics.audit.proxy.hosts` audit proxy 地址用于上报审计指标数据
- `--source.type` 数据源的种类, 当前支持："tubemq"、"pulsar"
- `--sink.type` 存储系统的种类，当前支持："clickhouse"、"hive"
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/how_to_build.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/how_to_build.md
index 7852870..a6a7a90 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/how_to_build.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/quick_start/how_to_build.md
@@ -20,6 +20,7 @@ $ docker run -v `pwd`:/inlong -w /inlong maven:3.6-openjdk-8
mvn clean install
若编译成功，在`inlong-distribution/target`下会找到`tar.gz`格式的安装包，解压安装目录，包括各个模块安装文件：
```
inlong-agent
+inlong-audit
inlong-dataproxy
inlong-manager
inlong-sort
