[GitHub] [skywalking-agent-test-tool] kezhenxu94 commented on a change in pull request #4: update readme

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

kezhenxu94 commented on a change in pull request #4: update readme
URL: https://github.com/apache/skywalking-agent-test-tool/pull/4#discussion_r387388681
 
 

 ##########
 File path: README.md
 ##########
 @@ -1,7 +1,80 @@
-# Apache SkyWalking Agent Test Tool Suits
+Apache SkyWalking Agent Test Tool Suite
+==========
 
+<img src="http://skywalking.apache.org/assets/logo.svg" alt="Sky Walking logo" height="90px" align="right" />
+
+[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
+
+![CI](https://github.com/apache/skywalking-nginx-lua/workflows/CI/badge.svg?branch=master)
+
+
+[**SkyWalking**](https://github.com/apache/skywalking) Agent Test Tool is a tremendously useful test tools suite in a wide variety of languages of `Agent`. 
+Includes `mock collector` and `validator`. The `mock collector` is a SkyWalking receiver, likes OAP server. 
+
+The `mock collector` is responsible for mocking the SkyWalking OAP receiver to collect data from the agent. It will collect data from Agent reported by `GRPC`. 
+And then it can be downloaded by Http API that the mock collector collected(service registered, instance registered, and segments). 
+Finally, to validate the file downloaded from `mock collector` by `SkyWalking Validator. 
 
 ## Apache SkyWalking Mock Collector
 
+- requirement:
+1. JDK 1.8+
+2. Maven 
+
+
+- How to install
+
+The `mock collector` is written by pure-`Java`. It compiles and packages through `Maven`.
+
+
+```bash
+mvn package -DskipTests
+unzip ./dist/mock-collector.tar.gz -d ./mock-collector
+cd ./mock-collector
+bash ./bin/collector-startup.sh
+```
+
+after above steps, we can check whether the `mock collector` is available throgh HTTP API. To visit `http://localhost:12800/status` and get the reponse with `success` in the body of content.
+
+Finally, To visit follow URL to download the data as `yaml` file, which can be used by `SkyWalking Validator Tool`.
+
+http://localhost:12800/receiveData
+
+- How to config on agent
+
+We can modify directly the conguration of agent, `./config/agent.conf`, likes following.
+
+```yaml
+# Backend service addresses.
+collector.backend_service=${SW_AGENT_COLLECTOR_BACKEND_SERVICES:127.0.0.1:19876}
+```
+
+or specify the jvm arguments likes:
+
+```bash
+# Backend service addresses.
+-DSW_AGENT_COLLECTOR_BACKEND_SERVICES=127.0.0.1:19876
+```
+
+## Apache SkyWalking Validator Tool
+
+`Validator Tool` a data validating tool. It resposible for validating the `expected data` with `actual data`.
 
 Review comment:
   ```suggestion
   `Validator Tool` is a data validating tool. It is responsible for validating the `expected data` with `actual data`.
   ```

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