From e2ee89ec34c93222687f044355bf1e12ab0b20d3 Mon Sep 17 00:00:00 2001 From: mrproliu <741550557@qq.com> Date: Sat, 24 Jun 2023 08:43:12 +0000 Subject: [PATCH] Polish documentation of server agent and continuous profiling policy (#10983) --- docs/en/changes/changes.md | 2 ++ .../backend/backend-continuous-profiling.md | 4 +-- .../service-agent/agent-compatibility.md | 28 +++++++++---------- docs/en/setup/service-agent/server-agents.md | 4 +-- 4 files changed, 20 insertions(+), 18 deletions(-) diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md index 730656a7c6f2..a5dc7e8e8888 100644 --- a/docs/en/changes/changes.md +++ b/docs/en/changes/changes.md @@ -21,6 +21,8 @@ * Fix metric name `browser_app_error_rate` in `Browser-Root` dashboard. #### Documentation +* Add Go agent into the server agent documentation. +* Add data unit description in the configuration of continuous profiling policy. All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/181?closed=1) diff --git a/docs/en/setup/backend/backend-continuous-profiling.md b/docs/en/setup/backend/backend-continuous-profiling.md index 5348e1b89103..e058f59bf9fa 100644 --- a/docs/en/setup/backend/backend-continuous-profiling.md +++ b/docs/en/setup/backend/backend-continuous-profiling.md @@ -24,8 +24,8 @@ Continuous profiling can be configured on a service entity, with the following f 2. **Check Items**: Detection conditions, only one of the multiple condition rules needs to be met to start the task. 1. **Type**: Monitoring type, currently supporting "System Load", "Process CPU", "Process Thread Count", "HTTP Error Rate", "HTTP Avg Response Time". 2. **Threshold**: Check if the monitoring value meets the specified expectations. - 3. **Period**: The time period for monitoring data, which can also be understood as the most recent duration. - 4. **Count**: The number of times the threshold is triggered within the detection period, which can also be understood as the total number of times the specified threshold rule is triggered in the most recent duration. Once the count check is met, the specified Profiling task will be started. + 3. **Period**: The time period(seconds) for monitoring data, which can also be understood as the most recent duration. + 4. **Count**: The number of times(seconds) the threshold is triggered within the detection period, which can also be understood as the total number of times the specified threshold rule is triggered in the most recent duration(seconds). Once the count check is met, the specified Profiling task will be started. 5. **URI**: For HTTP-related monitoring types, used to filter specific URIs. ## Monitoring diff --git a/docs/en/setup/service-agent/agent-compatibility.md b/docs/en/setup/service-agent/agent-compatibility.md index adb377ac0cd8..f9d6996ec35e 100644 --- a/docs/en/setup/service-agent/agent-compatibility.md +++ b/docs/en/setup/service-agent/agent-compatibility.md @@ -4,26 +4,26 @@ SkyWalking 8.0+ uses v3 protocols. Agents don't have to keep the identical versi ## SkyWalking Native Agents -| OAP Server Version | Java | Python | NodeJS | LUA | Kong | Browser Agent | Rust | Rover(ebpf agent) | Satellite | PHP | -|--------------------|---------------|-----------|-----------|-----|------|---------------|------|-------------------|------------|-----| -| 8.0.1 - 8.1.0 | 8.0.0 - 8.3.0 | < = 0.6.0 | < = 0.3.0 | All | All | No | All | No | No | No | -| 8.2.0 - 8.3.0 | 8.0.0 - 8.3.0 | < = 0.6.0 | < = 0.3.0 | All | All | All | All | No | No | No | -| 8.4.0 - 8.8.1 | \> = 8.0.0 | All | All | All | All | All | All | No | No | All | -| 8.9.0+ | \> = 8.0.0 | All | All | All | All | All | All | No | \> = 0.4.0 | All | -| 9.0.0 | \> = 8.0.0 | All | All | All | All | All | All | No | \> = 0.4.0 | All | -| 9.1.0+ | \> = 8.0.0 | All | All | All | All | All | All | \> = 0.1.0 | \> = 1.0.0 | All | -| 9.5.0+ | \> = 8.0.0 | All | All | All | All | All | All | \> = 0.5.0 | \> = 1.2.0 | All | +| OAP Server Version | Java | Python | NodeJS | LUA | Kong | Browser Agent | Rust | Rover(ebpf agent) | Satellite | PHP | Go | +|--------------------|---------------|-----------|-----------|-----|------|---------------|------|-------------------|------------|-----|------------| +| 8.0.1 - 8.1.0 | 8.0.0 - 8.3.0 | < = 0.6.0 | < = 0.3.0 | All | All | No | All | No | No | No | No | +| 8.2.0 - 8.3.0 | 8.0.0 - 8.3.0 | < = 0.6.0 | < = 0.3.0 | All | All | All | All | No | No | No | No | +| 8.4.0 - 8.8.1 | \> = 8.0.0 | All | All | All | All | All | All | No | No | All | No | +| 8.9.0+ | \> = 8.0.0 | All | All | All | All | All | All | No | \> = 0.4.0 | All | No | +| 9.0.0 | \> = 8.0.0 | All | All | All | All | All | All | No | \> = 0.4.0 | All | No | +| 9.1.0+ | \> = 8.0.0 | All | All | All | All | All | All | \> = 0.1.0 | \> = 1.0.0 | All | No | +| 9.5.0+ | \> = 8.0.0 | All | All | All | All | All | All | \> = 0.5.0 | \> = 1.2.0 | All | \> = 0.1.0 | ## Ecosystem Agents All following agent implementations are a part of the SkyWalking ecosystem. All the source codes and their distributions don't belong to the Apache Software Foundation. -| OAP Server Version | DotNet | Go2sky | cpp2sky | -|--------------------|---------------|---------------|-----------| -| 8.0.1 - 8.3.0 | 1.0.0 - 1.3.0 | 0.4.0 - 0.6.0 | < = 0.2.0 | -| 8.4.0+ | \> = 1.0.0 | \> = 0.4.0 | All | -| 9.0.0+ | \> = 1.0.0 | \> = 0.4.0 | All | +| OAP Server Version | DotNet | cpp2sky | +|--------------------|---------------|-----------| +| 8.0.1 - 8.3.0 | 1.0.0 - 1.3.0 | < = 0.2.0 | +| 8.4.0+ | \> = 1.0.0 | All | +| 9.0.0+ | \> = 1.0.0 | All | All these projects are maintained by their own communities, and please reach them if you face any compatibility issues. diff --git a/docs/en/setup/service-agent/server-agents.md b/docs/en/setup/service-agent/server-agents.md index 164457a61e58..ed469faa9d9c 100644 --- a/docs/en/setup/service-agent/server-agents.md +++ b/docs/en/setup/service-agent/server-agents.md @@ -20,12 +20,12 @@ format and maximize the analysis capabilities of the SkyWalking OAP server. - [PHP agent](https://skywalking.apache.org/docs/skywalking-php/next/readme/). Learn how to install the PHP agent in your service without affecting your code. +- [Go agent](https://skywalking.apache.org/docs/skywalking-go/next/readme/). Learn how to integrate the Go agent with a golang service. + The following agents and SDKs are compatible with SkyWalking's data formats and network protocols but are maintained by third parties. See their project repositories for guides and releases. - [SkyAPM .NET Core agent](https://github.com/SkyAPM/SkyAPM-dotnet). See .NET Core agent project documentation for more details. -- [SkyAPM Go SDK](https://github.com/SkyAPM/go2sky). See go2sky project documentation for more details. - - [SkyAPM C++ SDK](https://github.com/SkyAPM/cpp2sky). See cpp2sky project documentation for more details.