Sky Walking

SkyWalking: Large-Scale Distributed Systems Tracing Infrastructure, also known Distributed Tracer。

Abstract

• An open source Large-Scale Distributed Systems Tracing Infrastructure, also known a ditributed tracer.
• Based on Google Dapper Paper: Dapper, a Large-Scale Distributed Systems Tracing Infrastructure, Simplified Chines
• Supports popular rpc frameworks, such as dubbo, dubbox, motan etc., supports email-alert when application occurs unexpected exception。
• Execution time of creating span than 100μs.
• Easy to deploy, even in product mode ( since 2.x ) . No need of Hadoop, HBase, or Cassandra Cluster.

Supported components

• web container
  • Tomcat7
  • Tomcat8
• database
  • mysql
  • oracle
  • h2
  • easily extend to support sybase, sqlserver, jtds, db2, informix
• rpc framework
  • dubbo (tested 2.5.3)
  • dubbox (tested 2.8.4-dubbo protocol, 2.8.4-rest protocol)
  • httpClient 4.x
  • motan (tested 0.1.2)
• cache
  • jedix 2.x

Contributors

• 吴晟 wusheng   wu.sheng@foxmail.com
• 张鑫 zhangxin   

---

In October 2016, Sky Walking won OneAPM Open Source Achievement Award. The award appreciates sky walking for its "contribution to popularization of APM technology".
OneAPM will provide financial support for the project in 2016-2017.

Thanks all users of sky walking project.

---

Discussion

* Mail to：wu.sheng@foxmail.com * QQ Group：392443393 * If you are using SkyWalking，[Report to us](https://github.com/wu-sheng/sky-walking/issues/34) please. * **Developer Org of sky-walking** is https://github.com/skywalking-developer

整体架构图

典型页面展现 / Typical UI show

• 支持浏览器：Firefox/Chrome

实时调用链路

• 实时链路追踪展现
• 实时链路追踪详细信息查看
• 实时链路追踪日志查看
• 实时链路异常告警邮件
• 添加应用
• 应用列表展现

分析汇总

• 分析结果查询，根据viewpoint模糊匹配查询。查询方式为viewpoint: + 关键字
• 分析结果展现，通过分析结果查询页面点击进入
• 分析典型调用链展现

v2.0-2016 Quick Start

Required of third party softwares

• JDK 1.8
• zookeeper 3.4.6
• mysql
• redis-3.0.5

instrument javaagent jdk version

• support 1.6+ , instruments applications can run in jdk6

编译与部署 / Build and deploy

• 服务端发布版本下载 (.tar.gz)
• Download Server release version. Download (.tar.gz)
• 配置应用服务器
• config servers
• 如果您想自己编译最新版本，可参考《代码编译说明》
• Code compilation instructions

Download offical agent

• 通过github-release下载
• 通过skywalking bintray官网托管，可使用公网仓库https://jcenter.bintray.com/下载。
• use public repository https://jcenter.bintray.com/ to download sdk

下载并设置授权文件 / Download auth file

• 注册并登陆过skywalking-webui，创建应用。（一个用户代表一个逻辑集群，一个应用代表一个服务集群。如前后端应用应该设置两个应用，但归属一个用户）
• Sign up and login in skywalking-webui. Create application as needed.
• 下载授权文件，放在在agent jar所在目录中
• download auth file(*.auth), and copy the auth file to directory of the agent jar

在运行时环境中设置环境变量 / set environment variables

export SKYWALKING_RUN=true

• 设置完成后，SkyWalking将随应用启动运行
• After set env, SkyWalking will be working, when application startup.

使用-javaagent 并启动应用程序 / start application with -javaagent

• 为应用程序添加启动参数

java -jar ...  -javaagent:/..ospath../skywalking-agent-x.x-Final.jar

• Tomcat可以使用修改启动文件，配置-javaagent参数

在应用程序中显示traceid / How to find tid

• 通过web应用的http调用入口，通过返回的header信息，找到此次调用的traceid。前提：此web应用的url，已经使用skywalking进行监控。

Development Documents

• Development Guide of Plugin

QA

• SkyWalking SDK是否已经工作？ Is SkyWalking SDK Running?
• tid在web-ui上无法查询. tid can't be search on web-ui
• SkyWalking Server的运行情况. The status of SkyWalking Server
• SkyWalking Analysis部署运行常见问题. The FAQ of SkyWalking Analysis deployment

源代码说明

• 网络传输协议、缓存文件协议说明. the protocols of transform between agent and collector, collector buffer file

Recent RoadMap

• [In the schedule] v2.1-2017

  • release a version following OpenTracing.io
  • provide bridge mode lib to integrate data of system and tracer
  • provide English doc as default. Also provide Chinese version on Gitbook or Wiki
  • support log framework(log4j, log4j2, logback) to output traceid in system log.

• [Dev] v2.0-2016

  • 移除对于Hadoop，HBase的依赖，降低部署和运维难度
  • 使用内嵌式数据库，和分布式集群
  • 移除副本发送机制
  • 支持数据文件的时间分片，支持集群TB级别日志文件存储
  • 支持统计和高效的准实时统计汇总
  • 更多插件的支持
    • motan rpc framework (provided)

• [Release] v1.0-Final

  • 客户端与服务端间使用扩展后的网络协议，前置的测试版本无法兼容，以提高服务端的稳定性和健壮性。（在内部使用过程中，发生因为安全扫描，导致服务端宕机）
  • 引入javaagent模式，无需修改任何代码，完成监控。
  • 所有插件将基于字节码技术实现，原有的配置文件模式将被移除。

• [Release] v1.0 beta

  • 修复大量前置版本的BUG
  • 提供基于MR的分析能力，能够对调用链进行分析汇总，并形成调用链统计视图

• [Release] v1.0 alpha2

  • 基于v1.0-alpha1的较稳定版本，在内部环境进行数月运行，修复大量影响服务端运行稳定性的问题。
  • v1.0-beta，将提供定时分析任务，部分分析页面展现功能。
  • 预计：后续版本将在插件模式上有较大改变，计划针对java api的拦截和第三方拦截提供更小侵入性的方法。配置和拦截模式会发生相应变化。具体模式，参考v1.0-beta发布时的说明。

More...