Projects and Documentation

SkyWalking consists of the Server, UI, native storage, and various agents.
You can start by exploring the SkyWalking Server documentation to understand the system's installation and deployment methods,
and then choose the necessary agents and integrations.
If you want to deploy a feature preview directly, you can follow the showcase documentation for a quick deployment.

Quick Start

skywalking

SkyWalking Showcase

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

skywalking-website

SkyWalking Website

This is the repository including all source codes of https://skywalking.apache.org

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.

skywalking

SkyWalking

SkyWalking primary repository and docs.

skywalking

(Experimental) GraalVM Distro

A re-distribution of the Apache SkyWalking OAP server based on GraalVM native image. This is experimental.

rocketbot-ui

Booster UI

The native UI for SkyWalking v9

Grafana Plugins

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

skywalking

Plugin for Service Topology

SkyWalking Grafana Plugins provide extensions to visualize topology on Grafana.

Agents

java-agent

Java Agent

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

python-agent

Python Agent

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

nodejs-agent

NodeJS Agent

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

skywalking-go

Go Agent

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

sw-rust

Rust Agent

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

php-agent

PHP Agent

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

js-agent

Client JavaScript

Apache SkyWalking Client-side JavaScript exception and tracing library.

ruby-agent

Ruby Agent

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

nginx-lua-agent

Nginx LUA Agent

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

kong-agent

Kong Agent

SkyWalking Kong Agent provides the native tracing capability.

skywalking-satellite

SkyWalking Satellite

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

kubernetes

Kubernetes Event Exporter

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

skywalking

SkyWalking Rover

Metrics collector and profiler powered by eBPF to diagnose CPU and network performance.

Operation

skywalking-cli

SkyWalking CLI

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

helm

Kubernetes Helm

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

kubernetes

SkyWalking Cloud on Kubernetes

A bridge project between Apache SkyWalking and Kubernetes.

Protocol

data-collection-protocol

Data Collect Protocol

Apache SkyWalking data collect protocol.

skywalking-query

Query Protocol

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

Go API

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.

banyan-db

BanyanDB

An observability database aims to ingest, analyze and store Metrics, Tracing and Logging data.

banyan-db

BanyanDB Client Proto

Protocol definitions in Protobuf/gRPC for BanyanDB clients

banyan-db

BanyanDB Java Client

The client implementation for SkyWalking BanyanDB in Java

banyan-db

BanyanDB Helm

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

skywalking-eyes

SkyWalking Eyes

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

skywalking-agent-test-tool

SkyWalking Infra E2E

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

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

(Archived) Rocketbot UI

Apache SkyWalking UI for SkyWalking v6/v7/v8

(Archived) Legacy UI

The web UI for skywalking APM v5

(Archived) OAL Generator

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

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

cpp2sky

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

SourceMarker

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

Java Plugin Extensions

Java agent plugin extensions for Apache SkyWalking.

uranus

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

(outdated) CN Documentations

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

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

(Retired) Go2Sky

Replaced by https://skywalking.apache.org/docs/#GoAgent auto-instrument agent.

(Retired) Go2Sky Plugins

Replaced by https://skywalking.apache.org/docs/#GoAgent auto-instrument agent.

(Retired) SkyAPM PHP Agent

Replaced by https://skywalking.apache.org/docs/#PHPAgent

(Retired) SkyAPM Node.js

Replaced by https://skywalking.apache.org/docs/#NodeJSAgent