Пакет 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 Virtual Machine, в котором зарегистрировано событие.

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

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

Обработка значений null

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