README.md

Welcome

Here are SkyWalking 8 official documents. You're welcome to join us.

From here you can learn all about SkyWalking’s architecture, how to deploy and use SkyWalking, and develop based on SkyWalking contributions guidelines.

NOTICE, SkyWalking 8 uses brand new tracing APIs, it is incompatible with all previous releases.

• Concepts and Designs. You'll find the the most important core ideas about SkyWalking. You can learn from here if you want to understand what is going on under our cool features and visualization.

• Setup. Guides for installing SkyWalking in different scenarios. As a platform, it provides several ways to provide observability, including monitoring and alarm of course.

• UI Introduction. Introduce the UI usage and features.

• Contributing Guides. Guides are for PMC member, committer or new contributor. Here, you can find how to start contributing.

• Protocols. Protocols show the communication ways between agents/probes and backend. Anyone interested in uplink telemetry data should definitely read this.

• FAQs. A manifest of already known setup problems, secondary developments experiments. When you are facing a problem, check here first.

In addition, you might find these links interesting:

• The latest and old releases are all available at Apache SkyWalking release page. The change logs are here.

• SkyWalking WIKI hosts the context of some changes and events.

• Up-to-date overview of SkyWalking module call flow and hierarchy including ability to analize each module individually.

• You can find the speaking schedules at Conf, online videos and articles about SkyWalking in Community resource catalog.

We're always looking for help improving our documentation and codes, so please don’t hesitate to file an issue if you see any problem. Or better yet, submit your own contributions through pull request to help make them better.

---

Document Catalog

If you are already familiar with SkyWalking, you could use this catalog to find the document chapter directly.

• Concepts and Designs
  • 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 on and provide features about.
  • Probe
    • Introduction. Lead readers to understand what the probe is, how many different probes exists and why we need them.
    • Service auto instrument agent. Introduces what the auto instrument agents do and which languages does SkyWalking already support.
    • Manual instrument SDK. Introduces the role of the manual instrument SDKs in SkyWalking ecosystem.
    • Service Mesh probe. Introduces 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 are designed for aggregation behaviour definition.
    • 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 (Command Line Interface)
    • SkyWalking CLI provides a command line interface to interact with SkyWalking backend (via GraphQL), for more information, click here.
• Setup.
  • Backend, UI, Java agent, and CLI are Apache official release, you could find them at Apache SkyWalking DOWNLOAD page.
  • Language agents in Service
    • Java agent. Introduces how to install the java agent to your service, without changing any code.
      • Supported middleware, framework and library.
      • Agent Configuration Properties.
      • Optional plugins.
      • Bootstrap/JVM class plugin.
      • Advanced features.
      • Plugin development guide.
      • Agent plugin tests and performance tests.
    • Other language agents includes .NetCore, PHP, NodeJS, Go, which are maintained by volunteers.
  • Service Mesh
    • SkyWalking on Istio. Introduces how to use Istio Mixer bypass Adapter to work with SkyWalking.
    • Use ALS (access log service) to observe service mesh, without Mixer. Follow document to open it.
  • Backend, UI and CLI setup document.
    • Backend setup document.
      • Overriding settings in application.yml is supported.
      • IP and port setting. Introduces how IP and port set can be used.
      • Backend init mode startup. How to init the environment and exit graciously. Read this before you try to start a new cluster.
      • Cluster management. Guide about backend server cluster mode.
      • Deploy in kubernetes. Guides you to build and use SkyWalking image, and deploy in k8s.
      • Choose storage. As we know, in default quick start, backend is running with H2 DB. But clearly, it doesn't fit the product env. In here, you could find what other choices do you have. Choose the one you like, we also welcome anyone to contribute new storage implementors.
      • Set receivers. You could choose receivers by your requirements, most receivers are harmless, at least our default receivers are. You would set and active all receivers provided.
      • Do trace sampling at backend. Trace sampling allows you to keep your metrics accurate, whilst only keeping some traces in storage based on rate.
      • Follow slow DB statement threshold config document to understand how to detect slow database statements (including SQL statements) in your system.
      • Official OAL scripts. As you known from our OAL introduction, most of backend analysis capabilities based on the scripts. Here is the description of official scripts, which helps you to understand which metrics data are in process, also could be used in alarm.
      • Alarm. Alarm provides a time-series based check mechanism. You could set alarm rules targeting the analysis oal metrics objects.
      • Advanced deployment options. If you want to deploy backend in very large scale and support high loads, you may need this.
      • Metrics exporter. Use metrics data exporter to forward metrics data to 3rd party systems.
      • Time To Live (TTL). Metrics and traces are time series data, they would be saved forever, you could set the expired time for each dimension.
      • Dynamic Configuration. Make configuration of OAP changed dynamic, from remote service or 3rd party configuration management system.
      • Uninstrumented Gateways. Configure gateways/proxies that are not supported by SkyWalking agent plugins, to reflect the delegation in topology graph.
    • UI setup document.
    • CLI setup document.
• UI Introduction. Introduce the UI usage and features.
• Contributing Guides. Guides are for PMC member, committer or new contributor. At here, you can find how to start contributing.
  • Contact us. Guide users about how to contact the official committer team or communicate with the project community.
  • Process to become official Apache SkyWalking Committer. How to become an official committer or PMC member.
  • Compiling Guide. Follow this to compile the whole project from the source code.
  • Agent plugin development guide. Guide developers to write their plugin, and follow plugin test requirements when you push the plugin to the upstream.
• Protocols. Protocols show the communication ways between agents/probes and backend. Anyone interested in uplink telemetry data should definitely read this.
• FAQs. A manifest of already known setup problems, secondary developments experiments. When you are facing a problem, check here first.