GCViewer 技术文档

1. 安装指南

GCViewer 是一款开源的工具，用于可视化由 Sun/Oracle、IBM、HP 和 BEA Java 虚拟机生成的详细 GC 日志输出。以下是安装 GCViewer 的步骤：

• 确保您的系统中安装了 Java 1.8 或更高版本的虚拟机。
• 下载 GCViewer 的最新版本 jar 文件。可以从 SourceForge 上下载：GCViewer 下载地址。
• 下载后，您可以通过双击 gcviewer-x.x.x.jar 文件或运行命令 java -jar gcviewer-x.x.x.jar 来启动 GCViewer。

2. 项目的使用说明

GCViewer 提供了图形用户界面（GUI）和命令行界面两种使用方式。

图形用户界面(GUI)

通过双击 gcviewer-x.x.x.jar 文件或运行 java -jar gcviewer-x.x.x.jar 命令，可以启动 GCViewer 的 GUI 界面。在 GUI 界面中，您可以：

• 拖放 GC 日志文件到界面上。
• 观察图表，图表中会显示 Full GC 和 Inc GC 的标记，以及 GC 事件的时间线。
• 查看右侧的数据面板，其中包含了关于内存使用和 GC 性能的详细信息。

命令行界面

您也可以通过命令行界面使用 GCViewer 来生成报告。以下是命令行使用的示例：

java -jar gcviewer-x.x.x.jar gc.log summary.csv [chart.png] [-t PLAIN|CSV|CSV_TS|SIMPLE|SUMMARY]

其中：

• gc.log 是要分析的 GC 日志文件。
• summary.csv 是生成的总结报告文件。
• [chart.png] 是可选的图表文件。
• [-t PLAIN|CSV|CSV_TS|SIMPLE|SUMMARY] 是可选的输出格式。

如果启用了日志轮转，可以一次性读取多个日志文件：

java -jar gcviewer-x.x.x.jar gc.log.0;gc.log.1;gc.log.2;gc.log.current summary.csv [chart.png] [-t PLAIN|CSV|CSV_TS|SIMPLE|SUMMARY]

3. 项目API使用文档

目前，GCViewer 的 API 使用文档主要在项目源代码中的 javadoc 中提供。您可以查看项目 GitHub 仓库中的相关 Java 文件以获取详细信息：

https://github.com/chewiebug/GCViewer/blob/master/src/main/java/com/tagtraum/perf/gcviewer/imp/DataReaderSun1_6_0.java

这里提供了关于如何处理不同版本的 JVM 生成的 GC 日志的详细信息。

4. 项目安装方式

GCViewer 的安装方式非常简单：

• 确保您的系统中安装了 Java 1.8 或更高版本。
• 从 SourceForge 下载最新版本的 GCViewer jar 文件。
• 通过双击下载的 jar 文件或使用命令行来启动 GCViewer。

确保遵循以上步骤，您就可以成功安装并使用 GCViewer 来分析 GC 日志了。