README.md

Welcome

Here are SkyWalking 6 official documents. Welcome to join us

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

• Concepts and Designs. Concepts and designs explain 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. Setup contains guides for installing SkyWalking in different scenarios. As a platform, it provides several ways to provide observability, including monitoring and alarm of course.
• Contributing Guides. Guides are for PMC member, committer or new contributor. At here, you can know how to contribute from beginning.
• Protocols. Protocols show the communication ways between agents/probes and backend. Anyone, interested in uplink telemetry data, definitely should read this.
• FAQs. Include a manifest, including 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.
• You can find the speaking schedules at Conf, online videos and articles about SkyWalking in Community resource catalog. Also, if you have some related to us, welcome to submit a pull request to add.
• We’re always looking for help improving our documentation and codes, so please don’t hesitate to file an issue if you see some problem. Or better yet, submit your own contributions through pull request to help make them better.

---

Document Catalog

If you have been 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 and provide features about them.
  • 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 metrics definition.
  • UI
    • Overview. A simple brief about SkyWalking UI.
• Setup.
  • Backend, UI and Java agent are Apache official release, you could find them at Apache SkyWalking DOWNLOAD page.
  • Language agents in Service
    • Java agent. Introduce how to install java agent to your service, without change any codes.
      • 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. Introduce 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 and UI setup document.
    • Backend setup document.
      • Overriding settings in application.yml is supported。
      • IP and port setting. Introduce how IP and port set and be used.
      • Backend init mode startup. How to init the environment and exit graciously. Read this before you try to initial a new cluster.
      • Cluster management. Guide you to set backend server in cluster mode.
      • Deploy in kubernetes. Guide 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 are also welcome anyone to contribute new storage implementor,
      • 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. This sample keep the metrics accurate, only don't save some of traces in storage based on rate.
      • Follow slow DB statement threshold config document to understand that, how to detect the 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 payload, you may need this.
      • Metrics exporter. Use metrics data exporter to forward metrics data to 3rd party system.
      • Time To Live (TTL). Metrics and trace 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.
• Contributing Guides. Guides are for PMC member, committer or new contributor. At here, you can know how to contribute from beginning.
  • 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 the developer to write their plugin, and follow plugin test requirement 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, definitely should read this.
• FAQs. Include a manifest, including already known setup problems, secondary developments experiments. When you are facing a problem, check here first.

---

Users from 5.x

SkyWalking 5.x is still supported by the community. For the user plans to upgrade from 5.x to 6.x, you should know there are some definitions of concepts changed.

The most important two changed concepts are

1. Application(in 5.x) is changed to Service(in 6.x), also Application Instance is changed to Service Instance.
2. Service(in 5.x) is changed to Endpoint(in 6.x).