Класс 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() можно использовать для проверки того, будет ли экземпляр события фактически записан в систему при вызове метода commit(). Если shouldCommit() возвращает false, то эти операции можно избежать.