README.md 4.2 KB
Newer Older
1
Apache SkyWalking
wu-sheng's avatar
wu-sheng 已提交
2 3
==========

4
<img src="http://skywalking.apache.org/assets/logo.svg" alt="Sky Walking logo" height="90px" align="right" />
wu-sheng's avatar
wu-sheng 已提交
5

6
**SkyWalking**: an APM(application performance monitor) system, especially designed for
wu-sheng's avatar
wu-sheng 已提交
7
microservices, cloud native and container-based architectures.
wu-sheng's avatar
wu-sheng 已提交
8

9
[![GitHub stars](https://img.shields.io/github/stars/apache/skywalking.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/apache/skywalking)
wu-sheng's avatar
wu-sheng 已提交
10
[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)
wu-sheng's avatar
wu-sheng 已提交
11

wu-sheng's avatar
wu-sheng 已提交
12
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.skywalking/apache-skywalking-apm.svg)](http://skywalking.apache.org/downloads/)
wu-sheng's avatar
wu-sheng 已提交
13
[![CI/IT Tests](https://github.com/apache/skywalking/workflows/CI%20AND%20IT/badge.svg?branch=master)](https://github.com/apache/skywalking/actions?query=workflow%3ACI%2BAND%2BIT+event%3Aschedule+branch%3Amaster)
wu-sheng's avatar
wu-sheng 已提交
14
[![E2E Tests](https://github.com/apache/skywalking/workflows/E2E/badge.svg?branch=master)](https://github.com/apache/skywalking/actions?query=branch%3Amaster+event%3Aschedule+workflow%3AE2E)
wu-sheng's avatar
wu-sheng 已提交
15

16
# Abstract
17
**SkyWalking** is an open source APM system, including monitoring, tracing, diagnosing capabilities for distributed system
18
in Cloud Native architecture.
19

wu-sheng's avatar
wu-sheng 已提交
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
* Distributed Tracing
  * End-to-end distributed tracing. Service topology analysis, service-centric observability and APIs dashboards.
* Agents for your stack
  * Java, .Net Core, PHP, NodeJS, Golang, LUA, Rust, C++, Client JavaScript and Python agents with active development and maintenance.
* eBPF early adoption
  * Rover agent works as metrics collector and profiler powered by eBPF to diagnose CPU and network performance.
* Scaling
  * 100+ billion telemetry data could be collected and analyzed from one SkyWalking cluster.
* Mature Telemetry Ecosystems Supported
  * Metrics, Traces, and Logs from mature ecosystems are supported, e.g. Zipkin, OpenTelemetry, Prometheus, Zabbix, Fluentd
* Native APM Database
  * BanyanDB, an observability database, created in 2022, aims to ingest, analyze and store telemetry/observability data.
* Consistent Metrics Aggregation
  * SkyWalking native meter format and widely known metrics format(OpenCensus, OTLP, Telegraf, Zabbix, e.g.) are processed through the same script pipeline.
* Log Management Pipeline
  * Support log formatting, extract metrics, various sampling policies through script pipeline in high performance.
* Alerting and Telemetry Pipelines
  * Support service-centric, deployment-centric, API-centric alarm rule setting. Support forwarding alarms and all telemetry data to 3rd party.
wu-sheng's avatar
wu-sheng 已提交
38

39
<img src="https://skywalking.apache.org/images/home/architecture.svg?t=20220513"/>
40

wu-sheng's avatar
wu-sheng 已提交
41
# Documentation
wu-sheng's avatar
wu-sheng 已提交
42
- [Official documentation](https://skywalking.apache.org/docs/#SkyWalking)
wu-sheng's avatar
wu-sheng 已提交
43

44

wu-sheng's avatar
wu-sheng 已提交
45
# Downloads
wu-sheng's avatar
wu-sheng 已提交
46 47 48 49
Please head to the [releases page](https://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking.

# Compiling project
Follow this [document](docs/en/guides/How-to-build.md).
wu-sheng's avatar
wu-sheng 已提交
50

wu-sheng's avatar
wu-sheng 已提交
51
# Code of conduct
52 53
This project adheres to the Contributor Covenant [code of conduct](https://www.apache.org/foundation/policies/conduct). By participating, you are expected to uphold this code.
Please follow the [REPORTING GUIDELINES](https://www.apache.org/foundation/policies/conduct#reporting-guidelines) to report unacceptable behavior.
wu-sheng's avatar
wu-sheng 已提交
54

wu-sheng's avatar
wu-sheng 已提交
55
# Live Demo
56
- Find the [live demo](https://skywalking.apache.org/#demo) and [screenshots](https://skywalking.apache.org/#arch) on our website.
57
- Follow the [showcase](https://skywalking.apache.org/docs/skywalking-showcase/next/readme/) to set up preview deployment quickly.
wu-sheng's avatar
wu-sheng 已提交
58

wu-sheng's avatar
wu-sheng 已提交
59
# Contact Us
60
* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.
61
* Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.
62
* Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking)
63
* QQ Group: 901167865, 392443393
wu-sheng's avatar
wu-sheng 已提交
64
* [bilibili B站 视频](https://space.bilibili.com/390683219)
wu-sheng's avatar
wu-sheng 已提交
65

wu-sheng's avatar
wu-sheng 已提交
66
# Our Users
wu-sheng's avatar
wu-sheng 已提交
67
Hundreds of companies and organizations use SkyWalking for research, production, and commercial product.
wu-sheng's avatar
wu-sheng 已提交
68
Visit our [website](http://skywalking.apache.org/users/) to find the user page.
wu-sheng's avatar
wu-sheng 已提交
69

wu-sheng's avatar
wu-sheng 已提交
70
# License
71
[Apache 2.0 License.](LICENSE)