README.md 3.9 KB
Newer Older
wu-sheng's avatar
wu-sheng 已提交
1
Apache SkyWalking | [中文](README_ZH.md)
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**: APM (application performance monitor) tool for distributed systems, 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
Underlying technology is a distributed tracing system.
wu-sheng's avatar
wu-sheng 已提交
9

wu-sheng's avatar
wu-sheng 已提交
10 11
[![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 已提交
12

13 14

[![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 已提交
15
[![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 已提交
16
[![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 已提交
17
[![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io)
wu-sheng's avatar
wu-sheng 已提交
18

wu-sheng's avatar
wu-sheng 已提交
19
* Provide Java agent, **no need to CHANGE any application source code**.
wu-sheng's avatar
wu-sheng 已提交
20
  * High performance agent. 
wu-sheng's avatar
wu-sheng 已提交
21
  * [Supported middlewares, frameworks and libraries](docs/Supported-list.md).
wu-sheng's avatar
wu-sheng 已提交
22 23 24
* Manual instrumentation
  * As an [OpenTracing supported tracer](http://opentracing.io/documentation/pages/supported-tracers)
  * Use **@Trace** annotation for any methods you want to trace.
wu-sheng's avatar
wu-sheng 已提交
25
  * Integrate traceId into logs for log4j, log4j2 and logback.
wu-sheng's avatar
wu-sheng 已提交
26
* Pure Java server implementation, provide RESTful and gRPC services. Compatibility with other language agents/SDKs. 
L
Lemon 已提交
27 28
* Community Agents/SDKs
  * [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore)
wu-sheng's avatar
wu-sheng 已提交
29

wu-sheng's avatar
wu-sheng 已提交
30
# Document
wu-sheng's avatar
wu-sheng 已提交
31
[![EN doc](https://img.shields.io/badge/document-English-blue.svg)](docs/README.md) [![cn doc](https://img.shields.io/badge/文档-中文版-blue.svg)](docs/README_ZH.md)
wu-sheng's avatar
wu-sheng 已提交
32

wu-sheng's avatar
wu-sheng 已提交
33
# 5.x Architecture
34 35
<img src="https://skywalkingtest.github.io/page-resources/5.0/architecture.png"/>

wu-sheng's avatar
wu-sheng 已提交
36
# Code of conduct
wu-sheng's avatar
wu-sheng 已提交
37
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 已提交
38

wu-sheng's avatar
wu-sheng 已提交
39
# Live Demo
wu-sheng's avatar
wu-sheng 已提交
40
- Host in Beijing. [goto](http://49.4.12.44:8080/)
wu-sheng's avatar
wu-sheng 已提交
41
- Host in HK. [goto](http://159.138.0.181:8080/)
wu-sheng's avatar
wu-sheng 已提交
42

wu-sheng's avatar
wu-sheng 已提交
43
# Screenshots
wu-sheng's avatar
wu-sheng 已提交
44 45 46
- Overview dashboard
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/Dashboard.png"/>

wu-sheng's avatar
wu-sheng 已提交
47
- Discovery topological graph of application clusters automatically.
wu-sheng's avatar
wu-sheng 已提交
48
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/Topology.png"/>
wu-sheng's avatar
wu-sheng 已提交
49

wu-sheng's avatar
wu-sheng 已提交
50 51
- Application overview
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/Application.png"/>
wu-sheng's avatar
wu-sheng 已提交
52

wu-sheng's avatar
wu-sheng 已提交
53 54
- Server metrics
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/server.png"/>
55

wu-sheng's avatar
wu-sheng 已提交
56 57
- Service metrics
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/Service.png"/>
wu-sheng's avatar
wu-sheng 已提交
58

wu-sheng's avatar
wu-sheng 已提交
59 60
- Trace
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/trace.png"/>
wu-sheng's avatar
wu-sheng 已提交
61

wu-sheng's avatar
wu-sheng 已提交
62 63
- Alarm
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-alpha/application-alarm.png"/>
wu-sheng's avatar
wu-sheng 已提交
64

wu-sheng's avatar
wu-sheng 已提交
65
# Test reports
wu-sheng's avatar
wu-sheng 已提交
66
- Automatic integration test reports
wu-sheng's avatar
wu-sheng 已提交
67
  - [Java Agent test report](https://github.com/SkywalkingTest/agent-integration-test-report)
wu-sheng's avatar
wu-sheng 已提交
68
- Performance test reports
wu-sheng's avatar
wu-sheng 已提交
69
  - [Java Agent test report](https://skywalkingtest.github.io/Agent-Benchmarks/)
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 81
# Users
<img src="https://skywalkingtest.github.io/page-resources/users/users-2018-04-18.png"/>

[Submit new user case to us.](https://github.com/apache/incubator-skywalking/issues/443)

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