VmConsole-Api

🔨VmConsole-Api是一个jvm虚拟机性能监控API，将oracle jdk提供的tools.jar包进行了功能拓展，对一些监控命令结果进行了封装，你可以方便地从对象中读取每一个参数和结果。该类库并不是简单地使用运行时exec()调用jps、jstat、jstack等命令，而是从底层深度拓展而来，所以你不需要配置java环境变量就可以通过Java代码对虚拟机进行监控。

说明：本工具API适用于jdk8及以上（jdk7以下部分功能可能会出错），虚拟机必须是HotSpot。

本项目遵守Apache开源协议，核心代码由本人根据jdk源码拓展或改造而来，无模仿或抄袭。

如何使用

我已将核心依赖库打包生成了一个jar包(3MB左右)，你只需要将jar包导入到项目就可以直接使用其中的类，无需导入任何其他包。

• jar包下载

  提供两种下载方式，任选其一即可

  • github下载：https://github.com/tzfun/VmConsole-Api/releases
  • 百度云盘下载：链接：https://pan.baidu.com/s/15ptIBoJJqSJghxCewOyEGg 提取码：nuia

• Maven依赖

在pom.xml中引入如下依赖(以下是最新版本)：

<dependency>
  <groupId>com.github.tzfun</groupId>
  <artifactId>vmconsole</artifactId>
  <version>1.1.0</version>
  <classifier>jar-with-dependencies</classifier>
</dependency>

使用示例：

import beifengtz.vmconsole.JpsCmd;
import beifengtz.vmconsole.entity.jps.JpsResult;

import java.util.List;

public class JpsTest {
    public static void main(String[] args) throws Exception{
        //  获取本地虚拟机所有虚拟机进程id
        List<JpsResult> jpsResult1 = JpsCmd.quit();
        //  获取本地虚拟机所有虚拟机进程id，同时获取虚拟机参数
        List<JpsResult> jpsResult2 = JpsCmd.withVmArgs();
        //  获取本地虚拟机所有虚拟机进程id，同时获取主类参数
        List<JpsResult> jpsResult3 = JpsCmd.withMainClassArgs();
        //  获取本地虚拟机所有虚拟机进程id，同时获取jar或者主类全称
        List<JpsResult> jpsResult4 = JpsCmd.withFullName();

        //  自定义执行jps命令的参数，此处相当于在命令行执行jps -l
        List<JpsResult> jpsResult4 = JpsCmd.run(new String[]("-l"));
    }
}

• 使用说明(建议查看此文档)

  • https://www.kancloud.cn/beifengtz/vmconsole/1118492

• API文档

  • doc.vmconsole.beifengtz.com

交流

如果你在使用中发现了Bug，或者想对本作品提出意见或建议，请发送邮件到作者本人邮箱：[email protected]

关于作者

• 个人首页：www.beifengtz.com
• 博客地址：blog.beifengtz.com
• GitHub：https://github.com/tzfun
• 个人微信公众号：北风IT之路

VmConsole详细介绍文档

目前为止，我已经封装了jps、jstat、jstack、jinfo、jcmd、jamp六个命令，使用者可以直接通过每个工具类的run方法直接执行相关命令（主需要传入参数，不需要传入jps、jstat等命令），命令格式和jdk提供的工具命令格式一模一样，也可以使用我已经封装好了的方法，不过为了方便以及可靠性保证，建议你使用已经封装好的方法。

• JpsCmd：获取本地虚拟机实例的ID、主类信息、虚拟机参数等，封装于命令jps
• JInfoCmd：获取和设置系统参数信息、虚拟机参数信息，封装于命令jinfo
• JStatCmd：获取虚拟机内存状态信息，包括GC信息、编译类信息、元数据内存信息，封装于命令jstat
• JStackCmd：获取虚拟机堆栈信息，包括线程堆栈、dump文件、c/c++方法堆栈等，封装于命令jstack
• JMapCmd：获取虚拟机堆内存配置数据、Eden & Survivor & Old区内存使用量和比例、输出dump文件、获取class实例信息等，封装于jmap
• JCmd：向某一个虚拟机示例执行命令，封装于jcmd

1.JPSCmd

JpsCmd类可以获取本地虚拟机实例的虚拟机唯一识别VMID、虚拟机参数、主类参数和jar全称等。对应原生jdk命令jps。

1.1方法

1.2结果对象

所有可能返回对象的继承关系结构

|—— beifengtz.vmconsole.entity.JvmResult
    |—— beifengtz.vmconsole.entity.jps.JpsResult

JvmResult的内容介绍请见开始使用。

1.2.1 JpsResult

2.JInfo

获取以及设置系统参数、虚拟机参数等信息。封装自命令：jinfo。

2.1 方法

2.2 结果对象

所有可能返回对象的继承关系结构

|—— beifengtz.vmconsole.entity.JvmResult
    |—— beifengtz.vmconsole.entity.jinfo.JInfoResult

|—— beifengtz.vmconsole.entity.jinfo.JInfoNode
    |—— beifengtz.vmconsole.entity.jinfo.JInfoFlag

2.2.1 JInfoNode / JInfoFlag

2.2.2 JInfoResult

