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

12

wu-sheng's avatar
wu-sheng 已提交
13
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.skywalking/apache-skywalking-apm.svg)](http://skywalking.apache.org/downloads/)
14
[![Build Status](https://travis-ci.org/apache/skywalking.svg?branch=master)](https://travis-ci.org/apache/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 metrics. Detect slow database access statements(including SQL statements).
29 30
- Alarm

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

wu-sheng's avatar
wu-sheng 已提交
32
<img src="http://skywalking.apache.org/assets/frame.jpeg?u=20190518"/>
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 38
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 已提交
39
1. Istio telemetry format
40 41 42
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 已提交
43
1. Jaeger gRPC format.
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
<table>
  <tr>
66
    <td width="100%" align="center" colspan="2"><b>Dashboard</b></td>
wu-sheng's avatar
wu-sheng 已提交
67 68
  </tr>
  <tr>
69 70 71 72 73 74 75 76 77 78
    <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 已提交
79 80
  </tr>
</table>
wu-sheng's avatar
wu-sheng 已提交
81

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

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

wu-sheng's avatar
wu-sheng 已提交
91 92 93 94
# 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.

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

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

wu-sheng's avatar
wu-sheng 已提交
99 100 101 102
# Landscapes

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

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

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