From dbf010485a0bb521630006e95faac7aff091d4a1 Mon Sep 17 00:00:00 2001 From: ascrutae Date: Sun, 28 Jan 2018 01:07:53 +0800 Subject: [PATCH 01/10] Add kafka plugin docs --- docs/Supported-list.md | 4 +++- docs/cn/FAQ/Kafka-plugin-CN.md | 7 +++++++ docs/en/FAQ/kafka-plugin.md | 8 ++++++++ 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 docs/cn/FAQ/Kafka-plugin-CN.md create mode 100644 docs/en/FAQ/kafka-plugin.md diff --git a/docs/Supported-list.md b/docs/Supported-list.md index ea49a3aa1..4b918a23a 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 plugin would probably affect the performance because of enhancing class. Or some of them are in beta, If the above plugins are put under the plugins folder, it will cause the user experience not so good, For this reason these plugins is not load by default. \ No newline at end of file diff --git a/docs/cn/FAQ/Kafka-plugin-CN.md b/docs/cn/FAQ/Kafka-plugin-CN.md new file mode 100644 index 000000000..1f9e4c681 --- /dev/null +++ b/docs/cn/FAQ/Kafka-plugin-CN.md @@ -0,0 +1,7 @@ +**现象** +Kafka插件无法追踪应用是怎么处理消息 + +**原因**：Kafka消费端主动从Kafka Cluster获取消息，并且探针无法得知 +消费线程是否被监控. + +**解决方法**: 需要手动探针才能解决，获取消息和处理消息的方法追加@Trace，详情见[文档](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Application-toolkit-trace.md) diff --git a/docs/en/FAQ/kafka-plugin.md b/docs/en/FAQ/kafka-plugin.md new file mode 100644 index 000000000..31db6423c --- /dev/null +++ b/docs/en/FAQ/kafka-plugin.md @@ -0,0 +1,8 @@ +**Problem**:
+The Kafka plug-in can't track how applications handle messages + +**Reason**: +The Kafka consumer actively takes a message from Kafka Cluster and the agent can not see if the consuming thread is being monitored. + +**Resolve**: +Add the `@Trace` annotation to the method of handle message and the method of poll message , see the [document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Application-toolkit-trace.md) \ No newline at end of file From c1d2afbc1ee819363abc2991236ac92f29f58677 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Sun, 28 Jan 2018 14:11:57 +0800 Subject: [PATCH 02/10] Update Supported-list.md Correct the English. --- docs/Supported-list.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Supported-list.md b/docs/Supported-list.md index 4b918a23a..a327444ac 100644 --- a/docs/Supported-list.md +++ b/docs/Supported-list.md @@ -49,4 +49,4 @@ * 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. -²These plugin would probably affect the performance because of enhancing class. Or some of them are in beta, If the above plugins are put under the plugins folder, it will cause the user experience not so good, For this reason these plugins is not load by default. \ No newline at end of file +²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. From 1a21409c8970ad2070f41997b991438e0d810953 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Sun, 28 Jan 2018 14:15:49 +0800 Subject: [PATCH 03/10] Update Kafka-plugin-CN.md Make zh description more clear. --- docs/cn/FAQ/Kafka-plugin-CN.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/cn/FAQ/Kafka-plugin-CN.md b/docs/cn/FAQ/Kafka-plugin-CN.md index 1f9e4c681..02d15a9a6 100644 --- a/docs/cn/FAQ/Kafka-plugin-CN.md +++ b/docs/cn/FAQ/Kafka-plugin-CN.md @@ -1,7 +1,7 @@ -**现象** -Kafka插件无法追踪应用是怎么处理消息 +**现象** ： +Kafka消息消费端链路断裂 -**原因**：Kafka消费端主动从Kafka Cluster获取消息，并且探针无法得知 -消费线程是否被监控. +**原因**： +Kafka探针只是追踪了对Kafka的拉取动作，而整个后续处理过程不是由kafka consumer发起。故，需要在消费处理的发起点，进行手动埋点。 -**解决方法**: 需要手动探针才能解决，获取消息和处理消息的方法追加@Trace，详情见[文档](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Application-toolkit-trace.md) +**解决方法**: 可以通过Application Toolkit中的@Trace标注，或者OpenTracing API进行手动埋点。 From 73fd9c75e82ea9d7de250b281e5901e0c6f561c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Sun, 28 Jan 2018 14:19:28 +0800 Subject: [PATCH 04/10] Update kafka-plugin.md Clear the English description about how to trace kafka consumer. --- docs/en/FAQ/kafka-plugin.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en/FAQ/kafka-plugin.md b/docs/en/FAQ/kafka-plugin.md index 31db6423c..7fea78807 100644 --- a/docs/en/FAQ/kafka-plugin.md +++ b/docs/en/FAQ/kafka-plugin.md @@ -1,8 +1,8 @@ -**Problem**:
-The Kafka plug-in can't track how applications handle messages +**Problem**: +The trace doesn't continue in kafka consumer side. **Reason**: -The Kafka consumer actively takes a message from Kafka Cluster and the agent can not see if the consuming thread is being monitored. +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**: -Add the `@Trace` annotation to the method of handle message and the method of poll message , see the [document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/Application-toolkit-trace.md) \ No newline at end of file +Use Application Toolkit libraries to do manual instrumentation. such as `@Trace` annotaion or OpenTracing API. From 7670ef3d2706d9c141a8d7bd07280a8730e17fd0 Mon Sep 17 00:00:00 2001 From: ascrutae Date: Sun, 28 Jan 2018 14:51:57 +0800 Subject: [PATCH 05/10] link the kafka FAQ document --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index c38355652..bec84c947 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,4 +23,5 @@ * Protocol * [Cross Process Propagation Headers Protocol, v1.0](en/Skywalking-Cross-Process-Propagation-Headers-Protocol-v1.md) * FAQ + * [The trace doesn't continue in kafka consumer side](en/FAQ/kafka-plugin.md) From 843e32a0adec2f92ac3430e49974846692063a75 Mon Sep 17 00:00:00 2001 From: ascrutae Date: Sun, 28 Jan 2018 19:32:30 +0800 Subject: [PATCH 06/10] link the page --- docs/README.md | 2 ++ docs/README_ZH.md | 1 + docs/cn/FAQ/Why-have-traces-no-others-CN.md | 2 +- docs/en/FAQ/Too-many-gRPC-logs.md | 6 ++++++ docs/en/FAQ/Why-have-traces-no-others.md | 10 ++++++++++ 5 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 docs/en/FAQ/Too-many-gRPC-logs.md create mode 100644 docs/en/FAQ/Why-have-traces-no-others.md diff --git a/docs/README.md b/docs/README.md index bec84c947..d0796a2d7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,5 +23,7 @@ * Protocol * [Cross Process Propagation Headers Protocol, v1.0](en/Skywalking-Cross-Process-Propagation-Headers-Protocol-v1.md) * FAQ + * [No other data but UI can query trace](cn/FAQ/Why-have-traces-no-others.md) + * [Too many GRPC log 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/cn/FAQ/Why-have-traces-no-others-CN.md b/docs/cn/FAQ/Why-have-traces-no-others-CN.md index fcab017a3..a6588f9fb 100644 --- a/docs/cn/FAQ/Why-have-traces-no-others-CN.md +++ b/docs/cn/FAQ/Why-have-traces-no-others-CN.md @@ -2,7 +2,7 @@ - Agent和Collector正常工作，没有异常日志 - 已经对系统进行过访问，Trace查询有数据 - UI除Trace查询页面外，其他页面无数据 -- **页面顶部时间轴和当前系统时间不一致** +- 页面顶部时间轴和当前系统时间不一致 原因： 被监控系统所在的操作系统，未设置为当前时区，导致统计数据汇集时间点偏差。 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..3daa76b60 --- /dev/null +++ b/docs/en/FAQ/Why-have-traces-no-others.md @@ -0,0 +1,10 @@ +**Problem**： +- There is no abnormal log in Agent log and Collector log, +- The page can see the trace stack, but the others cannot see any data +- The top of the page Time line is inconsistent with the current system time + +**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**： +Set the time zone \ No newline at end of file From ab6f4f3c76f9abbdb8a367ad538e618155805aa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Mon, 29 Jan 2018 12:11:45 +0800 Subject: [PATCH 07/10] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index d0796a2d7..6b34addad 100644 --- a/docs/README.md +++ b/docs/README.md @@ -23,7 +23,7 @@ * Protocol * [Cross Process Propagation Headers Protocol, v1.0](en/Skywalking-Cross-Process-Propagation-Headers-Protocol-v1.md) * FAQ - * [No other data but UI can query trace](cn/FAQ/Why-have-traces-no-others.md) - * [Too many GRPC log in the console](cn/FAQ/Too-many-gRPC-logs.md) +    * [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) From a0428d1d13614aa20e546efbe6c9fa9017006d1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Mon, 29 Jan 2018 12:12:28 +0800 Subject: [PATCH 08/10] Update Why-have-traces-no-others-CN.md --- docs/cn/FAQ/Why-have-traces-no-others-CN.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) 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 a6588f9fb..2c95a5ef3 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查询页面外，其他页面无数据 -- 页面顶部时间轴和当前系统时间不一致 原因： 被监控系统所在的操作系统，未设置为当前时区，导致统计数据汇集时间点偏差。 解决方法： -设置操作系统时间时区 \ No newline at end of file +设置操作系统时间时区 From 36cc9e5b3821722a5b3de327d779e28d68dd4aae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Mon, 29 Jan 2018 12:15:25 +0800 Subject: [PATCH 09/10] Update Why-have-traces-no-others.md --- docs/en/FAQ/Why-have-traces-no-others.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/en/FAQ/Why-have-traces-no-others.md b/docs/en/FAQ/Why-have-traces-no-others.md index 3daa76b60..c0db2fe41 100644 --- a/docs/en/FAQ/Why-have-traces-no-others.md +++ b/docs/en/FAQ/Why-have-traces-no-others.md @@ -1,10 +1,9 @@ **Problem**： - There is no abnormal log in Agent log and Collector log, -- The page can see the trace stack, but the others cannot see any data -- The top of the page Time line is inconsistent with the current system time +- 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**： -Set the time zone \ No newline at end of file +Make sure the time is sync in collector servers and monitored application servers. From e9cffe3ffb504cce1543c59d223d80704ebdd25d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=90=B4=E6=99=9F=20Wu=20Sheng?= Date: Mon, 29 Jan 2018 12:16:10 +0800 Subject: [PATCH 10/10] Update Why-have-traces-no-others-CN.md --- docs/cn/FAQ/Why-have-traces-no-others-CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 2c95a5ef3..cf8f2a3d2 100644 --- a/docs/cn/FAQ/Why-have-traces-no-others-CN.md +++ b/docs/cn/FAQ/Why-have-traces-no-others-CN.md @@ -4,7 +4,7 @@ - UI除Trace查询页面外，其他页面无数据 原因： -被监控系统所在的操作系统，未设置为当前时区，导致统计数据汇集时间点偏差。 +Collector和被监控应用的系统主机时间，没有同步。 解决方法： -设置操作系统时间时区 +同步各主机操作系统时间。