VmConsole-Api

🔨 VmConsole-Api — это API для мониторинга производительности JVM, который расширяет функциональность инструментов Oracle JDK. Он предоставляет дополнительные функции для некоторых команд мониторинга и позволяет легко извлекать каждый параметр и результат из объекта.

Библиотека не просто использует метод exec() для запуска команд jps, jstat, jstack и других, но и предлагает более глубокий уровень расширения, что позволяет осуществлять мониторинг виртуальной машины без необходимости настройки переменных среды Java.

Примечание: этот инструмент API подходит для JDK 8 и выше (некоторые функции могут работать некорректно с JDK 7 и ниже), а виртуальная машина должна быть HotSpot.

Проект соответствует Apache Open Source License, а основной код был разработан или модифицирован на основе исходного кода JDK.

Как использовать

Я подготовил jar-файл с зависимостями (около 3 МБ), который можно импортировать в проект без необходимости добавления каких-либо дополнительных библиотек.

• Скачать jar-файл:

  • GitHub: https://github.com/tzfun/VmConsole-Api/releases.
  • Облако Baidu: ссылка: 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{
        //  Получение всех идентификаторов процессов локальных виртуальных машин
        List<JpsResult> jpsResult1 = JpsCmd.quit();
        // Получение всех идентификаторов процессов локальных виртуальных машин с параметрами виртуальной машины
        List<JpsResult> jpsResult2 = JpsCmd.withVmArgs();
        // Получение всех идентификаторов процессов локальных виртуальных машин с параметрами основного класса
        List<JpsResult> jpsResult3 = JpsCmd.withMainClassArgs();
        // Получение всех идентификаторов процессов локальных виртуальных машин с полным именем основного класса или jar
        List<JpsResult> jpsResult4 = JpsCmd.withFullName();

        // Выполнение команды jps с пользовательскими параметрами, эквивалентно выполнению jps -l в командной строке
        List<JpsResult> jpsResult5 = JpsCmd.run(new String[]{"-l"});
    }
}

Для получения дополнительной информации рекомендуется ознакомиться с документацией: * https://www.kancloud.cn/beifengtz/vmconsole/1118492.

API документация доступна по адресу: * http://doc.vmconsole.beifengtz.com.

Общение

Если вы обнаружили ошибку при использовании, или у вас есть предложения или комментарии к этому продукту, пожалуйста, отправьте электронное письмо автору: beifengtz@163.com.

Об авторе

• Личный сайт: www.beifengtz.com.
• Блог: blog.beifengtz.com.
• GitHub: https://github.com/tzfun.
• Персональный аккаунт WeChat: «北风IT之路».

Подробное описание VmConsole

На данный момент я реализовал шесть команд: jps, jinfo, jstat, jstack, jcmd и jmap. Пользователи могут напрямую вызывать соответствующие методы в каждом инструменте для выполнения соответствующих команд. Формат команд такой же, как и у команд, предоставляемых JDK, но для удобства и надёжности рекомендуется использовать уже реализованные методы.

• JpsCmd: получение идентификатора экземпляра локальной виртуальной машины, информации о главном классе, параметров виртуальной машины и т. д., инкапсуляция команды jps.
• JInfoCmd: получение и установка системной информации и параметров виртуальной машины, инкапсуляция команды jinfo.
• JStatCmd: получение информации о состоянии памяти виртуальной машины, включая информацию о сборке мусора, информацию о метаданных и информацию об экземплярах классов, инкапсуляцию команды jstat.
• JStackCmd: получение информации о стеке виртуальной машины, включая стек потоков, файлы дампа и методы C/C++, инкапсулированные командой jstack.
• JMapCmd: получение конфигурации кучи виртуальной машины, использование памяти в зонах Eden, Survivor и Old, вывод файлов дампа, получение информации об экземплярах класса и т.д., инкапсулирование команды jmap.
• JCmd: выполнение команд на определённом экземпляре виртуальной машины, инкапсуляция команды jcmd.

1. JPSCmd

JpsCmd может получать идентификатор виртуальной машины (VMID), параметры виртуальной машины, параметры основного класса и полное имя основного класса или jar. Это соответствует команде JDK jps.

Все возможные возвращаемые объекты имеют следующие отношения наследования:

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

Содержание JvmResult см. в начале раздела «Использование».

1.2.1 JpsResult

5.2.2 HeapForG1

5.2.3 HeapForGen

5.2.4 JMapForHeapUsage

5.2.5 JMapForHeapResult

| Атрибут | Тип | Значение | | --- --- | --- | --- | | heapConf | HashMap<String, Object> | информация о конфигурации пространства кучи | | heapUsage | JMapForHeapUsage | использование пространства кучи |

6. JCmd

Для выполнения команд на определённом виртуальном компьютере используется метод jcmd.

6.1 Методы

• listProcess() — возвращает JCmdResult и не имеет параметров. Используется для вывода списка процессов виртуального компьютера.
• executeCommand() — принимает два параметра: идентификатор виртуального компьютера (vmId) и объект JCmdEnum. Возвращает JCmdResult. Используется для выполнения команды на указанном виртуальном компьютере.

6.2 Результаты объекта

JCmdEnum — перечисление, содержащее различные команды, которые можно выполнить с помощью метода executeCommand().

JCmdProcess — объект, содержащий информацию о процессе виртуального компьютера, включая его идентификатор и содержимое.

JCmdResult — результат выполнения команды. Содержит список процессов (processes) и результат выполнения команды (result).