This is an automated email from the ASF dual-hosted git repository. wusheng pushed a commit to branch doc-menu in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit 4d2eee5763cf081ea4970e8601bc3d5c66ca0f0c Author: Wu Sheng <[email protected]> AuthorDate: Sun Feb 28 10:17:23 2021 +0800 New doc menu. --- docs/en/concepts-and-designs/README.md | 29 ---- docs/en/setup/README.md | 60 -------- docs/en/setup/backend/backend-setup.md | 43 +++++- docs/en/setup/backend/backend-ui-setup.md | 48 ------ docs/en/setup/service-agent/browser-agent.md | 10 ++ docs/en/setup/service-agent/java-agent/README.md | 4 - docs/en/setup/service-agent/server-agents.md | 23 +++ docs/menu.yml | 186 +++++++++++------------ 8 files changed, 162 insertions(+), 241 deletions(-) diff --git a/docs/en/concepts-and-designs/README.md b/docs/en/concepts-and-designs/README.md deleted file mode 100644 index 5db232b..0000000 --- a/docs/en/concepts-and-designs/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Concepts and Designs -Concepts and Designs help you to learn and understand the SkyWalking and the landscape. - -- What is SkyWalking? - - [Overview and Core concepts](overview.md). Provides a high-level description and introduction, including the problems the project solves. - - [Project Goals](project-goals.md). Provides the goals, which SkyWalking is trying to focus and provide features about them. - -After you read the above documents, you should understand the SkyWalking basic goals. Now, you can choose which following parts -you are interested, then dive in. - -- Probe - - [Introduction](probe-introduction.md). Lead readers to understand what the probe is, how many different probes existed and -why need them. - - [Service auto instrument agent](service-agent.md). Introduce what the auto instrument agents do and which languages does -SkyWalking already support. - - [Manual instrument SDK](manual-sdk.md). Introduce the role of the manual instrument SDKs in SkyWalking ecosystem. - - [Service Mesh probe](service-mesh-probe.md). Introduce why and how SkyWalking receive telemetry data from Service mesh and proxy probe. -- Backend - - [Overview](backend-overview.md). Provides a high level introduction about the OAP backend. - - [Observability Analysis Language](oal.md). Introduces the core languages, which is designed for aggregation behaviour definition. - - [Meter Analysis Language](mal.md). Introduces the way to let the user analyze and aggregate meter data in OAP streaming system. - - [Log Analysis Language](lal.md). Introduces the Domain-Specific Language (DSL) to analyze logs. - - [Query in OAP](../protocols/README.md#query-protocol). A set of query protocol provided, based on the Observability Analysis Language metrics definition. -- UI - - [Overview](ui-overview.md). A simple brief about SkyWalking UI. -- CLI - - [SkyWalking CLI](https://github.com/apache/skywalking-cli). A command line interface for SkyWalking. -- Events - - [Events](event.md). Introduce the concept of "Event" in SkyWalking. diff --git a/docs/en/setup/README.md b/docs/en/setup/README.md deleted file mode 100644 index ffcf81f..0000000 --- a/docs/en/setup/README.md +++ /dev/null @@ -1,60 +0,0 @@ -# Setup -The document explains how to install Skywalking based on the kind of probes you are going to use. -If you don't understand, please read [Concepts and Designs](../concepts-and-designs/README.md) first. - - -**Important: Don't forget to configure the timezone on your UI, and you also need to be sure your OAP backend servers are also using the same timezone.** - -If you have any issues, please check that your issue is not already described in the [FAQ](../FAQ/README.md). - -## Download official releases -- Backend, UI and Java agent are Apache official release, you can find them on the [Apache SkyWalking download page](http://skywalking.apache.org/downloads/). - -## Language agents in Service - -- [Java agent](service-agent/java-agent/README.md). Introduces how to install java agent to your service, without any impact in your code. - -- [LUA agent](https://github.com/apache/skywalking-nginx-lua). Introduce how to install the lua agent in Nginx + LUA module or OpenResty. - -- [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. - -The following agents and SDKs are compatible with the SkyWalking's data formats and network protocols, but are maintained by 3rd-parties. -You can go to their project repositories for additional info about guides and releases. - -- [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. - -- [SkyAPM C++ SDK](https://github.com/SkyAPM/cpp2sky). See cpp2sky project document for more details. - -## Browser Monitoring -[Apache SkyWalking Client JS](https://github.com/apache/skywalking-client-js). Support collecting metrics and error logs -for the Browser or JavaScript based mobile app. - -Note, make sure the [`receiver-browser`](backend/backend-receivers.md) has been opened, default is **ON** since 8.2.0. - -## Service Mesh - - - Istio - - [SkyWalking on Istio](istio/README.md). Introduces how to analyze Istio metrics. - - Envoy - - Use [ALS (access log service)](https://www.envoyproxy.io/docs/envoy/latest/api-v2/service/accesslog/v2/als.proto) to observe service mesh, without Mixer. Follow [document](envoy/als_setting.md) for guides. - -## Proxy - - - [Envoy Proxy](https://www.envoyproxy.io/) - - [Sending metrics to Skywalking from Envoy](envoy/metrics_service_setting.md). How to send metrics from Envoy to SkyWalking using [Metrics service](https://www.envoyproxy.io/docs/envoy/latest/api-v2/config/metrics/v2/metrics_service.proto.html). - -## Setup backend - -Follow [backend and UI setup document](backend/backend-ui-setup.md) to understand how the backend and UI configuration works. Different scenarios and advanced features are also explained. - -## Changes log - -Backend, UI and Java agent changes are available [here](../../../CHANGES.md). diff --git a/docs/en/setup/backend/backend-setup.md b/docs/en/setup/backend/backend-setup.md index a51fa9a..3f367a0 100755 --- a/docs/en/setup/backend/backend-setup.md +++ b/docs/en/setup/backend/backend-setup.md @@ -1,6 +1,43 @@ # Backend setup -First and most important thing is, SkyWalking backend startup behaviours are driven by `config/application.yml`. -Understood the setting file will help you to read this document. +SkyWalking backend distribution package includes the following parts: + +1. **bin/cmd scripts**, in `/bin` folder. Includes startup linux shell and Windows cmd scripts for Backend + server and UI startup. + +2. **Backend config**, in `/config` folder. Includes settings files of the backend, which are: + * `application.yml` + * `log4j.xml` + * `alarm-settings.yml` + +3. **Libraries of backend**, in `/oap-libs` folder. All the dependencies of the backend are in it. + +4. **Webapp env**, in `webapp` folder. UI frontend jar file is here, with its `webapp.yml` setting file. + +## Requirements and default settings + +Requirement: **JDK8 to JDK12 are tested**, other versions are not tested and may or may not work. + +Before you start, you should know that the quickstart aims to get you a basic configuration mostly for previews/demo, performance and long-term running are not our goals. + +For production/QA/tests environments, you should head to [Backend and UI deployment documents](#deploy-backend-and-ui). + +You can use `bin/startup.sh` (or cmd) to startup the backend and UI with their default settings, which are: + +- Backend storage uses **H2 by default** (for an easier start) +- Backend listens `0.0.0.0/11800` for gRPC APIs and `0.0.0.0/12800` for http rest APIs. + +In Java, DotNetCore, Node.js, Istio agents/probe, you should set the gRPC service address to `ip/host:11800`, with ip/host where your backend is. +- UI listens on `8080` port and request `127.0.0.1/12800` to do GraphQL query. + +### Interaction + +Before deploying Skywalking in your distributed environment, you should know how agents/probes, backend, UI communicates with each other: + +<img src="https://skywalking.apache.org/doc-graph/communication-net.png"/> + +- All native agents and probes, either language based or mesh probe, are using gRPC service (`core/default/gRPC*` in `application.yml`) to report data to the backend. Also, jetty service supported in JSON format. +- UI uses GraphQL (HTTP) query to access the backend also in Jetty service (`core/default/rest*` in `application.yml`). + ## Startup script The default startup scripts are `/bin/oapService.sh`(.bat). @@ -9,6 +46,8 @@ of starting backend. ## application.yml +SkyWalking backend startup behaviours are driven by `config/application.yml`. +Understood the setting file will help you to read this document. The core concept behind this setting file is, SkyWalking collector is based on pure modularization design. End user can switch or assemble the collector features by their own requirements. diff --git a/docs/en/setup/backend/backend-ui-setup.md b/docs/en/setup/backend/backend-ui-setup.md deleted file mode 100644 index d5939fc..0000000 --- a/docs/en/setup/backend/backend-ui-setup.md +++ /dev/null @@ -1,48 +0,0 @@ -# Backend, UI, and CLI setup - - -SkyWalking backend distribution package includes the following parts: - -1. **bin/cmd scripts**, in `/bin` folder. Includes startup linux shell and Windows cmd scripts for Backend -server and UI startup. - -2. **Backend config**, in `/config` folder. Includes settings files of the backend, which are: - * `application.yml` - * `log4j.xml` - * `alarm-settings.yml` - -3. **Libraries of backend**, in `/oap-libs` folder. All the dependencies of the backend are in it. - -4. **Webapp env**, in `webapp` folder. UI frontend jar file is here, with its `webapp.yml` setting file. - -## Quick start - -### Requirements and default settings - -Requirement: **JDK8 to JDK12 are tested**, other versions are not tested and may or may not work. - -Before you start, you should know that the quickstart aims to get you a basic configuration mostly for previews/demo, performance and long-term running are not our goals. - -For production/QA/tests environments, you should head to [Backend and UI deployment documents](#deploy-backend-and-ui). - -You can use `bin/startup.sh` (or cmd) to startup the backend and UI with their default settings, which are: - -- Backend storage uses **H2 by default** (for an easier start) -- Backend listens `0.0.0.0/11800` for gRPC APIs and `0.0.0.0/12800` for http rest APIs. - -In Java, .NetCore, Node.js, Istio agents/probe, you should set the gRPC service address to `ip/host:11800`, with ip/host where your backend is. -- UI listens on `8080` port and request `127.0.0.1/12800` to do GraphQL query. - -## Deploy Backend and UI - -Before deploying Skywalking in your distributed environment, you should know how agents/probes, backend, UI communicates with each other: - -<img src="https://skywalking.apache.org/doc-graph/communication-net.png"/> - -- All native agents and probes, either language based or mesh probe, are using gRPC service (`core/default/gRPC*` in `application.yml`) to report data to the backend. Also, jetty service supported in JSON format. -- UI uses GraphQL (HTTP) query to access the backend also in Jetty service (`core/default/rest*` in `application.yml`). - -Now, let's continue with the backend, UI and CLI setting documents. -### [Backend setup document](backend-setup.md) -### [UI setup document](ui-setup.md) -### [CLI set up document](https://github.com/apache/skywalking-cli) diff --git a/docs/en/setup/service-agent/browser-agent.md b/docs/en/setup/service-agent/browser-agent.md new file mode 100644 index 0000000..040d2d9 --- /dev/null +++ b/docs/en/setup/service-agent/browser-agent.md @@ -0,0 +1,10 @@ +## Browser Monitoring +[Apache SkyWalking Client JS](https://github.com/apache/skywalking-client-js) is client-side JavaScript exception and tracing library. + +- Provide metrics and error collection to SkyWalking backend. +- Lightweight, no browser plugin, just a simple JavaScript library. +- Make browser as a start of whole distributed tracing. + +Go to the Client JS [official doc](https://github.com/apache/skywalking-client-js#quick-start) to learn more. + +Note, make sure the [`receiver-browser`](../backend/backend-receivers.md) has been opened, default is **ON** since 8.2.0. diff --git a/docs/en/setup/service-agent/java-agent/README.md b/docs/en/setup/service-agent/java-agent/README.md index 134e21f..fd4481d 100755 --- a/docs/en/setup/service-agent/java-agent/README.md +++ b/docs/en/setup/service-agent/java-agent/README.md @@ -237,7 +237,3 @@ our [Plugin Development Guide](../../../guides/Java-Plugin-Development-Guide.md) If you are interested in plugin compatible tests or agent performance, see the following reports. * [Plugin Test in every Pull Request](https://github.com/apache/skywalking/actions?query=workflow%3APluginsTest) * [Java Agent Performance Test](https://skyapmtest.github.io/Agent-Benchmarks/) - -# Notice -ยน Due to gRPC didn't support JDK 1.6 since 2018, SkyWalking abandoned the JDK 6/7 supports in all 7.x releases. -But, with gRPC back forward compatibility(at least for now), all SkyWalking 6.x agents could work with 7.x, including the agent and backend. diff --git a/docs/en/setup/service-agent/server-agents.md b/docs/en/setup/service-agent/server-agents.md new file mode 100644 index 0000000..3f62572 --- /dev/null +++ b/docs/en/setup/service-agent/server-agents.md @@ -0,0 +1,23 @@ +## Language agents in Service + +- [Java agent](java-agent/README.md). Introduces how to install java agent to your service, without any impact in your code. + +- [LUA agent](https://github.com/apache/skywalking-nginx-lua). Introduce how to install the lua agent in Nginx + LUA module or OpenResty. + +- [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. + +The following agents and SDKs are compatible with the SkyWalking's data formats and network protocols, but are maintained by 3rd-parties. +You can go to their project repositories for additional info about guides and releases. + +- [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. + +- [SkyAPM C++ SDK](https://github.com/SkyAPM/cpp2sky). See cpp2sky project document for more details. + diff --git a/docs/menu.yml b/docs/menu.yml index f33a051..13d1a25 100644 --- a/docs/menu.yml +++ b/docs/menu.yml @@ -19,7 +19,6 @@ catalog: - name: "Welcome" path: "/readme" - name: "Concepts and Designs" - path: "/en/concepts-and-designs/readme" catalog: - name: "What is SkyWalking?" catalog: @@ -50,120 +49,109 @@ catalog: - name: "Query in OAP" path: "/en/protocols/readme#query-protocol" - name: "UI" - catalog: - - name: "Overview" - path: "/en/concepts-and-designs/ui-overview" - - event: "Event" + path: "/en/concepts-and-designs/ui-overview" + - name: "CLI" + path: "https://github.com/apache/skywalking-cli"; + - name: "Event" path: "/en/concepts-and-designs/event/" - name: "Setup" - path: "/en/setup/readme" catalog: - - name: "Language agents in Service" + - name: "Java agent" catalog: - - name: "Agents" - path: "/en/setup/readme#language-agents-in-service" - - name: "Java agent" - path: "/en/setup/service-agent/java-agent/readme" - catalog: - - name: "Supported middleware, framework and library" - path: "/en/setup/service-agent/java-agent/Supported-list" - - name: "Agent Configuration Properties" - path: "/en/setup/service-agent/java-agent/readme#table-of-agent-configuration-properties" - - name: "Optional plugins" - path: "/en/setup/service-agent/java-agent/readme#optional-plugins" - - name: "Bootstrap/JVM class plugin" - path: "/en/setup/service-agent/java-agent/readme#bootstrap-class-plugins" - - name: "Advanced reporters" - path: "/en/setup/service-agent/java-agent/readme#advanced-reporters" - - name: "Plugin development guide" - path: "/en/setup/service-agent/java-agent/readme#plugin-development-guide" - - name: "Agent plugin tests and performance tests" - path: "/en/setup/service-agent/java-agent/readme#test" - - - name: "Other language agents" - path: "/en/setup/readme#language-agents-in-service" + - name: "Setup" + path: "/en/setup/service-agent/java-agent/readme" + - name: "Supported middleware, framework and library" + path: "/en/setup/service-agent/java-agent/Supported-list" + - name: "Agent Configuration Properties" + path: "/en/setup/service-agent/java-agent/readme#table-of-agent-configuration-properties" + - name: "Optional plugins" + path: "/en/setup/service-agent/java-agent/readme#optional-plugins" + - name: "Bootstrap/JVM class plugin" + path: "/en/setup/service-agent/java-agent/readme#bootstrap-class-plugins" + - name: "Advanced reporters" + path: "/en/setup/service-agent/java-agent/readme#advanced-reporters" + - name: "Plugin development guide" + path: "/en/guides/java-plugin-development-guide/" + - name: "Java Agent Performance Test" + path: "https://skyapmtest.github.io/Agent-Benchmarks/"; + - name: "All available server agents" + path: "/en/setup/service-agent/server-agents" + - 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: "Proxy" - catalog: - - name: "Envoy Proxy" - path: "https://www.envoyproxy.io/"; - catalog: - - name: "Send Envoy metrics to SkyWalking with / without Istio" - path: "/en/setup/envoy/metrics_service_setting" - - name: "Backend, UI and CLI" - path: "/en/setup/backend/backend-ui-setup" + - name: "Send Envoy metrics to SkyWalking with / without Istio" + path: "/en/setup/envoy/metrics_service_setting" + - name: "Backend" catalog: - - name: "Backend setup" + - name: "Setup" path: "/en/setup/backend/backend-setup" - catalog: - - 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" - 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/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 Analyzer" - path: "/en/setup/backend/log-analyzer" - - name: "UI setup document" - path: "/en/setup/backend/ui-setup" - - name: "CLI setup document" - path: "https://github.com/apache/skywalking-cli"; + - 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" + 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/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 Analyzer" + path: "/en/setup/backend/log-analyzer" + - name: "UI Setup" + path: "/en/setup/backend/ui-setup" + - name: "CLI Setup" + path: "https://github.com/apache/skywalking-cli"; - name: "UI Introduction" path: "/en/ui/readme" - name: "Contributing Guides" - path: "/en/guides/readme" catalog: - - name: "Contact us" - path: "/en/guides/readme#contact-us" - - name: "Process to become official Apache SkyWalking Committer" + - name: "Contribute" + path: "/en/guides/readme" + - name: "Become a committer" path: "/en/guides/asf/committer" - name: "Compiling Guide" path: "/en/guides/How-to-build" @@ -173,6 +161,8 @@ catalog: path: "/en/protocols/readme" - name: "FAQs" path: "/en/FAQ/readme" + - name: "Changelog" + path: "https://github.com/apache/skywalking/tree/master/changes";
![https://skywalking.apache.org/doc-graph/communication-net.png"/](https://skywalking.apache.org/doc-graph/communication-net.png"/){kind=link}