README.md 5.4 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 (Docker, Kubernetes, Mesos) 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

14
# Abstract
15
**SkyWalking** is an open source APM system, including monitoring, tracing, diagnosing capabilities for distributed system
16
in Cloud Native architecture.
wu-sheng's avatar
wu-sheng 已提交
17
The core features are following.
18 19

- Service, service instance, endpoint metrics analysis
20
- Root cause analysis
21 22 23
- Service topology map analysis
- Service, service instance and endpoint dependency analysis
- Slow services and endpoints detected
24
- Performance optimization
25
- Distributed tracing and context propagation
26
- Database access metrics. Detect slow database access statements(including SQL statements).
27 28
- Alarm

wu-sheng's avatar
wu-sheng 已提交
29

wu-sheng's avatar
wu-sheng 已提交
30
<img src="http://skywalking.apache.org/assets/frame.jpeg?u=20190518"/>
31

wu-sheng's avatar
wu-sheng 已提交
32
SkyWalking supports to collect telemetry (traces and metrics) data from multiple sources
33 34
and multiple formats,
including
35 36
1. Java, [.NET Core](https://github.com/SkyAPM/SkyAPM-dotnet), [NodeJS](https://github.com/SkyAPM/SkyAPM-nodejs) and [PHP](https://github.com/SkyAPM/SkyAPM-php-sdk) auto-instrument agents in SkyWalking format
1. Manual-instrument [Go agent](https://github.com/tetratelabs/go2sky) in SkyWalking format.
wu-sheng's avatar
wu-sheng 已提交
37
1. Istio telemetry format
38 39 40
1. Envoy gRPC Access Log Service (ALS) format in Istio controlled service mesh
1. Envoy Metrics Service format.
1. Zipkin v1/v2 format.
wu-sheng's avatar
wu-sheng 已提交
41
1. Jaeger gRPC format.
wu-sheng's avatar
wu-sheng 已提交
42

wu-sheng's avatar
wu-sheng 已提交
43

wu-sheng's avatar
wu-sheng 已提交
44
# Document
45
- [6.x Documents](docs/README.md).
wu-sheng's avatar
wu-sheng 已提交
46

wu-sheng's avatar
wu-sheng 已提交
47

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

51

wu-sheng's avatar
wu-sheng 已提交
52
# Code of conduct
53
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
P
panjuan 已提交
54
Please follow the [REPORTING GUIDELINES](CODE_OF_CONDUCT.md#reporting-guidelines) to report unacceptable behavior.
wu-sheng's avatar
wu-sheng 已提交
55

wu-sheng's avatar
wu-sheng 已提交
56
# Live Demo
X
Xin,Zhang 已提交
57
Host in Beijing. Go to [demo](http://122.112.182.72:8080).
wu-sheng's avatar
wu-sheng 已提交
58 59 60 61 62

**Video on youtube.com**

[![RocketBot UI](http://img.youtube.com/vi/JC-Anlshqx8/0.jpg)](http://www.youtube.com/watch?v=JC-Anlshqx8)

wu-sheng's avatar
wu-sheng 已提交
63

64
# Screenshot
wu-sheng's avatar
wu-sheng 已提交
65 66
<table>
  <tr>
67
    <td width="100%" align="center" colspan="2"><b>Dashboard</b></td>
wu-sheng's avatar
wu-sheng 已提交
68 69
  </tr>
  <tr>
70 71 72 73 74 75 76 77 78 79
    <td><img src="http://skywalking.apache.org/screenshots/6.1.0/dashboard-1.png"/></td>
    <td><img src="http://skywalking.apache.org/screenshots/6.1.0/dashboard-2.png"/></td>
  </tr>
  <tr>
      <td width="50%" align="center"><b>Topology Map</b></td>
      <td width="50%" align="center"><b>Trace</b></td>
  </tr>
  <tr>
     <td><img src="http://skywalking.apache.org/screenshots/6.1.0/topology.png"/></td>
     <td><img src="http://skywalking.apache.org/screenshots/6.1.0/trace.png"/></td>
wu-sheng's avatar
wu-sheng 已提交
80 81
  </tr>
</table>
wu-sheng's avatar
wu-sheng 已提交
82

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

wu-sheng's avatar
wu-sheng 已提交
86
# Contact Us
87
* Submit an [issue](https://github.com/apache/skywalking/issues)
88
* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.
wu-sheng's avatar
wu-sheng 已提交
89
* Join `#skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the linke is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
wu-sheng's avatar
wu-sheng 已提交
90
* QQ Group: 392443393(2000/2000, not available), 901167865(available)
wu-sheng's avatar
wu-sheng 已提交
91

wu-sheng's avatar
wu-sheng 已提交
92
# Who Uses SkyWalking?
wu-sheng's avatar
wu-sheng 已提交
93
Hundreds of companies and organizations use SkyWalking for research, production, and commercial product, including
94 95 96 97
1. Anheuser-Busch InBev
1. Agricultural Bank of China
1. Alibaba & Alibaba Cloud
1. Chinese Academy of Sciences
wu-sheng's avatar
wu-sheng 已提交
98
1. China Eastern Airlines
99 100
1. China Express Airlines
1. China Minsheng Bank
wu-sheng's avatar
wu-sheng 已提交
101
1. China Merchants Bank
102
1. China Mobile
103 104 105
1. China Unicom
1. China Telecom
1. China Tower
wu-sheng's avatar
wu-sheng 已提交
106
1. DaoCloud
107
1. DiDi
wu-sheng's avatar
wu-sheng 已提交
108 109 110
1. GOME
1. guazi.com
1. Huawei
111
1. Inspur
wu-sheng's avatar
wu-sheng 已提交
112
1. ke.com
113
1. Lenovo
wu-sheng's avatar
wu-sheng 已提交
114
1. lizhi.fm
wu-sheng's avatar
wu-sheng 已提交
115
1. NetEase
116
1. Ping An Insurance
wu-sheng's avatar
wu-sheng 已提交
117
1. Peking University
118 119 120 121 122
1. Sina
1. SPD Bank
1. State Grid Corporation of China
1. Tencent
1. TravelSky
wu-sheng's avatar
wu-sheng 已提交
123 124 125 126 127 128 129 130
1. tetrate.io
1. WeBank
1. Xiaomi
1. Yonghui Superstores Co., Ltd
1. zhaopin.com

The [PoweredBy](docs/powered-by.md) page includes more users of the project.
Users are encouraged to add themselves to there.
wu-sheng's avatar
wu-sheng 已提交
131

wu-sheng's avatar
wu-sheng 已提交
132 133 134 135
# Landscapes

<p align="center">
<br/><br/>
wu-sheng's avatar
wu-sheng 已提交
136
<img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>
wu-sheng's avatar
wu-sheng 已提交
137 138 139 140 141
<br/><br/>
SkyWalking enriches the <a href="https://landscape.cncf.io/landscape=observability-and-analysis&license=apache-license-2-0">CNCF CLOUD NATIVE Landscape.

</p>

142
<p align="center">
143
<a href="https://openapm.io"><img src="https://openapm.io/static/media/openapm_logo.svg" width="100"/></a>
144 145 146
  <br/>Our project enriches the <a href="https://openapm.io">OpenAPM Landscape!</a>
</p>

wu-sheng's avatar
wu-sheng 已提交
147
# License
wu-sheng's avatar
wu-sheng 已提交
148
[Apache 2.0 License.](/LICENSE)