Интерфейс HotSpotDiagnosticMXBean

Все суперинтерфейсы:: PlatformManagedObject

public interface HotSpotDiagnosticMXBean extends PlatformManagedObject

Интерфейс управления диагностикой для виртуальной машины HotSpot.

MBean диагностики регистрируется в сервере MBean платформы, как и другие платформенные MBean.

Идентификатор ObjectName для уникальной идентификации диагностического MXBean внутри сервера MBean:

com.sun.management:type=HotSpotDiagnostic

Его можно получить, вызвав метод PlatformManagedObject.getObjectName(). Все методы выбрасывают исключение NullPointerException, если какой-либо входной аргумент null, если не указано иное.

См. также:

Краткое описание вложенных классов

Модификатор и тип	Интерфейс	Описание
`static enum`	`HotSpotDiagnosticMXBean.ThreadDumpFormat`	Формат дампа потоков.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`dumpHeap(String outputFile, boolean live)`	Запись дампа кучи в файл `outputFile` в том же формате, что и дамп кучи hprof.
`default void`	`dumpThreads(String outputFile, HotSpotDiagnosticMXBean.ThreadDumpFormat format)`	Генерирует дамп потоков в заданный файл в заданном формате.
`List<VMOption>`	`getDiagnosticOptions()`	Возвращает список `VMOption` объектов для всех диагностических опций.
`VMOption`	`getVMOption(String name)`	Возвращает объект `VMOption` для параметра VM с заданным именем.
`void`	`setVMOption(String name, String value)`	Устанавливает параметр VM с заданным именем в указанное значение.

Методы, объявленные в интерфейсе java.lang.management.PlatformManagedObject

getObjectName

Подробное описание методов

dumpHeap

void dumpHeap(String outputFile, boolean live) throws IOException

Запись дампа кучи в файл outputFile в том же формате, что и дамп кучи hprof.

Если этот метод вызывается удаленно из другого процесса, выходные данные дампа кучи записываются в файл outputFile на машине, на которой выполняется целевая виртуальная машина. Если outputFile — относительный путь, он относится к рабочей директории, в которой была запущена целевая виртуальная машина.

Параметры:: outputFile - имя файла (зависит от ОС); live - если true записывать только живые объекты, т.е. объекты, на которые есть ссылки из других объектов
Исключения:: IOException - если файл outputFile уже существует, не может быть создан, открыт или записан.; UnsupportedOperationException - если операция не поддерживается.; IllegalArgumentException - если outputFile не заканчивается на ".hprof".; NullPointerException - если outputFile является null.; SecurityException - Если есть менеджер безопасности и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в указанный файл, или вызывающий объект не имеет разрешения ManagementPermission("control").

getDiagnosticOptions

List<VMOption> getDiagnosticOptions()

Возвращает список VMOption объектов для всех диагностических опций. Диагностическая опция — это параметр VM, writeable, который можно изменять динамически в основном для отладки и диагностики.

Возвращаемое значение:: список VMOption объектов для всех диагностических опций.

getVMOption

VMOption getVMOption(String name)

Возвращает объект VMOption для параметра VM с заданным именем.

Возвращаемое значение:: объект VMOption для параметра VM с заданным именем.
Исключения:: NullPointerException - если имя null.; IllegalArgumentException - если параметр VM с заданным именем не существует.

setVMOption

void setVMOption(String name, String value)

Устанавливает параметр VM с заданным именем в указанное значение. Новое значение будет отражено в новом объекте VMOption, возвращаемом методом getVMOption(java.lang.String) или методом getDiagnosticOptions(). Этот метод не изменяет значение этого объекта VMOption.

Параметры:: name - Имя параметра VM; value - Новое значение параметра VM
Исключения:: IllegalArgumentException - если параметр VM с заданным именем не существует.; IllegalArgumentException - если новое значение неверно.; IllegalArgumentException - если параметр VM не изменяем.; NullPointerException - если имя или значение null.; SecurityException - если менеджер безопасности существует и вызывающий объект не имеет разрешения ManagementPermission("control").

dumpThreads

default void dumpThreads(String outputFile, HotSpotDiagnosticMXBean.ThreadDumpFormat format) throws IOException

Генерирует дамп потоков в заданный файл в заданном формате. Параметр outputFile должен быть абсолютным путем к файлу, которого не существует.

Дамп потоков будет содержать выходные данные для всех потоков платформы. Он может содержать выходные данные для некоторых или всех виртуальных потоков.

Примечание API:: Путь к выходному файлу должен быть абсолютным, так как к MXBean может быть доступ из инструмента или программы с другой текущей рабочей директорией.
Требования к реализации:: По умолчанию реализация выбрасывает UnsupportedOperationException.
Параметры:: outputFile - путь к файлу для создания; format - используемый формат
Исключения:: IllegalArgumentException - если путь к файлу не абсолютный; IOException - если файл уже существует или при записи во файл возникает исключение ввода/вывода; NullPointerException - если любой из параметров null; SecurityException - если установлен менеджер безопасности и его метод SecurityManager.checkWrite(java.lang.String) запрещает запись в файл или разрешение ManagementPermission("control") отказано; UnsupportedOperationException - если операция не поддерживается
С:: 21

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.management/com/sun/management/HotSpotDiagnosticMXBean.html