README.md 4.6 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

wu-sheng's avatar
wu-sheng 已提交
9 10
[![GitHub stars](https://img.shields.io/github/stars/apache/incubator-skywalking.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/apache/incubator-skywalking)
[![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

12 13

[![Maven Central](https://img.shields.io/maven-central/v/org.apache.skywalking/apache-skywalking-apm-incubating.svg)](http://skywalking.apache.org/downloads/)
14
[![Build Status](https://travis-ci.org/apache/skywalking.svg?branch=master)](https://travis-ci.org/apache/incubator-skywalking)
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.
wu-sheng's avatar
wu-sheng 已提交
19
The core features are following.
20 21

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

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

32
<img src="http://skywalking.apache.org/assets/frame.jpeg?u=20190311"/>
33

wu-sheng's avatar
wu-sheng 已提交
34
SkyWalking supports to collect telemetry (traces and metrics) data from multiple sources
35 36
and multiple formats,
including
何延龙 已提交
37
1. Java, .NET Core, NodeJS and PHP auto-instrument agents in SkyWalking format
wu-sheng's avatar
wu-sheng 已提交
38
1. Istio telemetry format
39
1. Zipkin v1/v2 format
wu-sheng's avatar
wu-sheng 已提交
40
1. Jaeger gRPC format.
41
1. Envoy metrics format (the metric entries itself is prometheus client [metric family](https://github.com/prometheus/client_model/blob/fd36f4220a901265f90734c3183c5f0c91daa0b8/metrics.proto#L77))
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
wu-sheng's avatar
wu-sheng 已提交
57
- Host in Beijing. Go to [demo](http://106.75.237.45:8080/).
58 59
  - Username: admin
  - Password: admin
wu-sheng's avatar
wu-sheng 已提交
60

61
# Screenshot
wu-sheng's avatar
wu-sheng 已提交
62 63
<table>
  <tr>
64
    <td width="100%" align="center" colspan="2"><b>Dashboard</b></td>
wu-sheng's avatar
wu-sheng 已提交
65 66
  </tr>
  <tr>
67 68 69 70 71 72 73 74 75 76
    <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 已提交
77 78
  </tr>
</table>
wu-sheng's avatar
wu-sheng 已提交
79

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

wu-sheng's avatar
wu-sheng 已提交
83
# Contact Us
84
* Submit an [issue](https://github.com/apache/incubator-skywalking/issues)
85
* 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 已提交
86
* Join `#skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNDQ3OTEwNzE1MDg5LWY2NjkwMTEzMGI2ZTI1NzUzMDk0MzJmMWM1NWVmODg0MzBjNjAxYzUwMjIwNDI3MjlhZWRjNmNhOTM5NmIxNDk)
wu-sheng's avatar
wu-sheng 已提交
87
* QQ Group: 392443393
wu-sheng's avatar
wu-sheng 已提交
88

wu-sheng's avatar
wu-sheng 已提交
89 90 91 92
# Who Uses SkyWalking?
A wide variety of companies and organizations use SkyWalking for research, production and commercial product.
Here is the **User Wall** of SkyWalking.

93
<img src="http://skywalking.apache.org/assets/users-20190422.png"/>
wu-sheng's avatar
wu-sheng 已提交
94

wu-sheng's avatar
wu-sheng 已提交
95
Users are encouraged to add themselves to the [PoweredBy](docs/powered-by.md) page.
wu-sheng's avatar
wu-sheng 已提交
96

wu-sheng's avatar
wu-sheng 已提交
97 98 99 100
# Landscapes

<p align="center">
<br/><br/>
wu-sheng's avatar
wu-sheng 已提交
101
<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 已提交
102 103 104 105 106
<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>

107
<p align="center">
108
<a href="https://openapm.io"><img src="https://openapm.io/static/media/openapm_logo.svg" width="100"/></a>
109 110 111
  <br/>Our project enriches the <a href="https://openapm.io">OpenAPM Landscape!</a>
</p>

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