skywalking-java/docs/en/concepts-and-designs
kezhenxu94 4454721030 doc: fix typo and list numbers (#2339) 2019-03-10 18:36:39 +08:00
..
README.md Provide grafana settings for telemetry (#2138) 2019-01-10 07:27:23 +08:00
backend-overview.md Provide cn doc translation about concept and design parts (#2056) 2018-12-29 18:27:11 +08:00
manual-sdk.md Update manual-sdk.md (#2272) 2019-02-22 08:45:14 +08:00
oal.md doc: fix typo and list numbers (#2339) 2019-03-10 18:36:39 +08:00
overview.md Improve document (#2259) 2019-02-19 19:03:00 +08:00
probe-introduction.md Update probe-introduction.md (#2324) 2019-03-07 13:12:06 +08:00
project-goals.md Finish initial documents of overview, project goals and probe-introduction in concepts and designs. 2018-07-09 16:48:14 -07:00
scope-definitions.md 1. Delete service component indicator. (#1809) 2018-10-25 11:19:31 +08:00
service-agent.md Update a document sentence. 2018-07-27 15:47:21 +08:00
service-mesh-probe.md Finish more documents about high level design of SkyWalking 6. 2018-07-09 23:03:35 -07:00
ui-overview.md Provide grafana settings for telemetry (#2138) 2019-01-10 07:27:23 +08:00

README.md

Concepts and Designs

Concepts and Designs help you to learn and understand the SkyWalking and the landscape.

  • What is SkyWalking?
    • Overview and Core concepts. Provides a high-level description and introduction, including the problems the project solves.
    • Project Goals. 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. Lead readers to understand what the probe is, how many different probes existed and why need them.
    • Service auto instrument agent. Introduce what the auto instrument agents do and which languages does SkyWalking already support.
    • Manual instrument SDK. Introduce the role of the manual instrument SDKs in SkyWalking ecosystem.
    • Service Mesh probe. Introduce why and how SkyWalking receive telemetry data from Service mesh and proxy probe.
  • Backend
    • Overview. Provides a high level introduction about the OAP backend.
    • Observability Analysis Language. Introduces the core languages, which is designed for aggregation behaviour definition.
    • Query in OAP. A set of query protocol provided, based on the Observability Analysis Language metric definition.
  • UI
    • Overview. A simple brief about SkyWalking UI.