README.md 3.4 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, K8s, 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
[![Build Status](https://travis-ci.org/apache/incubator-skywalking.svg?branch=master)](https://travis-ci.org/apache/incubator-skywalking)
11 12
[![GitHub stars](https://img.shields.io/github/stars/apache/incubator-skywalking.svg?style=social&label=Stars)](https://github.com/apache/incubator-skywalking)
[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=social&label=Follow)](https://twitter.com/AsfSkyWalking)
wu-sheng's avatar
wu-sheng 已提交
13
[![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 已提交
14
[![OpenTracing-1.x Badge](https://img.shields.io/badge/OpenTracing--1.x-enabled-blue.svg)](http://opentracing.io)
wu-sheng's avatar
wu-sheng 已提交
15

wu-sheng's avatar
wu-sheng 已提交
16
* Provide Java agent, **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 **when collect all traces**.
wu-sheng's avatar
wu-sheng 已提交
18
  * [Supported middlewares, frameworks and libraries](docs/Supported-list.md).
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
* Pure Java server implementation, provide RESTful and gRPC services. Compatibility with other language agents/SDKs. 
wu-sheng's avatar
wu-sheng 已提交
24
* The UI released on [skywalking-ui](https://github.com/apache/incubator-skywalking-ui)
wu-sheng's avatar
wu-sheng 已提交
25

wu-sheng's avatar
wu-sheng 已提交
26
# Document
wu-sheng's avatar
wu-sheng 已提交
27
[![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 已提交
28

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

wu-sheng's avatar
wu-sheng 已提交
32
# Code of conduct
wu-sheng's avatar
wu-sheng 已提交
33
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 已提交
34

wu-sheng's avatar
wu-sheng 已提交
35
# Screenshots
wu-sheng's avatar
wu-sheng 已提交
36
- Discovery topological graph of application clusters automatically.
wu-sheng's avatar
wu-sheng 已提交
37
<img src="https://skywalkingtest.github.io/page-resources/3.2.1/topological_graph_test_project.png"/>
wu-sheng's avatar
wu-sheng 已提交
38

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

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

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

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

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

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

wu-sheng's avatar
wu-sheng 已提交
60 61
# Contact Us
* Submit an issue
wu-sheng's avatar
wu-sheng 已提交
62
* [Gitter](https://gitter.im/openskywalking/Lobby)
wu-sheng's avatar
wu-sheng 已提交
63
* QQ Group: 392443393
wu-sheng's avatar
wu-sheng 已提交
64 65

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