PerfMark 使用教程

1. 项目介绍

PerfMark 是一个低开销、手动插桩的 Java 跟踪库。用户可以在代码中添加跟踪函数调用，以查看每个部分花费的时间。PerfMark 的主要特点包括：

• 非常低的开销：启用时，跟踪函数调用大约增加 70ns。跟踪在无锁、无等待的线程本地缓冲区中完成，避免干扰对延迟敏感的代码。
• 动态启用：PerfMark 可以在运行时启用或禁用。禁用时，PerfMark 没有开销，利用 JIT 编译器移除跟踪。
• 线程间通信：现有的分析器难以表达哪个线程唤醒并执行另一个线程上的工作。PerfMark 允许用户明确表达这种关系，从而清晰地了解代码流程。
• 小库大小：PerfMark 跟踪 API 只有 7 KB 大小，依赖性最小，易于包含在其他项目中。
• Chrome 跟踪查看器集成：PerfMark 可以导出到 Chrome 跟踪事件格式，便于在 Web 浏览器中查看。

2. 项目快速启动

2.1 添加依赖

在 build.gradle 文件中添加以下依赖：

dependencies {
    implementation 'io.perfmark:perfmark-api:0.27.0'
    // 仅适用于应用程序，不适用于库
    implementation 'io.perfmark:perfmark-traceviewer:0.27.0'
}

或者在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>io.perfmark</groupId>
    <artifactId>perfmark-api</artifactId>
    <version>0.27.0</version>
</dependency>

2.2 在代码中添加跟踪调用

在代码中添加 PerfMark 跟踪调用，例如：

Map<String, Header> parseHeaders(List<String> rawHeaders) {
    try (TaskCloseable task = PerfMark.traceTask("Parse HTTP headers")) {
        Map<String, String> headers = new HashMap<>();
        for (String rawHeader : rawHeaders) {
            Header header = parseHeader(rawHeader);
            headers.put(header.name(), header);
        }
        return headers;
    }
}

2.3 记录异步工作

PerfMark 还可以用于记录异步工作：

Future<Response> buildResponse() {
    try (TaskCloseable task = PerfMark.traceTask("Build Response")) {
        Link link = PerfMark.linkOut();
        return executor.submit(() -> {
            try (TaskCloseable task2 = PerfMark.traceTask("Async Response")) {
                PerfMark.linkIn(link);
                return new Response(/* ... */);
            }
        });
    }
}

2.4 查看跟踪结果

在浏览器中查看跟踪结果，生成 HTML：

PerfMark.setEnabled(true);
PerfMark.event("My Task");
TraceEventViewer.writeTraceHtml();

3. 应用案例和最佳实践

3.1 gRPC 中的应用

PerfMark 最初是为 gRPC 设计的，用于跟踪 gRPC 调用的各个部分，帮助开发者了解每个部分的性能瓶颈。

3.2 Zuul 中的应用

PerfMark 也被用于 Zuul，帮助开发者跟踪网关的各个处理阶段，优化网关性能。

3.3 最佳实践

• 动态启用：在生产环境中，建议动态启用 PerfMark，以避免不必要的开销。
• 线程间通信：使用 PerfMark 的线程间通信功能，清晰地表达线程之间的依赖关系。
• Chrome 跟踪查看器：利用 Chrome 跟踪查看器，直观地查看跟踪结果，分析性能瓶颈。

4. 典型生态项目

4.1 gRPC

gRPC 是一个高性能、通用的开源 RPC 框架，PerfMark 被广泛用于 gRPC 的性能分析。

4.2 Zuul

Zuul 是一个基于 JVM 的路由和服务器端负载均衡器，PerfMark 帮助 Zuul 开发者优化网关性能。

4.3 Java 生态

PerfMark 支持 Java 6 及以上版本，适用于各种 Java 项目，帮助开发者进行性能分析和优化。

---

通过本教程，您应该能够快速上手 PerfMark，并在实际项目中应用它进行性能分析和优化。