README.md 4.0 KB
Newer Older
wu-sheng's avatar
wu-sheng 已提交
1
Sky Walking | [中文](README_ZH.md)
wu-sheng's avatar
wu-sheng 已提交
2 3
==========

4
<img src="https://sky-walking.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 3**: APM for Distributed Systems, also known Distributed Tracing System. 
wu-sheng's avatar
wu-sheng 已提交
7

wu-sheng's avatar
wu-sheng 已提交
8
[![Build Status](https://travis-ci.org/wu-sheng/sky-walking.svg?branch=master)](https://travis-ci.org/wu-sheng/sky-walking)
wu-sheng's avatar
wu-sheng 已提交
9
[![Coverage Status](https://coveralls.io/repos/github/wu-sheng/sky-walking/badge.svg?branch=master&forceUpdate=2)](https://coveralls.io/github/wu-sheng/sky-walking?branch=master)
10
![license](https://img.shields.io/aur/license/yaourt.svg)
wu-sheng's avatar
wu-sheng 已提交
11 12
[![codebeat badge](https://codebeat.co/badges/579e4dce-1dc7-4f32-a163-c164eafa1335)](https://codebeat.co/projects/github-com-wu-sheng-sky-walking)
[![Join the chat at https://gitter.im/sky-walking/Lobby](https://badges.gitter.im/sky-walking/Lobby.svg)](https://gitter.im/sky-walking/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
wu-sheng's avatar
wu-sheng 已提交
13
[![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io)
wu-sheng's avatar
wu-sheng 已提交
14

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

wu-sheng's avatar
wu-sheng 已提交
16
* Auto instrumentation by javaagent, **no need to CHANGE any application source code**.
wu-sheng's avatar
wu-sheng 已提交
17
  * High performance agent. Only increase extra **10%** cpu cost in 5000+ tps application, even **do not need to use sampling mechanism**, [check test reports](#test-reports).
wu-sheng's avatar
wu-sheng 已提交
18
  * [Supported middlewares, frameworks and libraries](https://github.com/wu-sheng/sky-walking/wiki/3.2-supported-list).
wu-sheng's avatar
wu-sheng 已提交
19 20 21
* 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 已提交
22
  * Integrate traceId into logs for log4j, log4j2 and logback.
wu-sheng's avatar
wu-sheng 已提交
23 24
* Pure Java server implementation, provide RESTful and gRPC services. Compatibility with other language agents/SDKs. 
  * [How to uplink metrics and traces to collector?]()
wu-sheng's avatar
wu-sheng 已提交
25
* The UI released on [sky-walking-ui](https://github.com/OpenSkywalking/sky-walking-ui)
wu-sheng's avatar
wu-sheng 已提交
26

wu-sheng's avatar
wu-sheng 已提交
27 28 29 30 31
# Architecture
* Architecture graph for 3.2+
<img src="https://sky-walking.github.io/page-resources/3.2/architecture/3.2-architecture.jpg"/>

# Document
wu-sheng's avatar
wu-sheng 已提交
32
* [WIKI](https://github.com/OpenSkywalking/skywalking/wiki)
wu-sheng's avatar
wu-sheng 已提交
33

wu-sheng's avatar
wu-sheng 已提交
34 35
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 wu.sheng@foxmail.com.

wu-sheng's avatar
wu-sheng 已提交
36
# Screenshots
wu-sheng's avatar
wu-sheng 已提交
37
- Topological graph of application clusters based on dubbox and [motan](https://github.com/weibocom/motan).
wu-sheng's avatar
wu-sheng 已提交
38
<img src="https://sky-walking.github.io/page-resources/3.2.1/topological_graph_test_project.png"/>
wu-sheng's avatar
wu-sheng 已提交
39

40
- Trace query.
wu-sheng's avatar
wu-sheng 已提交
41
<img src="https://sky-walking.github.io/page-resources/3.2.1/trace_segment.png"/>
wu-sheng's avatar
wu-sheng 已提交
42

43
- Span detail.
wu-sheng's avatar
wu-sheng 已提交
44
<img src="https://sky-walking.github.io/page-resources/3.2.1/span.png" />
45

wu-sheng's avatar
wu-sheng 已提交
46
- Instance Overview.
wu-sheng's avatar
wu-sheng 已提交
47
<img src="https://sky-walking.github.io/page-resources/3.2.1/instance_health.png"/>
wu-sheng's avatar
wu-sheng 已提交
48

wu-sheng's avatar
wu-sheng 已提交
49
- JVM Detail.
wu-sheng's avatar
wu-sheng 已提交
50
<img src="https://sky-walking.github.io/page-resources/3.2/instance_graph.png"/>
wu-sheng's avatar
wu-sheng 已提交
51

wu-sheng's avatar
wu-sheng 已提交
52
- Services Dependency Tree.
wu-sheng's avatar
wu-sheng 已提交
53
<img src="https://sky-walking.github.io/page-resources/3.2.1/service_dependency_tree.png"/>
wu-sheng's avatar
wu-sheng 已提交
54

wu-sheng's avatar
wu-sheng 已提交
55
# Test reports
wu-sheng's avatar
wu-sheng 已提交
56 57
- Automatic integration test reports
  - [Java Agent test report](https://github.com/sky-walking/agent-integration-test-report)
wu-sheng's avatar
wu-sheng 已提交
58
- Performance test reports
wu-sheng's avatar
wu-sheng 已提交
59
  - [Java Agent test report](https://sky-walking.github.io/Agent-Benchmarks/)
wu-sheng's avatar
wu-sheng 已提交
60

wu-sheng's avatar
wu-sheng 已提交
61 62 63 64 65
# Contact Us
* Submit an issue
* [Gitter](https://gitter.im/sky-walking/Lobby)
* [Google Mailing List](https://groups.google.com/forum/#!forum/skywalking-distributed-tracing-and-apm)
* QQ Group: 392443393
wu-sheng's avatar
wu-sheng 已提交
66

wu-sheng's avatar
wu-sheng 已提交
67 68 69
# Open Skywalking Organization
[Open Skywalking Organization Teams and Contributors](https://github.com/OpenSkywalking/Organization/blob/master/README.md)

70
# Commercial Support Partners
wu-sheng's avatar
wu-sheng 已提交
71
[![Shurenyun Logo](https://sky-walking.github.io/page-resources/partners/shurenyun-logo.png)](https://www.shurenyun.com/)
72

wu-sheng's avatar
wu-sheng 已提交
73 74
# License
By contributing your code, you agree to license your contribution under the terms of the [sky-walking license](/LICENSE).