3.JStatCmd

获取虚拟机内存状态信息，包括GC信息、编译类信息、元数据内存信息，封装于命令jstat

3.1 方法

3.2 结果对象

所有可能返回对象的继承关系结构

|—— beifengtz.vmconsole.entity.JvmResult
    |—— beifengtz.vmconsole.entity.jstat.JStatResult
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForClass
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForCompilation
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForCompiler
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGc
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcCapacity
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcMetaCapacity
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcNew
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcNewCapacity
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcOld
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcOldCapacity
        |—— beifengtz.vmconsole.entity.jstat.JStatResultForGcUtil

3.2.1 JStatResult

3.2.2 JStatResult各子类属性含义

参数详细讲解看我的博客：JVM虚拟机性能监控与故障处理工具

S0C：s0（from）的大小
S1C：s1（from）的大小
S0U：s0（from）已使用的空间
S1U：s1(from)已经使用的空间
EC：eden区的大小
EU：eden区已经使用的空间
OC：老年代大小
OU：老年代已经使用的空间
MC：元空间的大小（Metaspace）
MU：元空间已使用大小
CCSC：压缩类空间大小（compressed class space）
CCSU：压缩类空间已使用大小
YGC：新生代gc次数
YGCT：新生代gc耗时
FGC：Full gc次数
FGCT：Full gc耗时
GCT：gc总耗时
e：Eden区使用比例
o：老年代使用比例
m：元数据区使用比例
css：压缩使用比例
Loaded：表示载入了类的数量
Bytes：所占用空间大小
Unloaded：表示卸载类的数量
UnBytes：卸载空间大小
Time：执行时间
Size：最近编译字节码的数量
Type：最近编译方法的编译类型
Method：方法名
Compiled：表示编译任务执行的次数
Failed：表示编译失败的次数
Invalid：不可用数量
FailedType：失败的类型
FailedMethod：失败的方法

4.JStackCmd

获取虚拟机堆栈信息，包括线程堆栈、dump文件、c/c++方法堆栈等，封装于命令jstack

4.1 方法

4.2 结果对象

所有可能返回对象的继承关系结构

|—— beifengtz.vmconsole.entity.JvmResult
    |—— beifengtz.vmconsole.entity.jstack.JStackResult
    |—— beifengtz.vmconsole.entity.jstack.ThreadStack

4.2.1 ThreadStack

4.2.2 JStackResult

5.JMapCmd

获取虚拟机堆内存配置数据、Eden & Survivor & Old区内存使用量和比例、输出dump文件、获取class实例信息等，封装于jmap

5.1 方法

5.2 结果对象

所有可能返回对象的继承关系结构

|—— beifengtz.vmconsole.entity.JvmResult
    |—— beifengtz.vmconsole.entity.jmap.JMapForHeapResult 

|—— beifengtz.vmconsole.entity.jmap.JMapForHeapUsage
|—— beifengtz.vmconsole.entity.jmap.HeapForSpace
|—— beifengtz.vmconsole.entity.jmap.HeapForG1
|—— beifengtz.vmconsole.entity.jmap.HeapForGen

5.2.1 HeapForSpace

5.2.2 HeapForG1

5.2.3 HeapForGen

5.2.4 JMapForHeapUsage

5.2.5 JMapForHeapResult

6. JCmd

向某一个虚拟机示例执行命令，比如你当前是虚拟机A，需要向虚拟机B执行命令，则需要次类相关方法。封装于jcmd

6.1 方法

6.2 结果对象

|—— beifengtz.vmconsole.entity.JvmResult
    |—— beifengtz.vmconsole.entity.jcmd.JCmdResult

|—— beifengtz.vmconsole.entity.jcmd.JCmdProcess
|—— beifengtz.vmconsole.entity.jcmd.JCmdEnum

6.2.1 JCmdEnum

JFR_STOP("JFR.stop"),
JFR_START("JFR.start"),
JFR_DUMP("JFR.dump"),
JFR_CHECK("JFR.check"),
VM_NATIVE_MEMORY("VM.native_memory"),
VM_CHECK_COMMERCIAL_FEATURES("VM.check_commercial_features"),
VM_UNLOCK_COMMERCIAL_FEATURES("VM.unlock_commercial_features"),
MANAGEMENTAGENT_STOP("ManagementAgent.stop"),
MANAGEMENTAGENT_START_LOCAL("ManagementAgent.start_local"),
MANAGEMENTAGENT_START("ManagementAgent.start"),
GC_ROTATE_LOG("GC.rotate_log"),
THREAD_PRINT("Thread.print"),
GC_CLASS_STATS("GC.class_stats"),
GC_CLASS_HISTOGRAM("GC.class_histogram"),
GC_HEAP_DUMP("GC.heap_dump"),
GC_RUN_FINALIZATION("GC.run_finalization"),
GC_RUN("GC.run"),
VM_UPTIME("VM.uptime"),
VM_FLAGS("VM.flags"),
VM_SYSTEM_PROPERTIES("VM.system_properties"),
VM_COMMAND_LINE("VM.command_line"),
VM_VERSION("VM.version");

6.2.2 JCmdProcess

6.2.3 JCmdResult