README.md 3.9 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
19 20
**SkyWalking** is an open source APM system, including monitoring, tracing, diagnosing capabilities for distributed system
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 30 31
- Distributed tracing and context propagation
- Alarm

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

wu-sheng's avatar
wu-sheng 已提交
33
<img src="https://skywalkingtest.github.io/page-resources/6-alpha-overview.png"/>
34

wu-sheng's avatar
wu-sheng 已提交
35 36 37 38 39 40
SkyWalking supports to collect telemetry (traces and metrics) data from multiple sources
and multiple formats, 
including 
1. Java, .NET Core and NodeJS auto-instrument agents in SkyWalking format
1. Istio telemetry format
1. Zipkin v1/v2 formats
wu-sheng's avatar
wu-sheng 已提交
41

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

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

wu-sheng's avatar
wu-sheng 已提交
46 47 48 49 50
```
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.
```

wu-sheng's avatar
wu-sheng 已提交
51
- Go to [5.x pages](https://github.com/apache/incubator-skywalking/tree/5.x). Also 5.x document is [here](https://github.com/apache/incubator-skywalking/blob/5.x/docs/README.md).
wu-sheng's avatar
wu-sheng 已提交
52 53


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

57

wu-sheng's avatar
wu-sheng 已提交
58
# Code of conduct
59 60
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 dev@skywalking.apache.org .
wu-sheng's avatar
wu-sheng 已提交
61

wu-sheng's avatar
wu-sheng 已提交
62
# Live Demo
X
Xin,Zhang 已提交
63
- Host in Beijing. [goto](http://106.75.237.45:8080/)
64 65
  - Username: admin
  - Password: admin
wu-sheng's avatar
wu-sheng 已提交
66

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

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

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

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

wu-sheng's avatar
wu-sheng 已提交
76
# Contact Us
77
* Submit an [issue](https://github.com/apache/incubator-skywalking/issues)
wu-sheng's avatar
wu-sheng 已提交
78
* Mail list: dev@skywalking.apache.org
wu-sheng's avatar
wu-sheng 已提交
79
* [Gitter](https://gitter.im/openskywalking/Lobby)
wu-sheng's avatar
wu-sheng 已提交
80
* QQ Group: 392443393
wu-sheng's avatar
wu-sheng 已提交
81

wu-sheng's avatar
wu-sheng 已提交
82 83 84 85
# 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 已提交
86
<img src="https://skywalkingtest.github.io/page-resources/users/users-2018-09-07.png"/>
wu-sheng's avatar
wu-sheng 已提交
87

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

90 91 92 93 94
<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 已提交
95
# License
wu-sheng's avatar
wu-sheng 已提交
96
[Apache 2.0 License.](/LICENSE)