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

wu-sheng's avatar
wu-sheng 已提交
4
<img src="https://skywalkingtest.github.io/page-resources/3.0/skywalking.png" alt="Sky Walking logo" height="90px" align="right" />
wu-sheng's avatar
wu-sheng 已提交
5

wu-sheng's avatar
wu-sheng 已提交
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
wu-sheng's avatar
wu-sheng 已提交
19 20
**SkyWalking** is an open source APM system, including monitoring, tracing, diagnosing capabilities for distributed system. 
The core features are following.
21 22

- Service, service instance, endpoint metrics analysis
23
- Root cause analysis
24 25 26
- Service topology map analysis
- Service, service instance and endpoint dependency analysis
- Slow services and endpoints detected
27
- Performance optimization
28 29 30
- Distributed tracing and context propagation
- Alarm

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

32
<img src="https://skywalkingtest.github.io/page-resources/6_overview.png"/>
33

wu-sheng's avatar
wu-sheng 已提交
34 35 36 37
SkyWalking supports to collect telemetry (traces and metrics) data from different sources, 
in order to provide more options
for different scenarios. For better understanding, read our documents.

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

wu-sheng's avatar
wu-sheng 已提交
39
# Document
40
- [Documents in English](docs/README.md)
wu-sheng's avatar
wu-sheng 已提交
41

wu-sheng's avatar
wu-sheng 已提交
42 43 44 45 46 47 48 49
```
5.x is still supported by SkyWalking community, and the agent-backend protocol is compatible with 6.x.
You can go to 5.x branch. At there, you have everything you need.
```

- Go to [5.x pages](https://github.com/apache/incubator-skywalking/tree/5.x)


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
wu-sheng's avatar
wu-sheng 已提交
55
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to wusheng@apache.org.
wu-sheng's avatar
wu-sheng 已提交
56

wu-sheng's avatar
wu-sheng 已提交
57
# Live Demo
wu-sheng's avatar
wu-sheng 已提交
58
- Host in Beijing. [goto](http://49.4.12.44:8080/)
59 60
  - Username: admin
  - Password: admin
wu-sheng's avatar
wu-sheng 已提交
61

62
# Screenshot
63
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-beta2/Dashboard.png"/>
wu-sheng's avatar
wu-sheng 已提交
64

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

66
- [See all screenshots](/docs/Screenshots.md)
wu-sheng's avatar
wu-sheng 已提交
67

68 69
# Compiling project
Follow this [document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md).
wu-sheng's avatar
wu-sheng 已提交
70

wu-sheng's avatar
wu-sheng 已提交
71 72
# Contact Us
* Submit an issue
wu-sheng's avatar
wu-sheng 已提交
73
* Mail list: dev@skywalking.apache.org
wu-sheng's avatar
wu-sheng 已提交
74
* [Gitter](https://gitter.im/openskywalking/Lobby)
wu-sheng's avatar
wu-sheng 已提交
75
* QQ Group: 392443393
wu-sheng's avatar
wu-sheng 已提交
76

wu-sheng's avatar
wu-sheng 已提交
77 78 79 80
# 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 已提交
81
<img src="https://skywalkingtest.github.io/page-resources/users/users-2018-08-12.png"/>
wu-sheng's avatar
wu-sheng 已提交
82

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

85 86 87 88 89
<p align="center">
<a href="https://openapm.io"><img src="https://openapm.io/static/media/openapm_logo.svg" width="100"/></a> 
  <br/>Our project enriches the <a href="https://openapm.io">OpenAPM Landscape!</a>
</p>

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