From 01e69ff0a68c833a79de3055eb7596b4097387d3 Mon Sep 17 00:00:00 2001 From: Wu Sheng Date: Sun, 19 Aug 2018 21:35:55 +0800 Subject: [PATCH 1/2] Update document. --- docs/en/concepts-and-designs/README.md | 2 -- docs/en/concepts-and-designs/backend-overview.md | 3 +++ docs/en/concepts-and-designs/trace-receiver.md | 0 3 files changed, 3 insertions(+), 2 deletions(-) delete mode 100644 docs/en/concepts-and-designs/trace-receiver.md diff --git a/docs/en/concepts-and-designs/README.md b/docs/en/concepts-and-designs/README.md index 7380685fd..e845a3879 100644 --- a/docs/en/concepts-and-designs/README.md +++ b/docs/en/concepts-and-designs/README.md @@ -19,7 +19,5 @@ SkyWalking already support. - [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. - [Query in OAP](query-oap.md). Introduces how to query data from backend, whether a simple metric data or topology map, even trace or log. - - [Receiver for other tracers](trace-receiver.md). Helps you to know the purposes of receiving other libs(such as Zipkin, Jeager, OpenCensus) data. -Also how to process this kind of data format. - UI - [Overview](ui-overview.md). diff --git a/docs/en/concepts-and-designs/backend-overview.md b/docs/en/concepts-and-designs/backend-overview.md index 3dfb40d2a..9c6241c49 100644 --- a/docs/en/concepts-and-designs/backend-overview.md +++ b/docs/en/concepts-and-designs/backend-overview.md @@ -23,6 +23,9 @@ even for Zipkin data format. The AOP analysis the segments to get metrics, and p the streaming aggregation. 1. Consider tracing as some kinds of logging only. Just provide save and visualization capabilities for trace. +Also, SkyWalking accepts trace formats from other project, such as Zipkin, Jeager, OpenCensus. +These formats could be processed in the two ways too. + ## Metric in OAP Metric in OAP is totally new feature in 6 series. Build observability for a distributed system based on metric of connected nodes. No tracing data is required. diff --git a/docs/en/concepts-and-designs/trace-receiver.md b/docs/en/concepts-and-designs/trace-receiver.md deleted file mode 100644 index e69de29bb..000000000 From c2df70674fe3533c77d2b823b415ba2a9ec95f5f Mon Sep 17 00:00:00 2001 From: Wu Sheng Date: Mon, 20 Aug 2018 10:55:13 +0800 Subject: [PATCH 2/2] Adjust documents. --- README.md | 4 ++++ docs/en/concepts-and-designs/README.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 271a2ef62..9fef4ccfb 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ The core features are following. +SkyWalking supports to collect telemetry (traces and metrics) data from different sources, +in order to provide more options +for different scenarios. For better understanding, read our documents. + # Document - [Documents in English](docs/README.md) diff --git a/docs/en/concepts-and-designs/README.md b/docs/en/concepts-and-designs/README.md index e845a3879..2da553fe1 100644 --- a/docs/en/concepts-and-designs/README.md +++ b/docs/en/concepts-and-designs/README.md @@ -2,7 +2,7 @@ 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 it solves. + - [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