DOCS · 11 SECTIONS

Projects & documentation

SkyWalking is the Server, UI, native storage and many agents. Start with the Server to understand installation and deployment, then pick the agents and integrations you need — or deploy the showcase for a quick preview.

Quick Start SkyWalking Servers Grafana Plugins Agents Operation Protocol Database Support tools for development and testing Archived Repositories Ecosystem Ecosystem Retired Projects

Get started in minutes

Recommended for newcomers

Run the Showcase

A demo music application pre-wired with distributed tracing, metrics, logs and profiling — see SkyWalking end-to-end before installing anything.

bash
1git clone https://github.com/apache/skywalking-showcase
2cd skywalking-showcase
3make deploy.docker
4# → open http://localhost:8080
Showcase docs →
Install the platform

Run SkyWalking

Start the storage, OAP server and UI with a one-liner. Requires Docker; you'll be prompted to choose a storage backend.

bash
1bash <(curl -sSL https://skywalking.apache.org/quickstart-docker.sh)
powershell
1Invoke-Expression ([System.Text.Encoding]::UTF8.GetString((Invoke-WebRequest -Uri https://skywalking.apache.org/quickstart-docker.ps1 -UseBasicParsing).Content))
Backend setup docs →

Quick Start

SkyWalking Showcase
132

A demo music application to showcase features of Apache SkyWalking in action.

SkyWalking Servers

SkyWalking servers include the Observability Analysis Platform (OAP) server and the native UI server. SkyWalking primary docs introduce the concepts, designs, setup, and corresponding APIs referred to telemetry data reports and queries.
Horizon UI
1

Apache SkyWalking next-generation UI (Horizon), natively supporting SkyWalking since v11, and partially for v10.

Grafana Plugins

Metrics visualization on Grafana is supported through PromQL. Please refer to the primary docs for more details.
Plugin for Service Topology
32

SkyWalking Grafana Plugins provide extensions to visualize topology on Grafana.

Agents

Python Agent
215

The Python Agent for Apache SkyWalking, which provides the native tracing/metrics/logging/profiling abilities for Python projects.

NodeJS Agent
175

The NodeJS Agent for Apache SkyWalking, which provides the native tracing abilities for NodeJS projects.

Go Agent
359

The Go Agent for Apache SkyWalking, which provides the native tracing/metrics/logging abilities for Golang projects.

Rust Agent
82

The Rust Agent for Apache SkyWalking, which provides the native tracing/metrics/logging abilities for Rust projects.

PHP Agent
178

The PHP Agent for Apache SkyWalking, which provides the native tracing abilities for PHP projects.

Client JavaScript
268

Apache SkyWalking Client-side JavaScript exception and tracing library.

Ruby Agent
5

The Ruby Agent for Apache SkyWalking, which provides the native tracing abilities for Ruby projects.

Nginx LUA Agent
199

SkyWalking Nginx Agent provides the native tracing capability for Nginx powered by Nginx LUA module.

Kong Agent
33

SkyWalking Kong Agent provides the native tracing capability.

SkyWalking Satellite
112

A lightweight collector/sidecar that could be deployed close to the target (monitored) system, to collect metrics, traces, and logs.

Kubernetes Event Exporter
39

Watch, filter, and send Kubernetes events into Apache SkyWalking.

Operation

SkyWalking CLI
96

SkyWalking CLI is a command interaction tool for SkyWalking users or OPS teams.

SkyWalking MCP
25

Apache SkyWalking MCP Server provides MCP access to SkyWalking observability data.

Kubernetes Helm
548

SkyWalking Kubernetes Helm repository provides ways to install and configure SkyWalking in a Kubernetes cluster. The scripts are written in Helm 3.

Protocol

Data Collect Protocol
118

Apache SkyWalking data collect protocol.

Query Protocol
72

Query Protocol defines the communication protocol in query stage. SkyWalking native UI and CLI use this protocol to fetch data from the backend consistently.

Go API
48

Apache SkyWalking APIs in Golang

Database

BanyanDB server and clients are incubated under SkyWalking umbrella, which aims to provide better native supports to the SkyWalking APM use cases, including better performance and lower resource costs.
BanyanDB Client Proto
4

Protocol definitions in Protobuf/gRPC for BanyanDB clients

BanyanDB Helm
10

BanyanDB Helm Chart repository provides ways to install and configure BanyanDB in a Kubernetes cluster.

Support tools for development and testing

Agent Test Tool
36

SkyWalking Agent Test Tool is a tremendously useful test tools suite in a wide variety of languages of Agent. Includes mock collector and validator.

SkyWalking Eyes
310

A full-featured license tool to check and fix license headers and resolve dependencies’ licenses.

SkyWalking Infra E2E
53

An End-to-End Testing framework that aims to help developers to set up, debug, and verify E2E tests with ease.

Archived Repositories

All following repositories are archived, which means there are no further activities happening there.
(Archived) Docker Files
265

Docker files for Apache SkyWalking(version <= 8.7.0) javaagent, OAP, and UI.

(Archived) Booster UI
206

Apache SkyWalking UI for SkyWalking v9 and v10

(Archived) Rocketbot UI
782

Apache SkyWalking UI for SkyWalking v6/v7/v8

(Archived) Legacy UI
275

The web UI for skywalking APM v5

(Archived) OAL Generator
9

Observability Analysis Language(OAL) Tool is a code generation tool for SkyWalking. From Nov. 6th 2018, merged into main codebase.

Ecosystem

All following repositories are a part of SkyWalking ecosystem, as agent implementations, extensions, or tools. All the source codes and their distributions are not belonging to the Apache Software Foundation.
SkyAPM-dotnet
1657

SkyAPM-dotnet provides the native support agent in C# and .NETStandard platform, with the helps from Apache SkyWalking committer team.

cpp2sky
61

Distributed tracing and monitor SDK in CPP for Apache SkyWalking APM.

SourceMarker
91

JetBrains-powered plugin. Continuous Feedback for Developers / Feedback-Driven Development Tool.

Java Plugin Extensions
140

Java agent plugin extensions for Apache SkyWalking.

uranus
14

A tool helps on locating witness class for Apache SkyWalking plugin.

(outdated) CN Documentations
614

The CN translation version of Apache SkyWalking document. This is NOT official docs and has been out-dated for years.

Ecosystem Retired Projects

All following repositories are a part of SkyWalking ecosystem, but now are retired and archived as read-only.
(Retired) Transporter Plugins
12

3rd-party transporter implementation of Apache SkyWalking. No one is maintaining this.

(Retired) Go2Sky Plugins
67

Replaced by Go Agent auto-instrument agent.