SCOUTER 开源项目安装与使用教程

SCOUTER 开源项目安装与使用教程

scouter Scouter is an open source APM (Application Performance Management) tool. 项目地址: https://gitcode.com/gh_mirrors/sc/scouter

1. 项目的目录结构及介绍

SCOUTER 是一个开源的应用性能管理（APM）工具，其目录结构如下：

• scouter.agent.batch: 包含批处理代理的代码，用于收集批处理应用程序的性能数据。
• scouter.agent.host: 包含主机代理的代码，用于收集操作系统级别的性能数据。
• scouter.agent.java: 包含 Java 代理的代码，用于收集 Java 应用程序的性能数据。
• scouter.client: 包含客户端代码，用于查看和分析收集的性能数据。
• scouter.client.build: 客户端构建脚本和配置文件。
• scouter.client.feature: 客户端的特性模块。
• scouter.client.product: 客户端的产品模块。
• scouter.common: 包含公共库和工具类。
• scouter.deploy: 部署脚本和配置文件。
• scouter.document: 项目文档。
• scouter.enduser.script: 用户自定义脚本的目录。
• scouter.extra.java20: 针对 JDK 20 的额外代码。
• scouter.server.boot: 服务器的启动脚本。
• scouter.server: 服务器端代码，用于接收和存储代理发送的数据。
• scouter.weaver: 包含编织器代码，用于在应用程序代码中注入监控逻辑。
• scouter.webapp: Web 应用程序模块。
• .gitignore: Git 忽略文件列表。
• LICENSE.md: 项目许可证文件。
• README.md: 项目自述文件。
• README_kr.md: 韩文版项目自述文件。
• build_client.sh: 客户端构建脚本。
• build_package.sh: 打包脚本。
• pom.xml: Maven 项目配置文件。

2. 项目的启动文件介绍

SCOUTER 项目的启动文件根据不同的模块有不同的启动方式：

• 服务器端：通常使用 scouter.server.boot 目录下的脚本启动服务器，例如 scouter-server.sh（对于 Linux）或 scouter-server.bat（对于 Windows）。
• 客户端：客户端程序基于 RCP，可以通过 scouter.client 目录下的启动脚本运行，例如 scouter-client.sh 或 scouter-client.bat。

3. 项目的配置文件介绍

SCouter 项目的配置文件用于定义项目运行时的参数和设置，以下是一些主要的配置文件：

• scouter.properties: 服务器端的主配置文件，定义了服务器的运行参数，如端口、数据存储路径等。
• scouter.client.properties: 客户端的配置文件，定义了客户端连接服务器时使用的参数，如服务器地址和端口。
• build.xml: Maven 的构建配置文件，用于定义构建过程中的任务和依赖。

在配置文件中，你可以根据实际需求调整参数，确保 SCOUTER 可以正确地运行和收集数据。

scouter Scouter is an open source APM (Application Performance Management) tool. 项目地址: https://gitcode.com/gh_mirrors/sc/scouter