README.md 4.0 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**: 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

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
wu-sheng's avatar
wu-sheng 已提交
19
**SkyWalking** started as a distributed tracing system in 2015. From 5.x, it evolved to the fully functional [Application Performance Management](https://en.wikipedia.org/wiki/Application_performance_management) 
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
system. It is used for tracing, monitoring, diagnose distributed systems, especially based on microservices, cloud native and container,
including:
- Distributed tracing and context propagation
- Application, instance, service metrics analysis
- Root cause analysis
- Application topology map analysis
- Application and service dependency analysis
- Slow service detected
- Performance optimization

# Core features
- Multiple languages instrumentation agent or libraries 
  - Native Java auto instrumentation agent. Trace and monitor your cluster without changing any source codes
  - Community instrumentation agent or libraries
    * [.NET Core](https://github.com/OpenSkywalking/skywalking-netcore) 
    * [Node.js](https://github.com/OpenSkywalking/skywalking-nodejs)
- Multiple storage backends: ElasticSearch, H2
- [OpenTracing](http://opentracing.io/) compatible
  - Native Java auto instrumentation agent could work with OpenTracing APIs in the same context
- Lightweight and powerful backend aggregation and analysis capabilities
- Modern and cool Web UI
- Log integration
- Alarm for slow or unstable(low SLA) application, instance and service 
43 44 45
- [**Incubating**] Support accepting other tracer data formats.
  - Zipkin JSON, Thrift, Protobuf v1 and v2 formats, powered by [OpenZipkin](https://github.com/openzipkin/zipkin) libs
  - Jaeger in [Zipkin Thrift or JSON v1/v2 formats](https://github.com/jaegertracing/jaeger#backwards-compatibility-with-zipkin)
wu-sheng's avatar
wu-sheng 已提交
46

wu-sheng's avatar
wu-sheng 已提交
47
# Document
48 49
- [Documents in English](docs/README.md)
- [Documents in Chinese](docs/README_ZH.md)
wu-sheng's avatar
wu-sheng 已提交
50

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

wu-sheng's avatar
wu-sheng 已提交
54
# Code of conduct
wu-sheng's avatar
wu-sheng 已提交
55
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 已提交
56

wu-sheng's avatar
wu-sheng 已提交
57
# Live Demo
wu-sheng's avatar
wu-sheng 已提交
58
- Host in Beijing. [goto](http://49.4.12.44:8080/)
wu-sheng's avatar
wu-sheng 已提交
59

60 61
# Screenshot
<img src="https://skywalkingtest.github.io/page-resources/5.0.0-beta/Dashboard.png"/>
wu-sheng's avatar
wu-sheng 已提交
62

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

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

66 67
# Compiling project
Follow this [document](https://github.com/apache/incubator-skywalking/blob/master/docs/en/How-to-build.md).
wu-sheng's avatar
wu-sheng 已提交
68

wu-sheng's avatar
wu-sheng 已提交
69 70
# Contact Us
* Submit an issue
wu-sheng's avatar
wu-sheng 已提交
71
* Mail list: dev@skywalking.apache.org
wu-sheng's avatar
wu-sheng 已提交
72
* [Gitter](https://gitter.im/openskywalking/Lobby)
wu-sheng's avatar
wu-sheng 已提交
73
* QQ Group: 392443393
wu-sheng's avatar
wu-sheng 已提交
74

wu-sheng's avatar
wu-sheng 已提交
75
# Users
wu-sheng's avatar
wu-sheng 已提交
76
<img src="https://skywalkingtest.github.io/page-resources/users/users-2018-06-07.png"/>
wu-sheng's avatar
wu-sheng 已提交
77 78 79

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

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