Пакет jdk.jfr

Определение событий

Flight Recorder собирает данные в виде событий. Событие имеет временную метку, продолжительность и, как правило, полезную для диагностики приложения нагрузку, специфичную для приложения, до момента сбоя или аварийного завершения.

Для определения события Flight Recorder, расширьте Event и добавьте поля, соответствующие типам данных полезной нагрузки. Метаданные о полях, такие как метки, описания и единицы измерения, могут быть добавлены, используя аннотации, доступные в пакете jdk.jfr, или с помощью пользовательской аннотации, имеющей аннотацию MetadataDefinition.

После определения класса события, можно создавать его экземпляры (объекты события). Данные хранятся в событии путем присвоения данных полям. Временные характеристики событий можно явно контролировать, используя методы begin и end класса Event.

Сбор данных для хранения в событии может быть дорогостоящим. Метод Event.shouldCommit() можно использовать для проверки того, будет ли экземпляр события действительно записан в систему при вызове метода Event.commit(). Если Event.shouldCommit() возвращает false, то эти операции можно избежать.

Иногда структура поля события неизвестна на этапе компиляции. В этом случае событие можно определить динамически. Однако динамические события могут не иметь такой же производительности, как статически определенные, и инструменты могут не быть в состоянии идентифицировать и визуализировать данные без знания структуры.

Для динамического определения события используйте класс EventFactory и определяйте поля, используя класс ValueDescriptor, а аннотации — используя класс AnnotationElement. Используйте фабрику для выделения события и метод Event.set(int, Object) для его заполнения.

Управление Flight Recorder

Flight Recorder можно управлять локально с помощью инструмента командной строки jcmd или удаленно с помощью интерфейса FlightRecorderMXBean, зарегистрированного в платформенном MBeanServer. Когда требуется прямой программный доступ, экземпляр Flight Recorder можно получить, вызвав FlightRecorder.getFlightRecorder(), а запись создать, используя класс Recording, в котором настраивается объем записываемых данных.

Настройки и конфигурация

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

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

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

или

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

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

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

Предопределенные настройки

Обработка нулевых значений

Все методы определяют, принимают ли они или возвращают null в Javadoc. Обычно это выражается как "not null". Если используется параметр null, где это недопустимо, выбрасывается исключение java.lang.NullPointerException. Если параметр null передается в метод, выбрасывающий другие исключения, такие как java.io.IOException, то исключение java.lang.NullPointerException имеет приоритет, если в Javadoc метода не указано, как обрабатывается null, например, путем выбрасывания java.lang.IllegalArgumentException.