Merge pull request #780 from ascrutae/feature/change-docs

Add kafka plugin docs

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)
 

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)

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

docs/cn/FAQ/Kafka-plugin-CN.md

@@ -0,0 +1,7 @@
+**现象** ：
+Kafka消息消费端链路断裂
+
+**原因**：
+Kafka探针只是追踪了对Kafka的拉取动作，而整个后续处理过程不是由kafka consumer发起。故，需要在消费处理的发起点，进行手动埋点。
+
+**解决方法**: 可以通过Application Toolkit中的@Trace标注，或者OpenTracing API进行手动埋点。

docs/cn/FAQ/Why-have-traces-no-others-CN.md

@@ -2,10 +2,9 @@
 - Agent和Collector正常工作，没有异常日志
 - 已经对系统进行过访问，Trace查询有数据
 - UI除Trace查询页面外，其他页面无数据
-- **页面顶部时间轴和当前系统时间不一致**
 
 原因：
-被监控系统所在的操作系统，未设置为当前时区，导致统计数据汇集时间点偏差。
+Collector和被监控应用的系统主机时间，没有同步。
 
 解决方法：
-设置操作系统时间时区
+同步各主机操作系统时间。

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

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.

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.