Класс Event

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

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, такие операции можно пропустить.