| 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) |
| |
| # 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 |
| - Browser performance monitoring |
| |
| <img src="http://skywalking.apache.org/assets/frame-v8.jpg?u=20201105"/> |
| |
| SkyWalking supports to collect telemetry (traces and metrics) data from multiple sources |
| and multiple formats, |
| including |
| 1. Java, .NET Core, NodeJS, PHP, and Python auto-instrument agents. |
| 1. Go agent. |
| 1. LUA agent especially for Nginx, OpenResty. |
| 1. Service Mesh Observability. Support Mixer telemetry. Recommend to use Envoy Access Log Service (ALS) for better performance, first introduced at [KubeCon 2019](https://www.youtube.com/watch?v=tERm39ju9ew). |
| 1. Metrics system, including Prometheus, OpenTelemetry, Spring Sleuth(Micrometer). |
| 1. Browser application performance, including metrics and error logs. |
| 1. Zipkin v1/v2 and Jaeger gRPC format with limited topology and metrics analysis.(Experimental). |
| |
| SkyWalking OAP is using the STAM(Streaming Topology Analysis Method) to analysis topology in the tracing based agent scenario |
| for better performance. Read [the paper of STAM](https://wu-sheng.github.io/STAM/) for more details. |
| |
| # Documentation |
| Version Series | Version | |
| ----------- | ---------- | |
| 8.x| [8.x dev](docs/README.md)| |
| | | [8.2.0](https://github.com/apache/skywalking/blob/v8.2.0/docs/README.md) | |
| | | [8.1.0](https://github.com/apache/skywalking/blob/v8.1.0/docs/README.md) | |
| | | [8.0.1](https://github.com/apache/skywalking/blob/v8.0.1/docs/README.md) | |
| |
| |
| NOTICE, SkyWalking 8.0+ uses [v3 protocols](docs/en/protocols/README.md). They are incompatible with previous releases. |
| |
| # 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=mfKaToAKl7k) |
| |
| |
| # Screenshot |
| <table> |
| <tr> |
| <td width="100%" align="center" colspan="2"><b>Dashboard</b></td> |
| </tr> |
| <tr> |
| <td><img src="http://skywalking.apache.org/screenshots/8.0.0/dashboard-1.png"/></td> |
| <td><img src="http://skywalking.apache.org/screenshots/8.0.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/8.0.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](http://s.apache.org/slack-invite). 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-20200726.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) |
