Интерфейс HotSpotDiagnosticMXBean

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

public interface HotSpotDiagnosticMXBean extends PlatformManagedObject

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

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

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

com.sun.management:type=HotSpotDiagnostic

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

Начиная с версии:

1.6

См. также:

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

Модификатор и тип	Интерфейс	Описание
`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 с указанным именем заданное значение.

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

getObjectName

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

dumpHeap

void dumpHeap(String outputFile, boolean live) throws IOException

Выгружает кучу в файл outputFile в том же формате, что и дамп кучи hprof.

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

Параметры:: outputFile — имя файла, зависящее от системы; live — если true, выгружать только живые объекты, то есть объекты, достижимые из других объектов
Исключения:: IOException — если outputFile уже существует, не может быть создан, открыт или записан.; UnsupportedOperationException — если эта операция не поддерживается.; IllegalArgumentException — если outputFile не оканчивается суффиксом «.hprof».; NullPointerException — если outputFile равен null.

getDiagnosticOptions

List<VMOption> getDiagnosticOptions()

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

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

getVMOption

VMOption getVMOption(String name)

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

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

setVMOption

void setVMOption(String name, String value)

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

Параметры:: name — имя параметра VM; value — новое значение параметра VM
Исключения:: IllegalArgumentException — если параметр VM с указанным именем не существует.; IllegalArgumentException — если новое значение недопустимо.; IllegalArgumentException — если параметр VM доступен только для чтения.; NullPointerException — если имя или значение равно null.

dumpThreads

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

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

Если формат задан как JSON, дамп потоков создается в формате JavaScript Object Notation. В файле threadDump.schema.json описан формат дампа потоков в черновике языка JSON Schema версии 2.

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

Примечание к API:: Выходной файл должен указываться абсолютным путем, поскольку доступ к MXBean может осуществляться удаленно из инструмента или программы с другим текущим рабочим каталогом.
Требования к реализации:: Реализация по умолчанию выбрасывает UnsupportedOperationException.
Параметры:: outputFile — путь к создаваемому файлу; format — используемый формат
Исключения:: IllegalArgumentException — если путь к файлу не является абсолютным; IOException — если файл уже существует или при записи в файл возникает исключение ввода-вывода; NullPointerException — если один из параметров равен null; UnsupportedOperationException — если эта операция не поддерживается
Начиная с версии:: 21

© 1993, 2025, 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/25/docs/api/jdk.management/com/sun/management/HotSpotDiagnosticMXBean.html