You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@inlong.apache.org by do...@apache.org on 2024/05/08 10:14:51 UTC
(inlong-website) branch INLONG-949 created (now 487adbf9bb)
This is an automated email from the ASF dual-hosted git repository.
doleyzi pushed a change to branch INLONG-949
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
at 487adbf9bb Remove audit documents related to clickhouse and elasticsearch
This branch includes the following new commits:
new 487adbf9bb Remove audit documents related to clickhouse and elasticsearch
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(inlong-website) 01/01: Remove audit documents related to clickhouse and elasticsearch
Posted by do...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
doleyzi pushed a commit to branch INLONG-949
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
commit 487adbf9bbf931bf8e1b5b5f516a4d8931ca6de8
Author: doleyzi <do...@qq.com>
AuthorDate: Wed May 8 18:14:37 2024 +0800
Remove audit documents related to clickhouse and elasticsearch
---
docs/modules/audit/configure.md | 50 ++++---------------
docs/modules/audit/img/audit_api.png | Bin 31395 -> 0 bytes
docs/modules/audit/img/audit_architecture.png | Bin 83639 -> 51469 bytes
docs/modules/audit/img/audit_mysql.png | Bin 19356 -> 0 bytes
docs/modules/audit/img/audit_openapi.png | Bin 56423 -> 0 bytes
docs/modules/audit/img/audit_proxy.png | Bin 29358 -> 0 bytes
docs/modules/audit/img/audit_sdk.png | Bin 81979 -> 0 bytes
.../audit/img/audit_sdk_disaster_recovery.png | Bin 35275 -> 0 bytes
docs/modules/audit/img/audit_ui.png | Bin 76860 -> 0 bytes
docs/modules/audit/img/elasticsearch_index.png | Bin 22117 -> 0 bytes
docs/modules/audit/img/elasticsearch_overview.png | Bin 47297 -> 0 bytes
docs/modules/audit/img/elasticsearch_write.png | Bin 26657 -> 0 bytes
docs/modules/audit/overview.md | 47 ++++--------------
docs/modules/audit/quick_start.md | 52 ++++++++------------
.../current/modules/audit/configure.md | 33 +------------
.../current/modules/audit/img/audit_api.png | Bin 33174 -> 0 bytes
.../modules/audit/img/audit_architecture.png | Bin 83639 -> 51469 bytes
.../current/modules/audit/img/audit_mysql.png | Bin 19165 -> 0 bytes
.../current/modules/audit/img/audit_openapi.png | Bin 56423 -> 0 bytes
.../current/modules/audit/img/audit_proxy.png | Bin 31329 -> 0 bytes
.../current/modules/audit/img/audit_sdk.png | Bin 77771 -> 0 bytes
.../audit/img/audit_sdk_disaster_recovery.png | Bin 29207 -> 0 bytes
.../current/modules/audit/img/audit_ui.png | Bin 79285 -> 0 bytes
.../modules/audit/img/elasticsearch_index.png | Bin 21801 -> 0 bytes
.../modules/audit/img/elasticsearch_overview.png | Bin 46579 -> 0 bytes
.../modules/audit/img/elasticsearch_write.png | Bin 27577 -> 0 bytes
.../current/modules/audit/overview.md | 53 +++++----------------
.../current/modules/audit/quick_start.md | 51 ++++++++------------
28 files changed, 74 insertions(+), 212 deletions(-)
diff --git a/docs/modules/audit/configure.md b/docs/modules/audit/configure.md
index 7f7b234db0..ae5997925d 100644
--- a/docs/modules/audit/configure.md
+++ b/docs/modules/audit/configure.md
@@ -18,7 +18,6 @@ sidebar_position: 3
| agent1.sources | source typpe | tcp-source | |
| agent1.channels | used channel | ch-msg1 | |
| agent1.sinks | used sink | pulsar-sink-msg1 | |
-|
### sources Configuration
@@ -50,50 +49,19 @@ sidebar_position: 3
### MQ configuration
-| Parameter | Description | Default value | Notes |
-|----------------------------|---------------------------------------------|-------------------------------------------------------|--------------------------------------------------------|
-| audit.config.proxy.type | MQ type | pulsar | |
-| audit.pulsar.server.url | pulsar broker | pulsar://127.0.0.1:6650 | |
-| audit.pulsar.topic | pulsar topic | persistent://public/Default value/inlong-audit | |
-| audit.pulsar.consumer.sub.name | consumer | inlong-audit-subscription | |
-| audit.pulsar.enable.auth | Whether security certification is required | false | |
-| audit.pulsar.token | pulsar authentication token | | |
-
-### DB configuration
-
-| Parameter | Description | Default value | Notes |
-|---------------------------|--------------------|-------|---------------------------------------------|
-| spring.datasource.druid.driver-class-name | Set the driver type | com.mysql.cj.jdbc.Driver | |
-| spring.datasource.druid.url| jdbc 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&allowPublicKeyRetrieval=true | |
-| spring.datasource.druid.username | account name | root | |
-| spring.datasource.druid.password | password | inlong | |
-
-### ElasticSearch configuration
-
-| Parameter | Description | Default value | Notes |
-|--------------------------|----------------------------|------|-----|
-| elasticsearch.host | broker | 127.0.0.1 | |
-| elasticsearch.port | port | 9200 | |
-| elasticsearch.authEnable | Whether security certification is required | false | |
-| elasticsearch.username | account name | elastic | |
-| elasticsearch.password | password | inlong | |
-| elasticsearch.indexDeleteDay | Index retention time, days | 5 | |
-| elasticsearch.auditIdSet | List of audit IDs that are allowed to write | 1,2 | |
-
-### clickhouse configuration
-
-| Parameter | Description | Default value | Notes |
-|---------------------------|--------------------|-------|---------------------------------------------|
-| clickhouse.driver | Set the driver type | ru.yandex.clickhouse.ClickHouseDriver | |
-| clickhouse.url| clickhouse URL | jdbc:clickhouse://127.0.0.1:8123/Default value | |
-| clickhouse.username | account name | Default value | |
-| clickhouse.password | password | Default value | |
+| Parameter | Description | Default value | Notes |
+|----------------------------|---------------------------------------------|-------------------------------------------------------|---------------|
+| audit.config.proxy.type | MQ type | pulsar | |
+| audit.pulsar.server.url | pulsar broker | pulsar://127.0.0.1:6650 | |
+| audit.pulsar.topic | pulsar topic | persistent://public/Default value/inlong-audit | |
+| audit.pulsar.consumer.sub.name | consumer | inlong-audit-subscription | |
+| audit.pulsar.enable.auth | Whether security certification is required | false | |
+| audit.pulsar.token | pulsar authentication token | | |
-### StarRocks configuration
+### MySQL / StarRocks configuration
| Parameter | Description | Default value | Notes |
|---------------------|---------------|-----------------|---------------------------------------------|
-| jdbc.driver | Driver type | com.mysql.cj.jdbc.Driver | |
| jdbc.url | StarRocks URL | jdbc:mysql://127.0.0.1:8123/default | |
| jdbc.username | account name | default | |
| jdbc.password | password | default | |
diff --git a/docs/modules/audit/img/audit_api.png b/docs/modules/audit/img/audit_api.png
deleted file mode 100644
index 49367978e0..0000000000
Binary files a/docs/modules/audit/img/audit_api.png and /dev/null differ
diff --git a/docs/modules/audit/img/audit_architecture.png b/docs/modules/audit/img/audit_architecture.png
index 3539c489f9..d9b003f442 100644
Binary files a/docs/modules/audit/img/audit_architecture.png and b/docs/modules/audit/img/audit_architecture.png differ
diff --git a/docs/modules/audit/img/audit_mysql.png b/docs/modules/audit/img/audit_mysql.png
deleted file mode 100644
index cb21c5200f..0000000000
Binary files a/docs/modules/audit/img/audit_mysql.png and /dev/null differ
diff --git a/docs/modules/audit/img/audit_openapi.png b/docs/modules/audit/img/audit_openapi.png
deleted file mode 100644
index c7bc0f9774..0000000000
Binary files a/docs/modules/audit/img/audit_openapi.png and /dev/null differ
diff --git a/docs/modules/audit/img/audit_proxy.png b/docs/modules/audit/img/audit_proxy.png
deleted file mode 100644
index 25342daf79..0000000000
Binary files a/docs/modules/audit/img/audit_proxy.png and /dev/null differ
diff --git a/docs/modules/audit/img/audit_sdk.png b/docs/modules/audit/img/audit_sdk.png
deleted file mode 100644
index a63e89c3dd..0000000000
Binary files a/docs/modules/audit/img/audit_sdk.png and /dev/null differ
diff --git a/docs/modules/audit/img/audit_sdk_disaster_recovery.png b/docs/modules/audit/img/audit_sdk_disaster_recovery.png
deleted file mode 100644
index 0f43f2c3e8..0000000000
Binary files a/docs/modules/audit/img/audit_sdk_disaster_recovery.png and /dev/null differ
diff --git a/docs/modules/audit/img/audit_ui.png b/docs/modules/audit/img/audit_ui.png
deleted file mode 100644
index 9b63bcf398..0000000000
Binary files a/docs/modules/audit/img/audit_ui.png and /dev/null differ
diff --git a/docs/modules/audit/img/elasticsearch_index.png b/docs/modules/audit/img/elasticsearch_index.png
deleted file mode 100644
index 41b654a618..0000000000
Binary files a/docs/modules/audit/img/elasticsearch_index.png and /dev/null differ
diff --git a/docs/modules/audit/img/elasticsearch_overview.png b/docs/modules/audit/img/elasticsearch_overview.png
deleted file mode 100644
index 82f1f6e7cb..0000000000
Binary files a/docs/modules/audit/img/elasticsearch_overview.png and /dev/null differ
diff --git a/docs/modules/audit/img/elasticsearch_write.png b/docs/modules/audit/img/elasticsearch_write.png
deleted file mode 100644
index 2f5a6ad0df..0000000000
Binary files a/docs/modules/audit/img/elasticsearch_write.png and /dev/null differ
diff --git a/docs/modules/audit/overview.md b/docs/modules/audit/overview.md
index 3f1c5bfc52..3d0a4b9c88 100644
--- a/docs/modules/audit/overview.md
+++ b/docs/modules/audit/overview.md
@@ -19,6 +19,15 @@ The transmission status of each module, and whether the data stream is lost or r
6. Support audit and reconciliation of data supplementary recording scenarios.
7. Support audit reconciliation in Flink checkpoint scenarios.
+## 模块
+
+| Modules | Description |
+|:----------------------------|:---------------------------------------------------------------------------------------------|
+| audit-sdk | Audit hidden points are reported. Each module uses the SDK to report audit data |
+| audit-proxy | Audit proxy layer, receives data reported by SDK and forwards it to MQ (pulsar/kafka/tubeMQ) |
+| audit-store | Audit storage layer, supporting common JDBC protocol |
+| audit-service | Audit service layer, providing aggregation, cache, OpenAPI and other capabilities |
+
## Audit Dimension
| | | || | | | | | |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- |
@@ -34,8 +43,6 @@ The receiving and sending of each module are respectively an independent audit i
|Inlong Agent Send Successfully |4|
|Inlong DataProxy Received Successfully |5|
|Inlong DataProxy Send Successfully |6|
-|Inlong Sort Received Successfully |7|
-|Inlong Sort Send Successfully |8|
## Data Transfer Protocol
The transmission protocol between sdk, access layer, and distribution layer is Protocol Buffers
@@ -96,38 +103,4 @@ message AuditReply {
RSP_CODE rsp_code = 1;
optional string message = 2;
}
-```
-## Audit SDK Implementation Details
-### Target
-***1. Support local disaster recovery***
-***2. Data Uniqueness***
-***3. Reduce data loss caused by abnormal restart***
-
-### Service Discovery
-Audit name discovery between sdk and access layer, support plug-in, including domain name, vip, etc.
-
-### Disaster Recovery
-* When the SDK fails to send the access layer, it will be placed in the failure queue.
-* When the failure queue reaches the threshold, it will be written to the local disaster recovery file.
-* When the local disaster recovery file reaches the threshold, the old data will be eliminated (eliminated by time).
-
-## Access layer Implementation
-### Target
-***1.High reliability***
-***2.at least once***
-
-## Distribution Implementation
-### Target
-***1. High real-time performance (minute level)***
-***2. Can operate tens of billions of audit data per day***
-***3. Can be deduplicated***
-
-## OpenAPI Implementation
-### Architecture
-
-* The audit interface layer provides OpenAPI capabilities to the outside world through real-time aggregation and local caching of multiple audit data sources.
-
-### UI Interface display
-### Architecture
-
-* The front-end page pulls the audit data of each module through the interface layer and displays it.
\ No newline at end of file
+```
\ No newline at end of file
diff --git a/docs/modules/audit/quick_start.md b/docs/modules/audit/quick_start.md
index a3004639b9..5c65a2614a 100644
--- a/docs/modules/audit/quick_start.md
+++ b/docs/modules/audit/quick_start.md
@@ -54,46 +54,36 @@ The configuration file is `conf/application.properties`.
# proxy.type: pulsar / tube / kafka
audit.config.proxy.type=pulsar
-# store.server: mysql / elasticsearch / clickhouse
-audit.config.store.mode=mysql
+# Supports common JDBC protocol
+audit.config.store.mode=jdbc
# manger config
manager.hosts=127.0.0.1:8083
proxy.cluster.tag=default_cluster
-# audit pulsar config (optional)
+# pulsar config
audit.pulsar.topic=persistent://public/default/inlong-audit
-audit.pulsar.consumer.sub.name=sub-audit
+audit.pulsar.consumer.sub.name=inlong-audit-subscription
+audit.pulsar.token=
+audit.pulsar.enable.auth=false
-# audit tube config (optional)
+# tube config
audit.tube.topic=inlong-audit
audit.tube.consumer.group.name=inlong-audit-consumer
-# kafka config (optional)
+# kafka config
audit.kafka.topic=inlong-audit
+# create a topic if the topic does not exist.
+audit.kafka.topic.numPartitions=3
+audit.kafka.topic.replicationFactor=2
audit.kafka.consumer.name=inlong-audit-consumer
audit.kafka.group.id=audit-consumer-group
-# mysql config
-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
-
-# es config (optional)
-elasticsearch.host=127.0.0.1
-elasticsearch.port=9200
-
-# clickhouse config (optional)
-clickhouse.driver=ru.yandex.clickhouse.ClickHouseDriver
-clickhouse.url=jdbc:clickhouse://127.0.0.1:8123/default
-clickhouse.username=default
-clickhouse.password=default
-
-# starrocks config (optional)
+# Generic jdbc storage
jdbc.driver=com.mysql.cj.jdbc.Driver
-jdbc.url=jdbc:mysql://127.0.0.1:9020/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL
-jdbc.username=*******
-jdbc.password=********
+jdbc.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
+jdbc.username=root
+jdbc.password=inlong
```
### Dependencies
@@ -111,14 +101,14 @@ bash +x ./bin/store-start.sh
The configuration file is `conf/audit-service.properties`
```Shell
mysql.jdbc.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useUnicode=true&rewriteBatchedStatements=true
-mysql.username=*****
-mysql.password=*****
+mysql.username=root
+mysql.password=inlong
```
-### Configure audit data sources
-In the audit_source_config table used by the Audit Service, configure the data source for audit storage.
+### Configure audit data sources(optional)
+In the audit_source_config table used by the Audit Service, configure the data source for audit storage. By default, the same MySQL configuration is used as the Audit Service
-### Configure audit audit items
-In the audit_id_config table used by the Audit Service, configure the audit items that need to be cached.
+### Configure audit audit items(optional)
+In the audit_id_config table used by the Audit Service, configure the audit items that need to be cached. By default, Agent is used to receive successfully, Agent is sent successfully, DataProxy is received successfully, and DataProxy is sent successfully.
### Dependencies
- If the backend database is MySQL, please download [mysql-connector-java-8.0.28.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.28/mysql-connector-java-8.0.28.jar) and put it into `lib/` directory.
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md
index a15d9ab44b..5a98ae3bdd 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/configure.md
@@ -61,41 +61,10 @@ sidebar_position: 3
| audit.pulsar.enable.auth | 是否需要安全认证 | false | |
| audit.pulsar.token | 认证token | | |
-### DB 相关设置
-
-| 参数 | 描述 | 默认值 | 备注 |
-|---------------------------|--------------------|-------|---------------------------------------------|
-| spring.datasource.druid.driver-class-name | 设置Driver类型 | com.mysql.cj.jdbc.Driver | |
-| spring.datasource.druid.url| jdbc的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&allowPublicKeyRetrieval=true | |
-| spring.datasource.druid.username | 账号名 | root | |
-| spring.datasource.druid.password | 密码 | inlong | |
-
-### ElasticSearch 配置
-
-| 参数 | 描述 | 默认值 | 备注 |
-|--------------------------|----------------------------|------|-----|
-| elasticsearch.host | 集群地址 | 127.0.0.1 | |
-| elasticsearch.port | 集群端口 | 9200 | |
-| elasticsearch.authEnable | 是否认证 | false | |
-| elasticsearch.username | 账号名 | elastic | |
-| elasticsearch.password | 密码 | inlong | |
-| elasticsearch.indexDeleteDay | 索引保存时间，天 | 5 | |
-| elasticsearch.auditIdSet | 允许写入的审计ID列表 | 1,2 | |
-
-### ClickHouse 相关配置
-
-| 参数 | 描述 | 默认值 | 备注 |
-|---------------------------|--------------------|-------|---------------------------------------------|
-| clickhouse.driver | 设置Driver类型 | ru.yandex.clickhouse.ClickHouseDriver | |
-| clickhouse.url| clickhouse的URL | jdbc:clickhouse://127.0.0.1:8123/default | |
-| clickhouse.username | 账号名 | default | |
-| clickhouse.password | 密码 | default | |
-
-### StarRocks 相关配置
+### MySQL / StarRocks 相关配置
| 参数 | 描述 | 默认值 | 备注 |
|---------------------|--------------------|---------------------------------------|---------------------------------------------|
-| jdbc.driver | 设置Driver类型 | com.mysql.cj.jdbc.Driver | |
| jdbc.url | StarRocks的URL | jdbc:mysql://127.0.0.1:8123/default | |
| jdbc.username | 账号名 | default | |
| jdbc.password | 密码 | default | |
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_api.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_api.png
deleted file mode 100644
index 240f1d3daf..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_api.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_architecture.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_architecture.png
index 3539c489f9..d9b003f442 100644
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_architecture.png and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_architecture.png differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_mysql.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_mysql.png
deleted file mode 100644
index 5ccd355236..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_mysql.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_openapi.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_openapi.png
deleted file mode 100644
index c7bc0f9774..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_openapi.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_proxy.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_proxy.png
deleted file mode 100644
index faf160ce64..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_proxy.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_sdk.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_sdk.png
deleted file mode 100644
index 243403daa8..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_sdk.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_sdk_disaster_recovery.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_sdk_disaster_recovery.png
deleted file mode 100644
index e07f7ca3e6..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_sdk_disaster_recovery.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_ui.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_ui.png
deleted file mode 100644
index 4de5f2e889..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/audit_ui.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_index.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_index.png
deleted file mode 100644
index a93f2a17bb..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_index.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_overview.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_overview.png
deleted file mode 100644
index e472566ba8..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_overview.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_write.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_write.png
deleted file mode 100644
index 0fefe47677..0000000000
Binary files a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/img/elasticsearch_write.png and /dev/null differ
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/overview.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/overview.md
index df85b260a3..b9f8bb4a19 100644
--- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/overview.md
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/modules/audit/overview.md
@@ -13,12 +13,21 @@ sidebar_position: 1
1. 审计SDK嵌套在需要审计的服务，对服务进行审计，将审计结果发送到审计接入层。
2. 审计接入层将审计数据写到 MQ(Pulsar、Kafka 或者 TubeMQ)。
-3. 分发服务消费 MQ 的审计数据，将审计数据写到 MySQL、Elasticsearch、ClickHouse、StarRocks。
-4. 接口层将 MySQL、Elasticsearch、ClickHouse、StarRocks的数据进行实时聚合并且cache,对外提供OpenAPI。
+3. 分发服务消费 MQ 的审计数据，将审计数据写到 MySQL、StarRocks。
+4. 接口层将 MySQL、StarRocks的数据进行实时聚合并且cache,对外提供OpenAPI。
5. 应用场景主要包括报表展示、审计对账等等。
6. 支持数据补录场景的审计对账。
7. 支持Flink checkpoint场景的审计对账。
+## 模块
+
+| 模块 | 描述 |
+|:---------------|:---------------------------------------------|
+| audit-sdk | 审计埋点上报，各个模块使用该SDK上报审计数据 |
+| audit-proxy | 审计代理层，接收SDK上报数据，转发到MQ(pulsar/kafka/tubeMQ) |
+| audit-store | 审计存储层，支持通用的JDBC协议 |
+| audit-service | 审计服务层，提供聚合、cache、OpenAPI等能力 |
+
## 审计维度
| | | || | | | | | |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- |
@@ -35,10 +44,6 @@ sidebar_position: 1
|Inlong agent发送成功 |4|
|Inlong DataProxy接收成功 |5|
|Inlong DataProxy发送成功 |6|
-|Inlong分发服务1接收成功 |7|
-|Inlong分发服务1发送成功 |8|
-|Inlong分发服务2接收成功 |9|
-|Inlong分发服务2发送成功 |10|
## 数据传输协议
sdk、接入层、分发层之间的传输协议为Protocol Buffers
@@ -99,38 +104,4 @@ message AuditReply {
RSP_CODE rsp_code = 1; //服务端返回码
optional string message = 2;
}
-```
-## 审计SDK实现
-### 目标
-***1.支持本地容灾***
-***2.数据唯一性***
-***3.减少异常重启导致的数据丢失***
-
-### 服务发现
-* 审计sdk与接入层之间的名字发现，支持插件化，包括域名、vip等
-
-### 容灾逻辑
-* sdk发送接入层失败时，会放入失败队列
-* 失败队列达到阈值时，将写到本地容灾文件
-* 本地容灾文件达到阈值时，将淘汰旧数据(按时间淘汰)
-
-## 接入层实现
-### 目标
-***1.高可靠***
-***2.at least once***
-
-## 分发层实现
-### 目标
-***1.高实时性(分钟级)***
-***2.部署简单***
-***3.可去重***
-
-## OpenAPI实现
-### 主要逻辑图
-
-* 审计接口层通过对多个审计数据源进行实时聚合、本地cache，对外提供OpenAPI能力。
-
-### UI 界面展示
-### 主要逻辑图
-
-* 前端页面通过接口层，拉取各个模块的审计数据，进行展示
\ No newline at end of file
+```
\ No newline at end of file
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 d10280fa07..db5b29ec1c 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
@@ -57,45 +57,36 @@ Audit Proxy 默认监听端口为 `10081`。
# proxy.type: pulsar / tube / kafka
audit.config.proxy.type=pulsar
-# store.server: mysql / elasticsearch
-audit.config.store.mode=mysql
+# Supports common JDBC protocol
+audit.config.store.mode=jdbc
# manger config
manager.hosts=127.0.0.1:8083
proxy.cluster.tag=default_cluster
-# audit pulsar config (optional)
+# pulsar config
audit.pulsar.topic=persistent://public/default/inlong-audit
-audit.pulsar.consumer.sub.name=sub-audit
+audit.pulsar.consumer.sub.name=inlong-audit-subscription
+audit.pulsar.token=
+audit.pulsar.enable.auth=false
-# audit tube config (optional)
+# tube config
audit.tube.topic=inlong-audit
audit.tube.consumer.group.name=inlong-audit-consumer
-# kafka config (optional)
+# kafka config
audit.kafka.topic=inlong-audit
+# create a topic if the topic does not exist.
+audit.kafka.topic.numPartitions=3
+audit.kafka.topic.replicationFactor=2
audit.kafka.consumer.name=inlong-audit-consumer
audit.kafka.group.id=audit-consumer-group
-# mysql config
-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
-
-# es config (optional)
-elasticsearch.host=127.0.0.1
-elasticsearch.port=9200
-
-# clickhouse config (optional)
-clickhouse.url=jdbc:clickhouse://127.0.0.1:8123/default
-clickhouse.username=default
-clickhouse.password=default
-
-# starrocks config (optional)
+# Generic jdbc storage
jdbc.driver=com.mysql.cj.jdbc.Driver
-jdbc.url=jdbc:mysql://127.0.0.1:9020/apache_inlong_audit?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2b8&rewriteBatchedStatements=true&allowMultiQueries=true&zeroDateTimeBehavior=CONVERT_TO_NULL
-jdbc.username=*******
-jdbc.password=********
+jdbc.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
+jdbc.username=root
+jdbc.password=inlong
```
### 依赖
@@ -112,14 +103,14 @@ bash +x ./bin/store-start.sh
配置文件 `conf/audit-service.properties`
```Shell
mysql.jdbc.url=jdbc:mysql://127.0.0.1:3306/apache_inlong_audit?characterEncoding=utf8&useUnicode=true&rewriteBatchedStatements=true
-mysql.username=*****
-mysql.password=*****
+mysql.username=root
+mysql.password=inlong
```
-#### 配置审计数据源
-在Audit Service服务使用的audit_source_config表中，配置审计存储的数据源。
+#### 配置审计数据源(可选)
+在Audit Service服务使用的audit_source_config表中，配置审计存储的数据源。默认和Audit Service使用相同的MySQL配置
-#### 配置审计审计项
-在Audit Service服务使用的audit_id_config表中，配置需要cache的审计项。
+#### 配置审计审计项(可选)
+在Audit Service服务使用的audit_id_config表中，配置需要cache的审计项。默认使用Agent接收成功、Agent发送成功、、DataProxy接收成功、、DataProxy发送成功
### 依赖
- 如果后端连接 MySQL 数据库，请下载 [mysql-connector-java-8.0.28.jar](https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.26/mysql-connector-java-8.0.28.jar), 并将其放入 `lib/` 目录。