You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2021/06/20 06:11:14 UTC
[skywalking] 01/01: Reorganize document menu.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch doc-polish
in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit 84423767b5456deae78439b7a11f9a467ff221c8
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Sun Jun 20 14:10:58 2021 +0800
Reorganize document menu.
---
docs/en/guides/backend-oal-scripts.md | 7 +-
docs/en/setup/backend/backend-cluster.md | 5 +
docs/en/setup/backend/backend-health-check.md | 3 +
docs/en/setup/backend/backend-k8s.md | 3 +
docs/en/setup/backend/backend-setup.md | 72 +------------
docs/en/setup/backend/backend-telemetry.md | 3 +
docs/en/setup/service-agent/server-agents.md | 4 +-
docs/menu.yml | 144 +++++++++++++++-----------
8 files changed, 104 insertions(+), 137 deletions(-)
diff --git a/docs/en/guides/backend-oal-scripts.md b/docs/en/guides/backend-oal-scripts.md
index 0ac01bb..5698422 100644
--- a/docs/en/guides/backend-oal-scripts.md
+++ b/docs/en/guides/backend-oal-scripts.md
@@ -2,9 +2,6 @@
First, read the [OAL introduction](../concepts-and-designs/oal.md).
From 8.0.0, you may find the OAL script at `/config/oal/*.oal` of the SkyWalking dist.
-You could change it, such as by adding filter conditions or new metrics. Then, reboot the OAP server and it will come into effect.
+You could change it, such as by adding filter conditions or new metrics. Then, reboot the OAP server, and it will come into effect.
-All metrics named in this script may be used in alarm and UI query.
-
-Note: If you try to add or remove certain metrics, there is a possibility that the UI would break. You should only do this when you plan
-to build your own UI based on the customization analysis core.
+All metrics named in this script may be used in alarm and UI query.
diff --git a/docs/en/setup/backend/backend-cluster.md b/docs/en/setup/backend/backend-cluster.md
index 7d51b4e..06b250a 100644
--- a/docs/en/setup/backend/backend-cluster.md
+++ b/docs/en/setup/backend/backend-cluster.md
@@ -1,6 +1,11 @@
# Cluster Management
In many product environments, the backend needs to support high throughput and provide HA to maintain robustness,
so you always need cluster management in product env.
+
+NOTICE, cluster management doesn't provide service discovery mechanism for agents and probes. We recommend agents/probes using
+gateway to load balancer to access OAP clusters.
+
+The core feature of cluster management is supporting the whole OAP cluster running distributed aggregation and analysis for telemetry data.
There are various ways to manage the cluster in the backend. Choose the one that best suits your needs.
diff --git a/docs/en/setup/backend/backend-health-check.md b/docs/en/setup/backend/backend-health-check.md
index 36eb61a..85caae5 100644
--- a/docs/en/setup/backend/backend-health-check.md
+++ b/docs/en/setup/backend/backend-health-check.md
@@ -3,6 +3,9 @@
Health check intends to provide a unique approach to check the health status of the OAP server. It includes the health status
of modules, GraphQL, and gRPC services readiness.
+> 0 means healthy, and more than 0 means unhealthy.
+> less than 0 means that the OAP doesn't start up.
+
## Health Checker Module.
The Health Checker module helps observe the health status of modules. You may activate it as follows:
diff --git a/docs/en/setup/backend/backend-k8s.md b/docs/en/setup/backend/backend-k8s.md
index 4119248..561d638 100644
--- a/docs/en/setup/backend/backend-k8s.md
+++ b/docs/en/setup/backend/backend-k8s.md
@@ -1,5 +1,8 @@
# Deploy SkyWalking backend and UI in kubernetes
+Before you read Kubernetes deployment guidance, please make sure you have read `Quick Start` and `Advanced Setup` documents.
+Most SkyWalking OAP settings are controlled through System environment variables when apply helm deployment.
+
Follow instructions in the [deploying SkyWalking backend to Kubernetes cluster](https://github.com/apache/skywalking-kubernetes)
to deploy oap and ui to a kubernetes cluster.
diff --git a/docs/en/setup/backend/backend-setup.md b/docs/en/setup/backend/backend-setup.md
index 69b72c8..543392f 100755
--- a/docs/en/setup/backend/backend-setup.md
+++ b/docs/en/setup/backend/backend-setup.md
@@ -91,74 +91,12 @@ We advise against trying to change the APIs of those modules, unless you underst
The required modules are listed here:
1. **Core**. Provides the basic and major skeleton of all data analysis and stream dispatch.
-1. **Cluster**. Manages multiple backend instances in a cluster, which could provide high throughputs process
-capabilities.
-1. **Storage**. Makes the analysis result persistent.
+1. **Cluster**. Manages multiple backend instances in a cluster, which could provide high throughput process
+capabilities. See [**Cluster Management**](backend-cluster.md) for more details.
+1. **Storage**. Makes the analysis result persistent. See [**Choose storage**](backend-storage.md) for more details
1. **Query**. Provides query interfaces to UI.
-
-**Cluster** and **Storage** have provided multiple implementors (providers). See **Cluster management**
-and **Choose storage** documents in the [link list](#advanced-feature-document-link-list).
-
-Several **receiver** modules are also provided.
-Receiver is the module in charge of accepting incoming data requests to the backend. They usually provide
-services by some network (RPC) protocols, such as gRPC and HTTPRestful.
-The receivers have many different module names. You could
-read the **set receivers** document in the [link list](#advanced-feature-document-link-list).
-
-## Configuration Vocabulary
-All available configurations in `application.yml` could be found in [Configuration Vocabulary](configuration-vocabulary.md).
-
-## Advanced feature document link list
-After understanding the setting file structure, you may learn more about the advanced features.
-You may read the advanced feature documents in the following order.
-
-1. [Overriding settings](backend-setting-override.md) in application.yml are supported.
-1. [IP and port setting](backend-ip-port.md). Introduces how IP and port are set and used.
-1. [Backend init mode startup](backend-init-mode.md). How to initialize the environment and exit graciously.
-Read this before you try to initialize a new cluster.
-1. [Cluster management](backend-cluster.md). Guides you on how to set the backend server in cluster mode.
-1. [Deploy in kubernetes](backend-k8s.md). Guides you on how to build and use the SkyWalking image, and deploy in k8s.
-1. [Choose storage](backend-storage.md). As we know, in default quick start, the backend is running with H2
-DB. But clearly, it doesn't fit the product env. Here you may find out about the other options available to you.
-We also welcome anyone to contribute a new storage implementor.
-1. [Set receivers](backend-receivers.md). You may choose receivers according to your requirements. Most receivers
-are harmless, including our default receivers. You may set and activate all receivers provided.
-1. [Open fetchers](backend-fetcher.md). You may open different fetchers to read metrics from target applications.
-These ones work like receivers, except that they are in pull mode. A typical example is Prometheus.
-1. [Token authentication](backend-token-auth.md). You may add token authentication mechanisms to prevent `OAP` from receiving untrusted data.
-1. Run [trace sampling](trace-sampling.md) at the backend. This sample keeps the metrics accurate, although some of the traces
-in storage are not saved based on rate.
-1. Follow [slow DB statement threshold](slow-db-statement.md) config document to learn about
-how to detect the Slow database statements (including SQL statements) in your system.
-1. Official [OAL scripts](../../guides/backend-oal-scripts.md). As you have seen from our [OAL introduction](../../concepts-and-designs/oal.md),
-most backend analysis capabilities are based on scripts. Here is a detailed description of the official scripts,
-which helps you understand which metrics data are in process, and which could be used in alarm.
-1. [Alarm](backend-alarm.md). Alarm provides a time-series based check mechanism. You may set alarm
-rules targeting the analysis oal metrics objects.
-1. [Advanced deployment options](advanced-deployment.md). If you want to deploy backend in very large
-scale and support high payload, you may need this.
-1. [Metrics exporter](metrics-exporter.md). Use metrics data exporter to forward metrics data to 3rd party
-systems.
-1. [Time To Live (TTL)](ttl.md). Since metrics and trace are time series data, TTL settings affect their expiration time.
-1. [Dynamic Configuration](dynamic-config.md). Configure the OAP to dynamic from remote service
-or 3rd party configuration management systems.
-1. [Uninstrumented Gateways](uninstrumented-gateways.md). Configure gateways/proxies that are not supported by SkyWalking agent plugins to reflect the delegation in topology graph.
-1. [Apdex threshold](apdex-threshold.md). Configure the thresholds for different services if Apdex calculation is activated in the OAL.
-1. [Service Grouping](service-auto-grouping.md). An automatic grouping mechanism for all services based on name.
-1. [Group Parameterized Endpoints](endpoint-grouping-rules.md). Configure the grouping rules for parameterized endpoints to improve the meaning of the metrics.
-1. [OpenTelemetry Metrics Analysis](backend-receivers.md#opentelemetry-receiver). Activate built-in configurations to convert the metrics forwarded from OpenTelemetry collector, and learn how to write your own conversion rules.
-1. [Meter Analysis](backend-meter.md). Set up the backend analysis rules when using [SkyWalking Meter System Toolkit](../service-agent/java-agent/README.md#advanced-features)
-or meter plugins.
-1. [Spring Sleuth Metrics Analysis](spring-sleuth-setup.md). Configure the agent and backend to receiver metrics from micrometer.
-1. [Log Analyzer](log-analyzer.md)
-
-## Telemetry for backend
-The OAP backend cluster itself is a distributed streaming process system. To assist the Ops team,
-we provide the telemetry for the OAP backend itself. Follow the [document](backend-telemetry.md) to use it.
-
-At the same time, we provide [Health Check](backend-health-check.md) to get a score for the health status.
-> 0 means healthy, and more than 0 means unhealthy.
-> less than 0 means that the OAP doesn't start up.
+1. **Receiver** and **Fetcher**. Expose the service to the agents and probes, or read telemetry data from a channel.
+See [Receiver](backend-receivers.md) and [Fetcher](backend-fetcher.md) documents for more details.
## FAQs
#### Why do we need to set the timezone? And when do we do it?
diff --git a/docs/en/setup/backend/backend-telemetry.md b/docs/en/setup/backend/backend-telemetry.md
index 1c9f5af..709a484 100644
--- a/docs/en/setup/backend/backend-telemetry.md
+++ b/docs/en/setup/backend/backend-telemetry.md
@@ -1,4 +1,7 @@
# Telemetry for backend
+The OAP backend cluster itself is a distributed streaming process system. To assist the Ops team,
+we provide the telemetry for the OAP backend itself.
+
By default, the telemetry is disabled by setting `selector` to `none`, like this
```yaml
diff --git a/docs/en/setup/service-agent/server-agents.md b/docs/en/setup/service-agent/server-agents.md
index 3f62572..4e4810f 100644
--- a/docs/en/setup/service-agent/server-agents.md
+++ b/docs/en/setup/service-agent/server-agents.md
@@ -4,6 +4,8 @@
- [LUA agent](https://github.com/apache/skywalking-nginx-lua). Introduce how to install the lua agent in Nginx + LUA module or OpenResty.
+- [Kong agent](https://github.com/apache/skywalking-kong). Introduce how to install the lua agent in Kong.
+
- [Python Agent](https://github.com/apache/skywalking-python). Introduce how to install the Python Agent in a Python service.
- [Node.js agent](https://github.com/apache/skywalking-nodejs). Introduce how to install the NodeJS Agent in a NodeJS service.
@@ -13,8 +15,6 @@ You can go to their project repositories for additional info about guides and re
- [SkyAPM .NET Core agent](https://github.com/SkyAPM/SkyAPM-dotnet). See .NET Core agent project document for more details.
-- [SkyAPM Node.js agent](https://github.com/SkyAPM/SkyAPM-nodejs). See Node.js server side agent project document for more details.
-
- [SkyAPM PHP agent](https://github.com/SkyAPM/SkyAPM-php-sdk). See PHP agent project document for more details.
- [SkyAPM Go SDK](https://github.com/SkyAPM/go2sky). See go2sky project document for more details.
diff --git a/docs/menu.yml b/docs/menu.yml
index 335179b..4781035 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -30,9 +30,9 @@ catalog:
catalog:
- name: "Introduction"
path: "/en/concepts-and-designs/probe-introduction"
- - name: "Service auto instrument agent"
+ - name: "Service Auto Instrument Agent"
path: "/en/concepts-and-designs/service-agent"
- - name: "Manual instrument SDK"
+ - name: "Manual Instrument SDK"
path: "/en/concepts-and-designs/manual-sdk"
- name: "Service Mesh probe"
path: "/en/concepts-and-designs/service-mesh-probe"
@@ -117,72 +117,88 @@ catalog:
path: "/en/guides/java-plugin-development-guide/"
- name: "Java Agent Performance Test"
path: "https://skyapmtest.github.io/Agent-Benchmarks/"
- - name: "All available server agents"
+ - name: "Server Agents"
path: "/en/setup/service-agent/server-agents"
- - name: "Browser agent"
+ - name: "Browser Agent"
path: "/en/setup/service-agent/browser-agent"
- - name: "Service Mesh"
- catalog:
- - name: "Observe Istio Control Plane"
- path: "/en/setup/istio/readme"
- - name: "Observe Service Mesh"
- path: "/en/setup/envoy/als_setting"
- - name: "Send Envoy metrics to SkyWalking with / without Istio"
- path: "/en/setup/envoy/metrics_service_setting"
- name: "Backend"
catalog:
- - name: "Setup"
+ - name: "Quick Start"
path: "/en/setup/backend/backend-setup"
- name: "Configuration Vocabulary"
path: "/en/setup/backend/configuration-vocabulary"
- - name: "Overriding settings"
- path: "/en/setup/backend/backend-setting-override"
- - name: "IP and port setting"
- path: "/en/setup/backend/backend-ip-port"
- - name: "Backend init mode startup"
- path: "/en/setup/backend/backend-init-mode"
- - name: "Cluster management"
- path: "/en/setup/backend/backend-cluster"
- - name: "Deploy in kubernetes"
+ - name: "Advanced Setup"
+ catalog:
+ - name: "Service Grouping"
+ path: "/en/setup/backend/service-auto-grouping"
+ - name: "Overriding Settings"
+ path: "/en/setup/backend/backend-setting-override"
+ - name: "IP And Port Setting"
+ path: "/en/setup/backend/backend-ip-port"
+ - name: "Backend Init Mode Startup"
+ path: "/en/setup/backend/backend-init-mode"
+ - name: "Cluster Management"
+ path: "/en/setup/backend/backend-cluster"
+ - name: "Choose Storage"
+ path: "/en/setup/backend/backend-storage"
+ - name: "Set Receivers"
+ path: "/en/setup/backend/backend-receivers"
+ - name: "Open Fetchers"
+ path: "/en/setup/backend/backend-fetcher"
+ - name: "Advanced Deployment Options"
+ path: "/en/setup/backend/advanced-deployment"
+ - name: "Data Lifecycle. Time To Live (TTL)"
+ path: "/en/setup/backend/ttl"
+ - name: "Deploy In Kubernetes"
path: "/en/setup/backend/backend-k8s"
- - name: "Choose storage"
- path: "/en/setup/backend/backend-storage"
- - name: "Set receivers"
- path: "/en/setup/backend/backend-receivers"
- - name: "Open fetchers"
- path: "/en/setup/backend/backend-fetcher"
- - name: "Trace sampling"
- path: "/en/setup/backend/trace-sampling"
- - name: "Slow DB statement threshold"
- path: "/en/setup/backend/slow-db-statement"
- - name: "OAL scripts"
- path: "/en/guides/backend-oal-scripts"
- - name: "Alarm"
- path: "/en/setup/backend/backend-alarm"
- - name: "Advanced deployment options"
- path: "/en/setup/backend/advanced-deployment"
- - name: "Metrics exporter"
- path: "/en/setup/backend/metrics-exporter"
- - name: "Time To Live (TTL)"
- path: "/en/setup/backend/ttl"
- - name: "Dynamic Configuration"
- path: "/en/setup/backend/dynamic-config"
- - name: "Uninstrumented Gateways"
- path: "/en/setup/backend/uninstrumented-gateways"
- - name: "Apdex Threshold"
- path: "/en/setup/backend/apdex-threshold"
- - name: "Service Grouping"
- path: "/en/setup/backend/service-auto-grouping"
- - name: "Group Parameterized Endpoints"
- path: "/en/setup/backend/endpoint-grouping-rules"
- - name: "OpenTelemetry Metrics Analysis"
- path: "/en/setup/backend/backend-receivers#opentelemetry-receiver"
- - name: "Meter Analysis"
- path: "/en/setup/backend/backend-meter"
- - name: "Spring Sleuth Metrics Analysis"
- path: "/en/setup/backend/spring-sleuth-setup"
- - name: "Log Collecting And Analysis"
- path: "/en/setup/backend/log-analyzer"
+ - name: "Tracing"
+ catalog:
+ - name: "Trace Sampling"
+ path: "/en/setup/backend/trace-sampling"
+ - name: "Detect Slow Database Statement"
+ path: "/en/setup/backend/slow-db-statement"
+ - name: "Uninstrumented Gateways"
+ path: "/en/setup/backend/uninstrumented-gateways"
+ - name: "Metrics"
+ catalog:
+ - name: "OAL Scripts"
+ path: "/en/guides/backend-oal-scripts"
+ - name: "Group Parameterized Endpoints"
+ path: "/en/setup/backend/endpoint-grouping-rules"
+ - name: "OpenTelemetry Metrics Analysis"
+ path: "/en/setup/backend/backend-receivers#opentelemetry-receiver"
+ - name: "Meter Analysis"
+ path: "/en/setup/backend/backend-meter"
+ - name: "Apdex Threshold"
+ path: "/en/setup/backend/apdex-threshold"
+ - name: "Spring Sleuth Metrics Analysis"
+ path: "/en/setup/backend/spring-sleuth-setup"
+ - name: "Alarm"
+ path: "/en/setup/backend/backend-alarm"
+ - name: "Logging"
+ catalog:
+ - name: "Log Collecting And Analysis"
+ path: "/en/setup/backend/log-analyzer"
+ - name: "Self Observability"
+ catalog:
+ - name: "Backend Telemetry"
+ path: "/en/setup/backend/backend-telemetry"
+ - name: "Health Check"
+ path: "/en/setup/backend/backend-health-check"
+ - name: "Extension"
+ catalog:
+ - name: "Metrics Exporter"
+ path: "/en/setup/backend/metrics-exporter"
+ - name: "Dynamic Configuration"
+ path: "/en/setup/backend/dynamic-config"
+ - name: "Service Mesh"
+ catalog:
+ - name: "Observe Istio Control Plane"
+ path: "/en/setup/istio/readme"
+ - name: "Observe Service Mesh"
+ path: "/en/setup/envoy/als_setting"
+ - name: "Send Envoy Metrics to SkyWalking with / without Istio"
+ path: "/en/setup/envoy/metrics_service_setting"
- name: "Infrastructure Monitoring"
path: "/en/setup/backend/backend-infrastructure-monitoring"
- name: "UI Setup"
@@ -195,12 +211,14 @@ catalog:
catalog:
- name: "Contribute"
path: "/en/guides/readme"
- - name: "Become a committer"
+ - name: "Agent Plugin Development Guide"
+ path: "/en/guides/Java-Plugin-Development-Guide"
+ - name: "Become A Committer"
path: "/en/guides/asf/committer"
+ - name: "Release Guide"
+ path: "/en/guides/how-to-release/"
- name: "Compiling Guide"
path: "/en/guides/How-to-build"
- - name: "Agent plugin development guide"
- path: "/en/guides/Java-Plugin-Development-Guide"
- name: "Protocols"
path: "/en/protocols/readme"
- name: "FAQs"