Класс Event

public abstract class Event
extends jdk.internal.event.Event

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

Следующий пример демонстрирует, как реализовать класс Event.

import jdk.jfr.Event;
 import jdk.jfr.Description;
 import jdk.jfr.Label;

 public class Example {

   @Label("Hello World")
   @Description("Helps programmer getting started")
   static class HelloWorld extends Event {
       @Label("Message")
       String message;
   }

   public static void main(String... args) {
       HelloWorld event = new HelloWorld();
       event.message = "hello, world!";
       event.commit();
   }
 }

После выделения события и заполнения его полей, его можно записать в систему Flight Recorder, используя метод #commit().

По умолчанию событие включено. Для отключения события необходимо аннотировать класс Event аннотацией @Enabled(false).

Поддерживаемые типы полей — это базовые типы Java: boolean, char, byte, short, int, long, float, и double. Поддерживаемые ссылочные типы: String, Thread и Class. Массивы, перечисления и другие ссылочные типы игнорируются и не включаются. Поля поддерживаемых типов могут быть исключены с помощью модификатора transient. Статические поля, даже поддерживаемых типов, не включаются.

Инструменты могут визуализировать данные осмысленно, когда используются аннотации (например, Label, Description, и Timespan). Аннотации, применённые к классу Event или его полям, включаются, если они присутствуют (косвенно, напрямую или ассоциированы), содержат аннотацию MetadataDefinition, и не содержат перечислений, массивов или классов.

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

protected Event()

public final void begin()

public final void end()

public final void commit()

public final boolean isEnabled()

public final boolean shouldCommit()

public final void set(int index,
                      Object value)