Apache SkyWalking 按照和使用文档
1. 项目的目录结构及介绍
Apache SkyWalking 的项目目录结构如下:
.
├── .github
├── .mvn
├── apm-checkstyle
├── apm-dist
├── apm-protocol
├── apm-webapp
├── changes
├── dist-material
├── docker
├── docs
├── oap-server-bom
├── oap-server
├── skywalking-ui
├── test
├── tools
├── .asf.yaml
├── .dlc.json
├── .gitignore
├── .gitmodules
├── .licenserc.yaml
├── CONTRIBUTING.md
├── HEADER
├── LICENSE
├── Makefile
├── NOTICE
├── README.md
├── codeStyle.xml
├── lombok.config
├── mvnw
├── mvnw.cmd
├── pom.xml
以下是主要目录和文件的简要说明:
.github
: 存放与 GitHub 相关的配置文件。.mvn
: Maven 本地仓库的配置文件。apm-checkstyle
: 检查代码风格的配置和脚本。apm-dist
: 分发构建产物的地方。apm-protocol
: 定义了 SkyWalking 的通信协议。apm-webapp
: SkyWalking 的前端应用。oap-server
: Observability Analysis Platform (OAP) 服务器的核心代码。skywalking-ui
: SkyWalking 用户界面的代码。docs
: SkyWalking 的官方文档。docker
: 包含用于 Docker 镜像构建的 Dockerfile。tools
: 项目的工具脚本和配置。README.md
: 项目描述和基本信息。LICENSE
: 项目所使用的 Apache 2.0 许可证。pom.xml
: Maven 项目对象模型文件,包含项目的构建配置。
2. 项目的启动文件介绍
项目的启动主要依赖于 Maven。以下是启动 SkyWalking 的基本步骤:
- 确保安装了 JDK 和 Maven。
- 克隆项目到本地。
- 进入项目根目录。
- 执行命令
mvn clean install
构建项目。 - 进入
oap-server
目录,执行命令mvn spring-boot:run
启动 OAP 服务器。 - 进入
skywalking-ui
目录,执行命令mvn spring-boot:run
启动 UI。
3. 项目的配置文件介绍
SkyWalking 使用配置文件来管理不同的设置。以下是主要的配置文件:
application.yml
: 这是 Spring Boot 的标准配置文件,用于配置 SkyWalking OAP 服务器和 UI 应用的各种参数。config/application.yml
: 这个文件通常用于更详细地配置 OAP 服务器,包括存储、分析器、查询等组件。config/ui/application.yml
: 用于配置 SkyWalking UI 应用的参数。
配置文件中的常用配置项包括:
collector
: 用于配置数据收集器相关的参数。storage
: 用于配置数据存储的类型和参数,例如 Elasticsearch、BanyanDB 等。query
: 用于配置查询服务相关的参数。ui
: 用于配置 UI 展示相关的参数。
确保在启动服务之前,根据你的具体环境调整这些配置文件。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考