README.md 4.9 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/)
wu-sheng's avatar
wu-sheng 已提交
14
[![Build Status](https://travis-ci.org/apache/incubator-skywalking.svg?branch=master)](https://travis-ci.org/apache/incubator-skywalking)
wu-sheng's avatar
wu-sheng 已提交
15
[![Join the chat at https://gitter.im/sky-walking/Lobby](https://badges.gitter.im/openskywalking/Lobby.svg)](https://gitter.im/openskywalking/Lobby)
wu-sheng's avatar
wu-sheng 已提交
16
[![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io)
wu-sheng's avatar
wu-sheng 已提交
17

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

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

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

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

wu-sheng's avatar
wu-sheng 已提交
36
SkyWalking supports to collect telemetry (traces and metrics) data from multiple sources
37 38
and multiple formats,
including
何延龙 已提交
39
1. Java, .NET Core, NodeJS and PHP auto-instrument agents in SkyWalking format
wu-sheng's avatar
wu-sheng 已提交
40
1. Istio telemetry format
41
1. Zipkin v1/v2 format
wu-sheng's avatar
wu-sheng 已提交
42
1. Jaeger gRPC format.
43
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 已提交
44

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

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

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

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

53

wu-sheng's avatar
wu-sheng 已提交
54
# Code of conduct
55
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 已提交
56
Please follow the [REPORTING GUIDELINES](CODE_OF_CONDUCT.md#reporting-guidelines) to report unacceptable behavior.
wu-sheng's avatar
wu-sheng 已提交
57

wu-sheng's avatar
wu-sheng 已提交
58
# Live Demo
wu-sheng's avatar
wu-sheng 已提交
59
- Host in Beijing. Go to [demo](http://106.75.237.45:8080/).
60 61
  - Username: admin
  - Password: admin
wu-sheng's avatar
wu-sheng 已提交
62

63
# Screenshot
wu-sheng's avatar
wu-sheng 已提交
64 65 66 67 68 69
<table>
  <tr>
    <td width="50%" align="center"><b>Under javaagent observing</b></td>
    <td width="50%" align="center"><b>Observe on Istio</b></td>
  </tr>
  <tr>
70
    <td><img src="http://skywalking.apache.org/screenshots/6.0.0-alpha/Topology.png"/>
wu-sheng's avatar
wu-sheng 已提交
71
</td>
72
    <td><img src="http://skywalking.apache.org/screenshots/6.0.0-alpha/Istio/Topology.png"/>
wu-sheng's avatar
wu-sheng 已提交
73 74 75 76 77 78
</td>
   <tr>
     <td align="center"><a href="docs/Screenshots.md#agent">More screenshots</a></td>
     <td align="center"><a href="docs/Screenshots.md#istio">More screenshots</a></td>
  </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
* [Slack](https://skywalking.slack.com)
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.

wu-sheng's avatar
wu-sheng 已提交
93
<img src="http://skywalking.apache.org/assets/users-20190402.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>

ShardingSphere's avatar
ShardingSphere 已提交
112 113 114
# Stargazers over time
[![Stargazers over time](https://starcharts.herokuapp.com/apache/incubator-skywalking.svg)](https://starcharts.herokuapp.com/apache/incubator-skywalking)

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