dockerzhang commented on a change in pull request #314:
URL: 
https://github.com/apache/incubator-inlong-website/pull/314#discussion_r831816868



##########
File path: docs/modules/audit/quick_start.md
##########
@@ -5,33 +5,58 @@ title: Deployment
 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`.
 
 ## Audit Proxy
-### Configure Pulsar
-The configuration file  is `conf/audit.conf`. 
+### Configure MessageQueue
+You can choose Apache Pulsar or InLong TubeMQ as your MessageQueue service:
+
+- If using Pulsar, the configuration file is `conf/audit-proxy-pulsar.conf`
+

Review comment:
       add an explanation about how to config the pulsar address.

##########
File path: docs/modules/audit/quick_start.md
##########
@@ -5,33 +5,58 @@ title: Deployment
 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`.
 
 ## Audit Proxy
-### Configure Pulsar
-The configuration file  is `conf/audit.conf`. 
+### Configure MessageQueue
+You can choose Apache Pulsar or InLong TubeMQ as your MessageQueue service:
+
+- If using Pulsar, the configuration file is `conf/audit-proxy-pulsar.conf`
+
 ```Shell
 agent1.sources.tcp-source.host = 0.0.0.0
-agent1.sources.tcp-source.port = 46801
+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
 ```
 
+- If using TubeMQ, the configuration file is `conf/audit-proxy-tube.conf`
+
+```Shell
+agent1.sources.tcp-source.host = 0.0.0.0
+agent1.sources.tcp-source.port = 10081
+agent1.sinks.tube-sink-msg1.master-host-port-list = TUBE_LIST
+agent1.sinks.tube-sink-msg1.topic = inlong-audit
+agent1.sinks.tube-sink-msg2.master-host-port-list = TUBE_LIST
+agent1.sinks.tube-sink-msg2.topic = inlong-audit
+```
+
 ### Start
 ```Shell
-sh ./bin/proxy-start.sh
+#By default, pulsar is used as the MessageQueue, and the 
audit-proxy-pulsar.conf configuration file is loaded.
+sh ./bin/proxy-start.sh [pulsar|tube]
 ```
 
 ## Audit Store
 ### Configure
 The configuration file  is `conf/application.properties`. 

Review comment:
       add an explanation about how to config the pulsar or tubemq address.

##########
File path: docs/modules/audit/quick_start.md
##########
@@ -5,33 +5,58 @@ title: Deployment
 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`.
 
 ## Audit Proxy
-### Configure Pulsar
-The configuration file  is `conf/audit.conf`. 
+### Configure MessageQueue
+You can choose Apache Pulsar or InLong TubeMQ as your MessageQueue service:
+
+- If using Pulsar, the configuration file is `conf/audit-proxy-pulsar.conf`
+
 ```Shell
 agent1.sources.tcp-source.host = 0.0.0.0
-agent1.sources.tcp-source.port = 46801
+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
 ```
 
+- If using TubeMQ, the configuration file is `conf/audit-proxy-tube.conf`
+

Review comment:
       ditto, add an explanation about how to config the tube address.

##########
File path: docs/modules/audit/overview.md
##########
@@ -12,7 +12,7 @@ The transmission status of each module, and whether the data 
stream is lost or r
 ## Architecture
 ![](img/audit_architecture.png)
 1. The audit SDK is nested in the service that needs to be audited, audits the 
service, and sends the audit result to the audit access layer
-2. The audit proxy writes audit data to MQ (kafak or pulsar)
+2. The audit proxy writes audit data to MQ (kafka, pulsar or TubeMQ)

Review comment:
       `Kafka` is not supported, please remove it. otherwise, `pulsar` -> 
`Pulsar`.




-- 
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.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


Reply via email to