From 1a7cc805afc4f944a13edd474e6a4cf5dff5a248 Mon Sep 17 00:00:00 2001 From: Wing <69376949+wingwong-knh@users.noreply.github.com> Date: Mon, 8 Mar 2021 17:14:39 +0800 Subject: [PATCH] Refine FAQ (#6512) --- ...mport-Project-Eclipse-RequireItems-Exception.md | 14 +++++++------- docs/en/FAQ/Memory-leak-enhance-Worker-thread.md | 14 +++++++------- docs/en/FAQ/Protoc-Plugin-Fails-When-Build.md | 10 +++++----- 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/en/FAQ/Import-Project-Eclipse-RequireItems-Exception.md b/docs/en/FAQ/Import-Project-Eclipse-RequireItems-Exception.md index 2be255600..c31bedb78 100644 --- a/docs/en/FAQ/Import-Project-Eclipse-RequireItems-Exception.md +++ b/docs/en/FAQ/Import-Project-Eclipse-RequireItems-Exception.md @@ -1,5 +1,5 @@ ### Problem -- Import skywalking project to Eclipse,Occur following errors: +- When importing the SkyWalking project to Eclipse, the following errors may occur: > Software being installed: Checkstyle configuration plugin for > M2Eclipse 1.0.0.201705301746 > (com.basistech.m2e.code.quality.checkstyle.feature.feature.group @@ -8,10 +8,10 @@ > 1.0.0.201705301746) requires 'net.sf.eclipsecs.core 5.2.0' but it could not be found ### Reason -Haven't installed Eclipse Checkstyle Plug-in +The Eclipse Checkstyle Plug-in has not been installed. -### Resolve -Download the plugin through the link:https://sourceforge.net/projects/eclipse-cs/?source=typ_redirect，Eclipse Checkstyle Plug-in version:8.7.0.201801131309 plugin required. -plugin notification: -The Eclipse Checkstyle plug-in integrates the Checkstyle Java code auditor into the Eclipse IDE. The plug-in provides real-time feedback to the user about -violations of rules that check for coding style and possible error prone code constructs. \ No newline at end of file +### Resolution +Download the plug-in at the link here: https://sourceforge.net/projects/eclipse-cs/?source=typ_redirect +Eclipse Checkstyle Plug-in version 8.7.0.201801131309 is required. +Plug-in notification: +The Eclipse Checkstyle plug-in integrates the Checkstyle Java code auditor into the Eclipse IDE. The plug-in provides real-time feedback to the user on rule violations, including checking against coding style and error-prone code constructs. diff --git a/docs/en/FAQ/Memory-leak-enhance-Worker-thread.md b/docs/en/FAQ/Memory-leak-enhance-Worker-thread.md index fd5d3884b..02d2500e6 100644 --- a/docs/en/FAQ/Memory-leak-enhance-Worker-thread.md +++ b/docs/en/FAQ/Memory-leak-enhance-Worker-thread.md @@ -1,5 +1,5 @@ ### Problem -When using a thread pool, `TraceSegment` data in a thread cannot be reported and there are memory data that cannot be recycled (memory leaks) +When using a thread pool, `TraceSegment` data in a thread cannot be reported and there are memory data that cannot be recycled (memory leaks). ### Example ``` java @@ -9,16 +9,16 @@ When using a thread pool, `TraceSegment` data in a thread cannot be reported and ### Reason -* Worker threads are enhanced, when using thread pool. -* According to the SkyWalking Java Agent design, when you want to trace cross thread, you need to enhance the task thread. +* Worker threads are enhanced when using the thread pool. +* Based on the design of the SkyWalking Java Agent, when tracing a cross thread, you must enhance the task thread. -### Resolve +### Resolution * When using `Thread Schedule Framework` -Checked SkyWalking Thread Schedule Framework at [SkyWalking Java agent supported list](../setup/service-agent/java-agent/Supported-list.md), such as Spring FrameWork @Async, which can implement tracing without any modification. +See SkyWalking Thread Schedule Framework at [SkyWalking Java agent supported list](../setup/service-agent/java-agent/Supported-list.md), such as Spring FrameWork @Async, which can implement tracing without any modification. * When using `Custom Thread Pool` -Enhance the task thread with the following usage. +Enhance the task thread with the following code. ```java ExecutorService executorService = Executors.newFixedThreadPool(1); @@ -28,5 +28,5 @@ Enhance the task thread with the following usage. } })); ``` -See [across thread solution APIs](../setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md) for more usage +See [across thread solution APIs](../setup/service-agent/java-agent/Application-toolkit-trace-cross-thread.md) for more use cases. diff --git a/docs/en/FAQ/Protoc-Plugin-Fails-When-Build.md b/docs/en/FAQ/Protoc-Plugin-Fails-When-Build.md index bbf12cd3b..11b6b5aa9 100644 --- a/docs/en/FAQ/Protoc-Plugin-Fails-When-Build.md +++ b/docs/en/FAQ/Protoc-Plugin-Fails-When-Build.md @@ -1,12 +1,12 @@ ### Problem -- In maven build, the protoc-plugin occurs error: +- In maven build, the following error may occur with the protoc-plugin: ``` [ERROR] Failed to execute goal org.xolstice.maven.plugins:protobuf-maven-plugin:0.5.0:compile-custom (default) on project apm-network: Unable to copy the file to \skywalking\apm-network\target\protoc-plugins: \skywalking\apm-network\target\protoc-plugins\protoc-3.3.0-linux-x86_64.exe (The process cannot access the file because it is being used by another process) -> [Help 1] ``` ### Reason -- Protobuf compiler is dependent on the glibc, but it is not-installed or installed old version in the system. +- The Protobuf compiler is dependent on the glibc. However, glibc has not been installed, or there is an old version already installed in the system. -### Resolve -- Install or upgrade to the latest version of the glibc library. In container env, recommend using the latest glibc version of the alpine system. -Please refer to http://www.gnu.org/software/libc/documentation.html +### Resolution +- Install or upgrade to the latest version of the glibc library. Under the container environment, the latest glibc version of the alpine system is recommended. +Please refer to http://www.gnu.org/software/libc/documentation.html.