[GitHub] wu-sheng closed pull request #780: Add kafka plugin docs

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

wu-sheng closed pull request #780: Add kafka plugin docs
URL: https://github.com/apache/incubator-skywalking/pull/780
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/README.md b/docs/README.md
index c38355652..6b34addad 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -23,4 +23,7 @@
     * Protocol
       * [Cross Process Propagation Headers Protocol, v1.0](en/Skywalking-Cross-Process-Propagation-Headers-Protocol-v1.md)
   * FAQ
+ ? ?* [Why only traces in UI?](cn/FAQ/Why-have-traces-no-others.md)
+    * [Too many GRPC logs in the console](cn/FAQ/Too-many-gRPC-logs.md)
+    * [The trace doesn't continue in kafka consumer side](en/FAQ/kafka-plugin.md)
 
diff --git a/docs/README_ZH.md b/docs/README_ZH.md
index 8b612efc1..2cf5f1658 100644
--- a/docs/README_ZH.md
+++ b/docs/README_ZH.md
@@ -28,3 +28,4 @@
   * FAQ
     * [Trace??????????????JVM???](cn/FAQ/Why-have-traces-no-others-CN.md)
     * [?????Console?GRPC????](cn/FAQ/Too-many-gRPC-logs-CN.md)
+    * [Kafka?????????](cn/FAQ/Kafka-plugin-CN.md)
\ No newline at end of file
diff --git a/docs/Supported-list.md b/docs/Supported-list.md
index ea49a3aa1..a327444ac 100644
--- a/docs/Supported-list.md
+++ b/docs/Supported-list.md
@@ -30,6 +30,7 @@
   * [gRPC](https://github.com/grpc/grpc-java) 1.6+
 * MQ
   * [RocketMQ](https://github.com/apache/rocketmq) 4.x
+  * [Kafka](http://kafka.apache.org) 0.11.0.0 -> 1.0 (Optional?)
 * NoSQL
   * Redis
     * [Jedis](https://github.com/xetorthio/jedis) 2.x
@@ -47,4 +48,5 @@
   * Motan
   * Hprose-java
 
-?Required dependencies for these components must be first manually downloaded before being built, due to license incompatibilities. For this reason these components are not by default included in the SkyWalking releases.
\ No newline at end of file
+?Required dependencies for these components must be first manually downloaded before being built, due to license incompatibilities. For this reason these components are not by default included in the SkyWalking releases.
+?These plugins affect the performance or must be used under some conditions, from experiences. So only released in `/optional-plugins`, copy to `/plugins` in order to make them work.
diff --git a/docs/cn/FAQ/Kafka-plugin-CN.md b/docs/cn/FAQ/Kafka-plugin-CN.md
new file mode 100644
index 000000000..02d15a9a6
--- /dev/null
+++ b/docs/cn/FAQ/Kafka-plugin-CN.md
@@ -0,0 +1,7 @@
+**??** ?
+Kafka?????????
+
+**??**?
+Kafka????????Kafka??????????????????kafka consumer????????????????????????
+
+**????**: ????Application Toolkit??@Trace?????OpenTracing API???????
diff --git a/docs/cn/FAQ/Why-have-traces-no-others-CN.md b/docs/cn/FAQ/Why-have-traces-no-others-CN.md
index fcab017a3..cf8f2a3d2 100644
--- a/docs/cn/FAQ/Why-have-traces-no-others-CN.md
+++ b/docs/cn/FAQ/Why-have-traces-no-others-CN.md
@@ -2,10 +2,9 @@
 - Agent?Collector???????????
 - ???????????Trace?????
 - UI?Trace?????????????
-- **?????????????????**
 
 ???
-????????????????????????????????????
+Collector???????????????????
 
 ?????
-??????????
\ No newline at end of file
+????????????
diff --git a/docs/en/FAQ/Too-many-gRPC-logs.md b/docs/en/FAQ/Too-many-gRPC-logs.md
new file mode 100644
index 000000000..58b4b124c
--- /dev/null
+++ b/docs/en/FAQ/Too-many-gRPC-logs.md
@@ -0,0 +1,6 @@
+**Problem**?
+Too many GRPC log in the console
+
+**Reason**?Skywalking uses the GRPC framework to send data, and the GRPC framework reads log configuration files for log output.
+
+**Resolve**: Add filter to `org.apache.skywalking.apm.dependencies` package in log configuration file
diff --git a/docs/en/FAQ/Why-have-traces-no-others.md b/docs/en/FAQ/Why-have-traces-no-others.md
new file mode 100644
index 000000000..c0db2fe41
--- /dev/null
+++ b/docs/en/FAQ/Why-have-traces-no-others.md
@@ -0,0 +1,9 @@
+**Problem**?
+- There is no abnormal log in Agent log and Collector log, 
+- The traces show, but no other info in UI.
+
+**Reason**?
+The operating system where the monitored system is located is not set as the current time zone, causing statistics collection time points to deviate.
+
+**Resolve**?
+Make sure the time is sync in collector servers and monitored application servers.
diff --git a/docs/en/FAQ/kafka-plugin.md b/docs/en/FAQ/kafka-plugin.md
new file mode 100644
index 000000000..7fea78807
--- /dev/null
+++ b/docs/en/FAQ/kafka-plugin.md
@@ -0,0 +1,8 @@
+**Problem**: 
+The trace doesn't continue in kafka consumer side.
+
+**Reason**:
+The kafka client is pulling message from server, the plugin also just traces the pull action. As that, you need to do the manual instrument before the pull action, and include the further data process.
+
+**Resolve**:
+Use Application Toolkit libraries to do manual instrumentation. such as `@Trace` annotaion or OpenTracing API.


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on 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