MyPerf4J 安装和配置指南

1. 项目基础介绍和主要编程语言

项目基础介绍

MyPerf4J 是一个针对高并发、低延迟应用设计的高性能 Java 性能监控和统计工具。它通过 JavaAgent 方式实现，对应用程序完全无侵入，无需修改应用代码。MyPerf4J 能够快速定位性能瓶颈和故障原因，帮助开发者和运维人员提升应用性能。

主要编程语言

MyPerf4J 主要使用 Java 语言开发。

2. 项目使用的关键技术和框架

关键技术

• JavaAgent: 通过 JavaAgent 技术实现对应用程序的无侵入监控。
• ASM: 使用 ASM 字节码操作框架来动态修改字节码，实现性能数据的采集。
• 内存复用: 采用内存复用的方式，减少临时对象的产生，降低对应用程序 GC 的影响。

框架

• Maven: 用于项目的构建和管理。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

1. JDK 安装: 确保已安装 JDK 8 或更高版本。
2. Maven 安装: 确保已安装 Maven 3.x 版本。
3. Git 安装: 用于克隆项目代码。

安装步骤

步骤 1: 克隆项目代码

首先，使用 Git 克隆 MyPerf4J 项目代码到本地：

git clone https://github.com/LinShunKang/MyPerf4J.git

步骤 2: 构建项目

进入项目目录，使用 Maven 构建项目：

cd MyPerf4J
mvn clean package

构建完成后，在 MyPerf4J-ASM/target/ 目录下会生成 MyPerf4J-ASM-<version>.jar 文件。

步骤 3: 配置 MyPerf4J

在项目根目录下创建一个配置文件 myPerf4J.properties，并根据需要进行配置。以下是一个示例配置：

# 配置监控应用的名称
app_name = MyApp

# 配置日志输出路径
metrics.log.xxx = /path/to/log/method_metrics.log

# 配置需要监控的包名
filter.packages.include = com.example

步骤 4: 配置 JVM 启动参数

在启动应用时，添加以下 JVM 参数以启用 MyPerf4J：

java -javaagent:/path/to/MyPerf4J-ASM-<version>.jar -DMyPerf4JPropFile=/path/to/myPerf4J.properties -jar yourApp.jar

如果使用 JDK 9 及以上版本，请额外添加以下参数：

--add-opens java.base/java.lang=ALL-UNNAMED

步骤 5: 启动应用

启动应用后，MyPerf4J 会自动开始监控并输出性能数据到指定的日志文件中。

卸载 MyPerf4J

如果需要卸载 MyPerf4J，只需在启动应用时去掉以下 JVM 参数，然后重启应用即可：

-javaagent:/path/to/MyPerf4J-ASM-<version>.jar -DMyPerf4JPropFile=/path/to/myPerf4J.properties

通过以上步骤，您可以成功安装和配置 MyPerf4J，开始监控您的 Java 应用程序性能。