Класс RecordingStream

Следующий пример демонстрирует создание потока записи, использующего предопределённую конфигурацию.

var c = Configuration.getConfiguration("default");
try (var rs = new RecordingStream(c)) {
    rs.onEvent(System.out::println);
    rs.start();
}

Если несколько событий имеют одинаковое имя (например, один и тот же класс загружен в разных загрузчиках классов), то все события, соответствующие имени, включаются. Для включения конкретного класса используйте метод enable(Class) или String представление идентификатора типа события.

Следующий пример записывает 20 секунд, используя конфигурацию "default", а затем меняет настройки на конфигурацию "profile".

Configuration defaultConfiguration = Configuration.getConfiguration("default");
Configuration profileConfiguration = Configuration.getConfiguration("profile");
try (var rs = new RecordingStream(defaultConfiguration)) {
    rs.onEvent(System.out::println);
    rs.startAsync();
    Thread.sleep(20_000);
    rs.setSettings(profileConfiguration.getSettings());
    Thread.sleep(20_000);
}

Если несколько событий имеют одинаковое имя (например, один и тот же класс загружен в разных загрузчиках классов), то все события, соответствующие имени, отключаются. Для отключения конкретного класса используйте метод disable(Class) или String представление идентификатора типа события.

Для управления объёмом данных записи, хранимых на диске, можно указать максимальную длительность хранения данных. Данные, хранящиеся на диске и старше указанного временного интервала, удаляются виртуальной машиной Java (JVM).

Если ни максимальный предел, ни максимальный срок хранения не установлены, размер записи может неограниченно расти, если события включены.

Для управления объёмом данных записи, хранимых на диске, можно указать максимальный объём данных для хранения. Когда максимальный предел превышен, виртуальная машина Java (JVM) удаляет старейший фрагмент, чтобы освободить место для более нового фрагмента.

Если ни максимальный предел, ни максимальный срок хранения не установлены, размер записи может неограниченно расти.

Размер измеряется в байтах.

Если повторное использование установлено в true, действие не должно хранить ссылку на объект события после завершения действия.

Время начала должно быть установлено до запуска потока

Время окончания должно быть установлено до запуска потока.

В момент времени окончания поток закрывается.

Для выполнения действия на подмножестве типов событий, используйте EventStream.onEvent(String, Consumer) и EventStream.onMetadata(Consumer), так как это, скорее всего, более производительно, чем любой механизм выбора или фильтрации, реализованный в общем действии.

Если поток уже закрыт, действие будет выполнено немедленно в текущей нити.

Если действие не зарегистрировано, трассировка стека исключений выводится в стандартный вывод ошибок.

Регистрация действия переопределяет стандартное поведение. Если зарегистрировано несколько действий, они выполняются в порядке регистрации.

Если данная функция сама вызывает исключение, поведение является неопределенным.

Если действие зарегистрировано несколько раз, все экземпляры удаляются.

Действия выполняются в текущей нити.

Чтобы остановить поток, используйте метод EventStream.close().

Действия выполняются в отдельной нити.

Чтобы остановить поток, используйте метод close().

Следующий пример выводит использование ЦП в течение десяти секунд. Когда текущая нить выходит из блока try-with-resources, поток останавливается/закрывается.

try (var stream = new RecordingStream()) {
    stream.enable("jdk.CPULoad").withPeriod(Duration.ofSeconds(1));
    stream.onEvent("jdk.CPULoad", event -> {
        System.out.println(event);
    });
    stream.startAsync();
    Thread.sleep(10_000);
}

Останавливает запущенный поток и ожидает, пока все события в записи не будут обработаны.

Вызов этого метода в действии, например, в методе onEvent(Consumer), может заблокировать поток неопределенно долго. Чтобы прервать поток, используйте метод close().

Следующий фрагмент кода демонстрирует, как этот метод можно использовать совместно с методом startAsync() для мониторинга событий во время тестового метода:

AtomicBoolean socketUse = new AtomicBoolean();
try (var r = new RecordingStream()) {
    r.setMaxSize(Long.MAX_VALUE);
    r.enable("jdk.SocketWrite").withoutThreshold();
    r.enable("jdk.SocketRead").withoutThreshold();
    r.onEvent(event -> socketUse.set(true));
    r.startAsync();
    testFoo();
    r.stop();
    if (socketUse.get()) {
        r.dump(Path.of("socket-events.jfr"));
        throw new AssertionError("testFoo() should not use network");
    }
}

Поток записи должен быть запущен, но не закрыт.

Настоятельно рекомендуется установить максимальный срок действия или максимальный размер перед запуском потока. В противном случае дамп может не содержать никаких событий.