119 lines
6.1 KiB
Markdown
119 lines
6.1 KiB
Markdown
Apache SkyWalking
|
|
==========
|
|
|
|
<img src="http://skywalking.apache.org/assets/logo.svg" alt="Sky Walking logo" height="90px" align="right" />
|
|
|
|
**SkyWalking**: an APM(application performance monitor) system, especially designed for
|
|
microservices, cloud native and container-based (Docker, Kubernetes, Mesos) architectures.
|
|
|
|
[](https://github.com/apache/skywalking)
|
|
[](https://twitter.com/AsfSkyWalking)
|
|
|
|
[](http://skywalking.apache.org/downloads/)
|
|
[](https://github.com/apache/skywalking/actions?query=branch%3Amaster+event%3Apush+workflow%3A%22CI+AND+IT%22)
|
|
[](https://github.com/apache/skywalking/actions?query=branch%3Amaster+event%3Apush+workflow%3AE2E)
|
|
[](https://codecov.io/gh/apache/skywalking/branch/master)
|
|
|
|
# Abstract
|
|
**SkyWalking** is an open source APM system, including monitoring, tracing, diagnosing capabilities for distributed system
|
|
in Cloud Native architecture.
|
|
The core features are following.
|
|
|
|
- Service, service instance, endpoint metrics analysis
|
|
- Root cause analysis. Profile the code on the runtime. Read [Apache SkyWalking: Use Profiling to Fix the Blind Spot of Distributed Tracing](https://thenewstack.io/apache-skywalking-use-profiling-to-fix-the-blind-spot-of-distributed-tracing/).
|
|
- Service topology map analysis
|
|
- Service, service instance and endpoint dependency analysis
|
|
- Slow services and endpoints detected
|
|
- Performance optimization
|
|
- Distributed tracing and context propagation
|
|
- Database access metrics. Detect slow database access statements(including SQL statements).
|
|
- Alarm
|
|
|
|
|
|
<img src="http://skywalking.apache.org/assets/frame-v8.jpg?u=20200423"/>
|
|
|
|
SkyWalking supports to collect telemetry (traces and metrics) data from multiple sources
|
|
and multiple formats,
|
|
including
|
|
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.
|
|
1. [Go agent](https://github.com/tetratelabs/go2sky).
|
|
1. [LUA agent](https://github.com/apache/skywalking-nginx-lua), especially for Nginx, OpenResty.
|
|
1. Service Mesh Observability, including Envoy gRPC Access Log Service (ALS) format in Istio controlled service mesh, Istio telemetry.
|
|
1. Metrics system, including Prometheus, Spring Sleuth(Micrometer).
|
|
1. Zipkin v1/v2 and Jaeger gRPC format with limited topology and metrics analysis.(Experimental).
|
|
|
|
# Document
|
|
[8.x dev](docs/README.md) | [7.0](https://github.com/apache/skywalking/blob/v7.0.0/docs/README.md) | [6.6](https://github.com/apache/skywalking/blob/v6.6.0/docs/README.md), [6.5](https://github.com/apache/skywalking/blob/v6.5.0/docs/README.md).
|
|
|
|
NOTICE, SkyWalking 8.0+ uses [v3 protocols](docs/en/protocols/README.md). They are incompatible with previous released.
|
|
|
|
# Downloads
|
|
Please head to the [releases page](http://skywalking.apache.org/downloads/) to download a release of Apache SkyWalking.
|
|
|
|
# Code of conduct
|
|
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
Please follow the [REPORTING GUIDELINES](CODE_OF_CONDUCT.md#reporting-guidelines) to report unacceptable behavior.
|
|
|
|
# Live Demo
|
|
Host in Beijing. Go to [demo](http://122.112.182.72:8080).
|
|
|
|
**Video on youtube.com**
|
|
|
|
[](http://www.youtube.com/watch?v=JC-Anlshqx8)
|
|
|
|
|
|
# Screenshot
|
|
<table>
|
|
<tr>
|
|
<td width="100%" align="center" colspan="2"><b>Dashboard</b></td>
|
|
</tr>
|
|
<tr>
|
|
<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>
|
|
</tr>
|
|
</table>
|
|
|
|
# Compiling project
|
|
Follow this [document](docs/en/guides/How-to-build.md).
|
|
|
|
# Contact Us
|
|
* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.
|
|
* Join `skywalking` channel at [Apache Slack](https://join.slack.com/t/the-asf/shared_invite/enQtNzc2ODE3MjI1MDk1LTAyZGJmNTg1NWZhNmVmOWZjMjA2MGUyOGY4MjE5ZGUwOTQxY2Q3MDBmNTM5YTllNGU4M2QyMzQ4M2U4ZjQ5YmY). If the link is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
|
|
* Twitter, [ASFSkyWalking](https://twitter.com/ASFSkyWalking)
|
|
* QQ Group: 901167865(Recommended), 392443393
|
|
* [bilibili B站 视频](https://space.bilibili.com/390683219)
|
|
|
|
# Who Uses SkyWalking?
|
|
Hundreds of companies and organizations use SkyWalking for research, production, and commercial product.
|
|
|
|
<img src="http://skywalking.apache.org/assets/users-20191216.png"/>
|
|
|
|
The [PoweredBy](docs/powered-by.md) page includes more users of the project.
|
|
Users are encouraged to add themselves to there.
|
|
|
|
# Landscapes
|
|
|
|
<p align="center">
|
|
<br/><br/>
|
|
<img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/> <img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>
|
|
<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>
|
|
|
|
<p align="center">
|
|
<a href="https://openapm.io"><img src="https://openapm.io/static/media/openapm_logo.svg" width="100"/></a>
|
|
<br/>Our project enriches the <a href="https://openapm.io">OpenAPM Landscape!</a>
|
|
</p>
|
|
|
|
# License
|
|
[Apache 2.0 License.](/LICENSE)
|