第08讲：搭建 SkyWalking 源码环境，开启征途

搭建 SkyWalking 源码环境

• 下载 SkyWalking 源码

执行 git clone 命令从 GitHub下载 SkyWalking 源码，如下所示 ：

git clone [email protected]:apache/skywalking.git

• 切换分支

等待 clone 完成之后，我们通过命令行窗口进入 SkyWalking 源码根目录，执行如下命令：

git checkout -b 6.2.0 v6.2.0

     切换到 v6.2.0 tag 的源码，后续源码分析过程都是基于 6.2.0 版本进行分析的。

• 导入 IDEA

在 IDEA 中点击“Import Project”，选择 SkyWalking 源码目录导入 IDEA 中。SkyWalking 是一个 Maven，在导入过程中会下载相关的依赖 jar 包，过程可能会比较慢，需要你耐心等待。

• 更新 submodule

全部 Maven 依赖下载完成后，在 SkyWalking 源码根目录中执行如下两条命令，更新 submodule：

git submodule init
git submodule update

• 打包

上述操作执行完毕之后，执行如下命令，开始打包：

mvn clean package -DskipTests -Dcheckstyle.skip

• 标记 Generated Source Code 目录

在打包过程中，会自动生成一些代码，需要我们将其目录设置为 Generated Source Codes，这样 IDEA 才能识别这些代码，生成代码主要来源于以下两种方式：

• SkyWalking Agent 与后端 OAP 之间通信用了 gRPC，其中的 proto 文件会生成一些 Java 代码。

• SkyWalking OAP 中定义了 OAL 语言，打包过程中会生成一些 Java 代码。

具体的标记方式如下下图所示：

需要标记的目录有：

• • apm-protocol/apm-network/target/generated-sources/protobuf 路径下的 grpc-java 目录和 java 目录。

  • oap-server/server-core/target/generated-sources/protobuf 路径下的 grpc-java 目录和 java 目录。

  • oap-server/server-receiver-plugin/receiver-proto/target/generated-sources/protobuf 路径下的 grpc-java 目录和 java 目录。

  • oap-server/exporter/target/generated-sources/protobuf 路径下的 grpc-java 目录和 java 目录。

  • oap-server/server-configuration/grpc-configuration-sync/target/generated-sources/protobuf 路径下的 grpc-java 目录和 java 目录。

  • /Users/xxx/SW/skywalking/oap-server/generated-analysis/target/generated-sources 路径下的 oal 目录。

• 安装 ElasticSearch

前文已经完成了 ElasticSearch 的安装，这里不再展开。

• 启动 OAP

在 IDEA 中，找到 oap-server 模块中 OAPServerStartUp 这个类，右键执行 main() 方法即可。启动过程中无异常日志，并看到如下信息，即表示 OAP 启动成功：

... ... // 省略其他日志
Server started, host 0.0.0.0 listening on 11800

• 启动 SkyWalking Rocketbot

在 IDEA 中，找到 apm-webapp 模块，这是 Spring Boot 的 Web项目，执行 ApplicationStartUp  中的 main() 方法。正常启动之后，访问 localhost:8080，看到 SkyWalking Rocketbot 的 UI 界面即为启动成功。

• 启动 demo-webapp 和 demo-provider

为了验证后端的 OAP 以及前面打包生成的 SkyWalking Agent 是否可用，这里需要启动 demo-webapp 和 demo-provider 两个示例 demo。

• 首先将整个 skywalking-demo 项目移动到与 SkyWalking 源码项目同一级目录，并导入 IDEA 中，如下图所示：

• 然后修改 demo-provider 和 demo-webapp 模块的 VM options 参数，将其中 -javaagent: 命令指向的 skywalking-agent.jar 换成 SkyWalking 源码项目中的 skywalking-agent.jar，具体路径如下所示：

SkyWalking源码目录/skywalking-agent/skywalking-agent.jar

• 其他配置无需修改，依次启动 Zookeeper、demo-provider、demo-webapp。启动成功后访问 http://localhost:8000/hello/xxx。

• 待请求正常响应后，在上一步启动的 SkyWalking Rocketbot 中可以查询到相应的 Trace 信息以及两个项目相关的 Metrics 监控信息，即表示整个源码环境搭建完成。

• Debug SkyWalking 源码

按照上述方式成功搭建 SkyWalking 源码环境之后，我们尝试 Debug SkyWalking 源码。

