kazusa
/
skywalking-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
skywalking-java/docs/en/concepts-and-designs
History
吴晟 Wu Sheng 9ba17cf228
Polish a log to doc and menu for latest status. (#6446) 
* Polish a log to doc and menu for latest status.

* Add a skip

* Add .github/actions/skip/action.yml itself to skip file

* Polish doc a little

Co-authored-by: Zhenxu Ke <kezhenxu94@apache.org>
 		2021-02-26 07:24:32 +08:00
..
README.md Polish a log to doc and menu for latest status. (#6446) 2021-02-26 07:24:32 +08:00
backend-overview.md Polish a log to doc and menu for latest status. (#6446) 2021-02-26 07:24:32 +08:00
event.md Add a new concept "Event" and its implementations to collect events (#6183) 2021-02-05 18:37:18 +08:00
lal.md Introduce log analysis language (LAL) (#6388) 2021-02-23 20:06:48 +08:00
mal.md Add `sum` function in meter system (#6427) 2021-02-25 15:10:28 +08:00
manual-sdk.md Update some doc. (#5942) 2020-12-03 17:34:37 +08:00
meter.md Support percentile function in the meter system. (#4725) 2020-04-29 08:43:26 +08:00
oal.md docs: fix typo (#6271) 2021-01-30 21:03:04 +08:00
overview.md Polish a log to doc and menu for latest status. (#6446) 2021-02-26 07:24:32 +08:00
probe-introduction.md Fix dead links and add checker to detect them (#6394) 2021-02-18 12:31:22 +08:00
project-goals.md Rename metric and indicator to metrics. (#2643) 2019-05-10 08:05:37 +08:00
scope-definitions.md Support `sideCar.internalErrorCode` in the sources (#5849) 2020-11-17 09:03:48 +08:00
service-agent.md grammar error for "The answer definitely YES" (#6439) 2021-02-25 11:56:50 +08:00
service-mesh-probe.md Fix grammar error on (#6440) 2021-02-25 12:40:49 +08:00
ui-overview.md Reorganize the doc, and provide catalog (#3563) 2019-10-06 15:34:03 +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.
    • Meter Analysis Language. Introduces the way to let the user analyze and aggregate meter data in OAP streaming system.
    • Log Analysis Language. Introduces the Domain-Specific Language (DSL) to analyze logs.
    • Query in OAP. A set of query protocol provided, based on the Observability Analysis Language metrics definition.
  • UI
    • Overview. A simple brief about SkyWalking UI.
  • CLI
  • Events
    • Events. Introduce the concept of "Event" in SkyWalking.