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 2023/12/14 02:42:58 UTC
(skywalking) branch docs created (now 12a3017fc5)
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a change to branch docs
in repository https://gitbox.apache.org/repos/asf/skywalking.git
at 12a3017fc5 Polish docs structure. Move customization docs separately from the introduction docs.
This branch includes the following new commits:
new 12a3017fc5 Polish docs structure. Move customization docs separately from the introduction docs.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
(skywalking) 01/01: Polish docs structure. Move customization docs separately from the introduction docs.
Posted by wu...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch docs
in repository https://gitbox.apache.org/repos/asf/skywalking.git
commit 12a3017fc53dd8609e656e6cb2c1d4d5b73212b7
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Thu Dec 14 10:42:50 2023 +0800
Polish docs structure. Move customization docs separately from the introduction docs.
---
docs/en/changes/changes.md | 1 +
docs/en/concepts-and-designs/backend-overview.md | 14 +++------
docs/en/concepts-and-designs/overview.md | 28 ++++++++++++-----
docs/menu.yml | 39 +++++++++++-------------
4 files changed, 43 insertions(+), 39 deletions(-)
diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index 1498f81d56..f0b7a8bf56 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -19,5 +19,6 @@
#### Documentation
* Update the release doc to remove the announcement as the tests are through e2e rather than manually.
* Update the release notification mail a little.
+* Polish docs structure. Move customization docs separately from the introduction docs.
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/202?closed=1)
diff --git a/docs/en/concepts-and-designs/backend-overview.md b/docs/en/concepts-and-designs/backend-overview.md
index f68d123884..f65783791d 100644
--- a/docs/en/concepts-and-designs/backend-overview.md
+++ b/docs/en/concepts-and-designs/backend-overview.md
@@ -1,17 +1,11 @@
# Observability Analysis Platform
-SkyWalking is an Observability Analysis Platform that provides full observability to services running in both brown and green zones, as well as services using a hybrid model.
+SkyWalking OAP and UI provides dozens of features to support observability analysis for your services, cloud infrastructure, open-source components, and more.
-## Capabilities
-SkyWalking covers all 3 areas of observability, including, **Tracing**, **Metrics** and **Logging**.
-
-- **Tracing**. SkyWalking native data formats, and Zipkin traces of v1 and v2 formats are supported.
-- **Metrics**. SkyWalking supports mature metrics formats, including native meter format, OTEL metrics format, and Telegraf format.
-SkyWalking integrates with Service Mesh platforms, typically Istio and Envoy, to build observability into the data plane
-or control plane. Also, SkyWalking native agents can run in the metrics mode, which greatly improves performances.
-- **Logging**. Includes logs collected from disk or through network. Native agents could bind the tracing context with logs automatically,
-or use SkyWalking to bind the trace and log through the text content.
+Besides those out-of-box features for monitoring, users could leverage the powerful and flexible analysis language to build their own analysis and visualization.
There are 3 powerful and native language engines designed to analyze observability data from the above areas.
1. [Observability Analysis Language](oal.md) processes native traces and service mesh data.
1. [Meter Analysis Language](mal.md) is responsible for metrics calculation for native meter data, and adopts a stable and widely used metrics system, such as Prometheus and OpenTelemetry.
1. [Log Analysis Language](lal.md) focuses on log contents and collaborate with Meter Analysis Language.
+
+SkyWalking community is willing to accept your monitoring extension powered by these languages, if the monitoring is public and general usable.
diff --git a/docs/en/concepts-and-designs/overview.md b/docs/en/concepts-and-designs/overview.md
index 6b6f376b9a..6118bcccb9 100644
--- a/docs/en/concepts-and-designs/overview.md
+++ b/docs/en/concepts-and-designs/overview.md
@@ -3,15 +3,31 @@ SkyWalking is an open source observability platform used to collect, analyze, ag
infrastructures. SkyWalking provides an easy way to maintain a clear view of your distributed systems, even across Clouds.
It is a modern APM, specially designed for cloud native, container based distributed systems.
+SkyWalking covers all the observability needs in Cloud Native world, including:
+- **Tracing**. SkyWalking native data formats, and Zipkin traces of v1 and v2 formats are supported.
+- **Metrics**. SkyWalking supports mature metrics formats, including native meter format, OTEL metrics format, and Telegraf format.
+ SkyWalking integrates with Service Mesh platforms, typically Istio and Envoy, to build observability into the data plane
+ or control plane. Also, SkyWalking native agents can run in the metrics mode, which greatly improves performances.
+- **Logging**. Includes logs collected from disk or through network. Native agents could bind the tracing context with logs automatically,
+ or use SkyWalking to bind the trace and log through the text content.
+- **Profiling**. Profiling is a powerful tool to help developers understand the performance of their applications from lines of codes perspective.
+ SkyWalking provides profiling feature bundled in native language agents and independent ebpf agents.
+- **Event**. Event is a special kind of data, which is used to record the important moments in the system, such as version upgrade, configuration change, etc.
+ Linking the events with metrics could help on explain the peaks or valleys in the metrics, and linking the events with traces and logs could help on troubleshooting root cause.
+
## Why use SkyWalking?
SkyWalking provides solutions for observing and monitoring distributed systems, in many different scenarios. First of all,
-like traditional approaches, SkyWalking provides auto instrument agents for services, such as Java, C#, Node.js, Go, PHP and Nginx LUA.
-(with calls out for Python and C++ SDK contributions).
+like traditional approaches, SkyWalking provides auto instrument agents for services, such as Java, C#, Node.js, Go, PHP and Python,
+and manually SDKs for C++, Rust, and Nginx LUA.
In multi-language, continuously deployed environments, cloud native infrastructures grow more powerful but also more complex.
SkyWalking's service mesh receiver allows SkyWalking to receive telemetry data from service mesh frameworks
-such as Istio/Envoy and Linkerd, allowing users to understand the entire distributed system.
+such as Istio/Envoy, allowing users to understand the entire distributed system. Powered by eBPF stack, SkyWalking provides
+k8s monitoring.
+Also, by adopting OpenTelemetry, Telegraf, Zabbix, Zipkin, Prometheus, SkyWalking can integrate with other distributed tracing, metrics and logging systems
+and build a unified APM system to host all data.
-SkyWalking provides observability capabilities for **service**(s), **service instance**(s), **endpoint**(s), **process**(s). The terms Service,
+Besides the support of various kinds of telemetry formats, the hierarchy structure of objects in SkyWalking is defined as
+**service**(s), **service instance**(s), **endpoint**(s), **process**(s). The terms Service,
Instance and Endpoint are used everywhere today, so it is worth defining their specific meanings in the context of SkyWalking:
- **Service**. Represents a set/group of workloads which provide the same behaviours for incoming requests. You can define the service
@@ -30,10 +46,6 @@ A **layer** represents an abstract framework in computer science, such as Operat
Kubernetes(k8s layer). All detected instances belong to a layer to represent the running environment of this instance,
the service would have one or multiple layer definitions according to its instances.
-In addition, you can integrate
-1. Other distributed tracing using Zipkin.
-1. Other metrics systems, such as Prometheus, Sleuth(Micrometer), OpenTelemetry, Telegraf.
-
## Architecture
SkyWalking is logically split into four parts: Probes, Platform backend, Storage and UI.
diff --git a/docs/menu.yml b/docs/menu.yml
index a876c691fd..6a6432919a 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -20,12 +20,10 @@ catalog:
path: "/readme"
- name: "Concepts and Designs"
catalog:
- - name: "What is SkyWalking?"
- catalog:
- - name: "Overview and Core concepts"
- path: "/en/concepts-and-designs/overview"
- - name: "Project Goals"
- path: "/en/concepts-and-designs/project-goals"
+ - name: "Overview and Core concepts"
+ path: "/en/concepts-and-designs/overview"
+ - name: "Project Goals"
+ path: "/en/concepts-and-designs/project-goals"
- name: "Agents"
catalog:
- name: "Introduction"
@@ -34,21 +32,6 @@ catalog:
path: "/en/concepts-and-designs/service-agent"
- name: "Manual Instrument SDK"
path: "/en/concepts-and-designs/manual-sdk"
- - name: "Observability Analysis Platform"
- catalog:
- - name: "Overview"
- path: "/en/concepts-and-designs/backend-overview"
- - name: "Analysis Traces and Mesh Traffic"
- path: "/en/concepts-and-designs/oal"
- - name: "Analysis Metrics and Meters"
- path: "/en/concepts-and-designs/mal"
- - name: "Analysis Logs"
- path: "/en/concepts-and-designs/lal"
- - name: "Profiling"
- path: "/en/concepts-and-designs/profiling"
- - name: "Event"
- path: "/en/concepts-and-designs/event/"
-
- name: "Setup"
catalog:
- name: "Quick Start"
@@ -165,6 +148,8 @@ catalog:
path: "/en/setup/backend/backend-ebpf-profiling"
- name: "Continuous Profiling"
path: "/en/setup/backend/backend-continuous-profiling"
+ - name: "Event"
+ path: "/en/concepts-and-designs/event/"
- name: "Extension"
catalog:
- name: "Exporter"
@@ -321,6 +306,18 @@ catalog:
path: "/en/api/promql-service"
- name: "LogQL APIs"
path: "/en/api/logql-service"
+ - name: "Customization"
+ catalog:
+ - name: "Overview"
+ path: "/en/concepts-and-designs/backend-overview"
+ - name: "Analysis Traces and Mesh Traffic"
+ path: "/en/concepts-and-designs/oal"
+ - name: "Analysis Metrics and Meters"
+ path: "/en/concepts-and-designs/mal"
+ - name: "Analysis Logs"
+ path: "/en/concepts-and-designs/lal"
+ - name: "Profiling"
+ path: "/en/concepts-and-designs/profiling"
- name: "Security Notice"
path: "/en/security/readme"
- name: "Debugging"