Интерфейс FlightRecorderMXBean

static final String MXBEAN_NAME

Строковое представление ObjectName для FlightRecorderMXBean.

long newRecording() throws IllegalStateException, SecurityException

Создаёт запись, но не запускает её.

long takeSnapshot()

Создаёт моментальную запись (snapshot) всех доступных записанных данных.

Моментальная запись — это синтезированная запись в состоянии остановки. Если данные недоступны, возвращается запись размером 0.

Моментальная запись предоставляет стабильный доступ к данным для последующих операций (например, для изменения временного интервала или для уменьшения размера данных).

Вызывающий объект должен закрыть запись, когда доступ к данным больше не требуется.

long cloneRecording(long recordingId, boolean stop) throws IllegalArgumentException, SecurityException

Создаёт копию существующей записи, полезную для извлечения частей записи.

Скопированная запись содержит те же данные записи, что и оригинал, но имеет новый идентификатор и имя, начинающееся с "Clone of recording". Если исходная запись запущена, то и копия также запущена.

void startRecording(long recordingId) throws IllegalStateException, SecurityException

Запускает запись с указанным идентификатором.

Остановленную запись нельзя перезапустить.

boolean stopRecording(long recordingId) throws IllegalArgumentException, IllegalStateException, SecurityException

Останавливает запущенную запись с указанным идентификатором.

void closeRecording(long recordingId) throws IOException

Закрывает запись с указанным идентификатором и освобождает все системные ресурсы, связанные с записью.

Если запись уже закрыта, вызов этого метода не оказывает никакого эффекта.

long openStream(long recordingId, Map<String,String> streamOptions) throws IOException

Открывает поток данных для записи с указанным идентификатором или 0 для получения данных независимо от записи.

Параметры потока записи

Имя	Описание	Значение по умолчанию	Формат	Примеры значений
startTime	Указывает момент времени, с которого начать поток записи. Из-за способа хранения данных, некоторые события, начавшиеся или завершившиеся до начального времени, могут быть включены.	Instant.MIN_VALUE.toString()	ISO-8601. См. Instant.toString() или миллисекунды с момента эпохи	"2015-11-03T00:00", "1446508800000"
endTime	Указывает момент времени, до которого завершить поток записи. Из-за способа хранения данных, некоторые события, начавшиеся или завершившиеся после конечного времени, могут быть включены.	Instant.MAX_VALUE.toString()	ISO-8601. См. Instant.toString() или миллисекунды с момента эпохи	"2015-11-03T01:00", "1446512400000"
blockSize	Указывает максимальное количество байтов для чтения с помощью вызова readStream	"50000"	Положительное long значение. Установка blockSize к очень высокому значению может привести к OutOfMemoryError или IllegalArgumentException, если Java Virtual Machine (JVM) посчитает это значение слишком большим для обработки.	"50000", "1000000",
streamVersion	Указывает формат для чтения данных из запущенной записи	"1.0"	Номер версии с мажором и минором. Чтобы иметь возможность читать из запущенной записи, значение должно быть установлено	"1.0"

Если опция отсутствует в карте, используется значение по умолчанию.

Запись с указанным идентификатором должна быть остановлена перед открытием потока, если не указана опция "streamVersion".

void closeStream(long streamId) throws IOException

Закрывает поток записи с указанным идентификатором и освобождает все системные ресурсы, связанные с потоком.

Если поток уже закрыт, вызов этого метода не оказывает никакого эффекта.

byte[] readStream(long streamId) throws IOException

Считывает часть данных из потока с указанным идентификатором или возвращает null если больше данных нет.

Чтобы прочитать все данные для записи, вызывайте этот метод повторно, пока не будет возвращено null.

Map<String,String> getRecordingOptions(long recordingId) throws IllegalArgumentException

Возвращает карту, содержащую параметры записи с указанным идентификатором (например, целевой файл или временной интервал хранения записанных данных).

См. FlightRecorderMXBean для доступных имен параметров.

Map<String,String> getRecordingSettings(long recordingId) throws IllegalArgumentException

Возвращает Map , содержащую настройки записи с указанным идентификатором (например, пороговые значения событий).

Если одновременно работают несколько записей, может быть записано больше данных, чем указано в объекте Map .

Имя в Map — это имя события и имя настройки, разделенные "#" (например, "jdk.VMInfo#period"). Значение — текстовое представление значения настроек (например, "60 s").

void setConfiguration(long recordingId, String contents) throws IllegalArgumentException

Устанавливает конфигурацию в виде строкового представления для записи с указанным идентификатором.

void setPredefinedConfiguration(long recordingId, String configurationName) throws IllegalArgumentException

Устанавливает предопределённую конфигурацию для записи с указанным идентификатором.

void setRecordingSettings(long recordingId, Map<String,String> settings) throws IllegalArgumentException

Устанавливает и заменяет все предыдущие настройки для указанной записи.

Настройка состоит из пары имя/значение, где имя определяет событие и настройку для конфигурации, а значение определяет, на что её установить.

Имя может быть сформировано следующим образом:

<event-name> + "#" + <setting-name>

или

<event-id> + "#" + <setting-name>

Например, чтобы установить интервал выборки события CPU Load раз в секунду, используйте имя "jdk.CPULoad#period" и значение "1 s". Если несколько событий используют одно и то же имя, например, если тип события загружается в нескольких загрузчиках классов, и требуется различать их, то имя имеет вид "56#period". Идентификатор события получается вызовом метода EventType.getId() и является действительным для экземпляра виртуальной машины Java (JVM), в котором зарегистрировано событие.

Список доступных имён событий можно получить, вызвав FlightRecorder.getEventTypes() и EventType.getName(). Список доступных настроек для типа события получается вызовом EventType.getSettingDescriptors() и ValueDescriptor.getName().

void setRecordingOptions(long recordingId, Map<String,String> options) throws IllegalArgumentException

Настраивает параметры записи (например, целевой файл и временной интервал хранения данных).

См. FlightRecorderMXBean для описания параметров и значений, которые можно использовать. Установка значения в null восстанавливает значение по умолчанию.

List<RecordingInfo> getRecordings()

Возвращает список доступных записей, необязательно активных.

Доступ к MBeanServer:
Картируемый тип RecordingInfo — CompositeData с атрибутами, как указано в методе RecordingInfo.from.

List<ConfigurationInfo> getConfigurations()

Возвращает список предопределённых конфигураций для данной виртуальной машины Java (JVM).

Доступ к MBeanServer:
Картируемый тип ConfigurationInfo — CompositeData с атрибутами, как указано в методе ConfigurationInfo.from.

List<EventTypeInfo> getEventTypes()

Возвращает список текущих зарегистрированных типов событий.

Доступ к MBeanServer:
Картируемый тип EventTypeInfo — CompositeData с атрибутами, как указано в методе EventTypeInfo.from.

void copyTo(long recordingId, String outputFile) throws IOException, SecurityException

Записывает данные записи в указанный файл.

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