• 首先在 SkyWalking 源码项目中找到 SkyWalkingAgent.java 这个类（位于 apm-sniffer 模块下的 apm-agent 子模块中），该类是 SkyWalking Agent 的入口，提供了 premain() 方法实现，我们可以在其中打一个断点，然后以 Debug 模式重启 demo-webapp，此时 demo-webapp 会停在该断点处，如下图所示：

SkyWalking源码结构

完成 SkyWalking 源码环境的搭建以及 Debug 的测试之后，我们回到 SkyWalking 源码项目，简单介绍一下 SkyWalking 源码中各模块的基本功能。

SkyWalking 源码的整体结构如下图所示：

• apm-application-toolkit 模块：SkyWalking 提供给用户调用的工具箱。该模块提供了对 log4j、log4j2、logback 等常见日志框架的接入接口，提供了 @Trace 注解等。apm-application-toolkit 模块类似于暴露 API 定义，对应的处理逻辑在 apm-sniffer/apm-toolkit-activation 模块中实现，如下图所示：

• apm-commons 模块：SkyWalking 的公共组件和工具类。如下图所示，其中包含两个子模块，apm-datacarrier 模块提供了一个生产者-消费者模式的缓存组件（DataCarrier），无论是在 Agent 端还是 OAP 端都依赖该组件。apm-util 模块则提供了一些常用的工具类，例如，字符串处理工具类（StringUtil）、占位符处理的工具类（PropertyPlaceholderHelper、PlaceholderConfigurerSupport）等等。

• apache-skywalking-apm 目录：SkyWalking 打包后使用的命令文件都在此目录中，例如，前文启动 OAP 和 SkyWalking Rocketbot 使用的 startup.sh 文件。

• apm-protocol 模块：该模块中只有一个 apm-network 模块，我们需要关注的是其中定义的 .proto 文件，定义 Agent 与后端 OAP 使用 gRPC 交互时的协议。

• apm-sniffer 模块：apm-protocol 模块中有 4 个子模块，如下图所示：

• apm-agent 模块：其中包含了刚才使用的 SkyWalkingAgent 这个类，是整个 Agent 的入口。

• apm-agent-core 模块：SkyWalking Agent 的核心实现都在该模块中，也是本课程第二部分重点分析的模块之一。

• apm-sdk-plugin 模块：SkyWalking Agent 使用了微内核+插件的架构，该模块下包含了 SkyWalking Agent 的全部插件，如下图所示：

• apm-toolkit-activation 模块：apm-application-toolkit 模块的具体实现，不再赘述。

• apm-webapp 模块：SkyWalking Rocketbot 对应的后端。

• oap-server 模块：SkyWalking OAP 的全部实现都在 oap-server 模块，其中包含了多个子模块，如下图所示：

• exporter 模块：负责导出数据。

• generate-tool、generate-tool-grammar、generated-analysis 三个模块：与 SkyWalking 自定义的 OAL 语言有关，后面的课时将对 OAL 进行详细介绍。

• server-alarm-plugin 模块：负责实现 SkyWalking 的告警功能。

• server-cluster-pulgin 模块：负责 OAP 的集群信息管理，其中提供了接入多种第三方组件的相关插件，如下图所示：

• server-configuration 模块：负责管理 OAP 的配置信息，也提供了接入多种配置管理组件的相关插件，如下图所示：

• server-core模块：SkyWalking OAP 的核心实现都在该模块中。

• server-library 模块：OAP 以及 OAP 各个插件依赖的公共模块，其中提供了双队列 Buffer、请求远端的 Client 等工具类，这些模块都是对立于 SkyWalking OAP 体系之外的类库，我们可以直接拿走使用。

• server-query-plugin 模块：SkyWalking Rocketbot 发送的请求首先由该模块接收处理，目前该模块只支持 GraphQL 查询。

• server-receiver-plugin 模块：SkyWalking Agent 发送来的 Metrics、Trace 以及 Register 等写入请求都是首先由该模块接收处理的，不仅如此，该模块还提供了多种接收其他格式写入请求的插件，如下图所示：

• server-starter 模块：OAP 服务启动的入口。

• server-storage-plugin 模块：OAP 服务底层可以使用多种存储来保存 Metrics 数据以及Trace 数据，该模块中包含了接入相关存储的插件，如下图所示：

• skywalking-agent 目录：SkyWalking Agent 编译后生成的 jar 包都会放到该目录中。

• skywalking-ui 目录：SkyWalking Rocketbot 的前端。