[GitHub] [incubator-inlong] dockerzhang commented on a change in pull request #1929: [INLONG][feature][audit] audit-sdk module

[GitBox <gi...@apache.org>]

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



##########
File path: inlong-audit/audit-sdk/README.md
##########
@@ -0,0 +1,21 @@
+# Description
+## overview
+The audit sdk is used to count the receiving and sending volume of each module in real time according to the cycle, 
+and the statistical results are sent to the audit access layer according to the cycle.
+
+##features
+### data uniqueness
+The audit sdk will add a unique mark to each audit audit, which can be used to remove duplicates.
+
+### unified audit standard
+The audit sdk uses log production time as the audit standard, 
+which can ensure that each module is reconciled in accordance with the unified audit standard.
+
+## usage

Review comment:
       here we can add more guides about how to use this SDK.

##########
File path: inlong-audit/audit-sdk/pom.xml
##########
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    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.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.apache.inlong</groupId>
+        <artifactId>inlong-audit</artifactId>
+        <version>0.12.0-incubating-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>audit-sdk</artifactId>
+    <packaging>jar</packaging>
+    <name>Apache InLong - Audit Sdk</name>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <compiler.source>1.8</compiler.source>
+        <compiler.target>1.8</compiler.target>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.netty</groupId>
+            <artifactId>netty</artifactId>
+            <version>3.10.6.Final</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.0</version>
+        </dependency>
+        <dependency>
+            <groupId>com.google.protobuf</groupId>
+            <artifactId>protobuf-java</artifactId>
+            <version>3.1.0</version>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>4.4</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.inlong</groupId>
+            <artifactId>audit-common</artifactId>
+            <version>0.12.0-incubating-SNAPSHOT</version>

Review comment:
       use `${project.version}`.

##########
File path: inlong-audit/pom.xml
##########
@@ -38,6 +38,7 @@
         <module>audit-docker</module>
         <module>audit-store</module>
         <module>audit-common</module>
+		<module>audit-sdk</module>

Review comment:
       more spaces should be moved before `<module>`.

##########
File path: inlong-audit/audit-sdk/README.md
##########
@@ -0,0 +1,21 @@
+# Description
+## overview
+The audit sdk is used to count the receiving and sending volume of each module in real time according to the cycle, 
+and the statistical results are sent to the audit access layer according to the cycle.
+
+##features

Review comment:
       Add a space before `features`.




-- 
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: commits-unsubscribe@inlong.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org