Интерфейс EventStream

Поток — это последовательность событий, и способ взаимодействия с потоком — регистрация действий. Интерфейс EventStream не должен реализовываться, и будущие версии JDK могут полностью запретить это.

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

По умолчанию один и тот же объект RecordedEvent может использоваться для представления двух или более различных событий. Этот объект может быть передан многократно одному и тому же действию, а также другим действиям. Чтобы использовать объект события после завершения действия, метод setReuse(boolean) должен быть установлен в значение false, чтобы для каждого события выделялся новый объект.

События доставляются партиями. Чтобы получить уведомление о завершении партии, зарегистрируйте действие с помощью метода onFlush(Runnable). Это возможность агрегировать или передавать данные во внешние системы, пока виртуальная машина Java (JVM) готовит следующую партию.

События в рамках одной партии сортируются хронологически по времени завершения. Правильный порядок событий поддерживается только для событий, доступных JVM в момент сброса, т.е. для набора событий, доставленных как единица в одной партии. Поэтому события, доставленные в одной партии, могут быть вне порядка по сравнению с событиями, доставленными в предыдущей партии, но никогда не будут вне порядка с событиями в той же партии. Если порядок не имеет значения, сортировку можно отключить, используя метод setOrdered(boolean).

Для передачи событий зарегистрированным действиям поток должен быть запущен. Чтобы начать обработку в текущем потоке, вызовите метод start(). Чтобы асинхронно обработать действия в отдельном потоке, вызовите метод startAsync(). Чтобы дождаться завершения потока, используйте метод awaitTermination awaitTermination() или метод awaitTermination(Duration).

Когда поток завершается, он автоматически закрывается. Чтобы вручную остановить обработку событий, закройте поток, вызвав метод close(). Поток также может быть автоматически закрыт в исключительных ситуациях, например, если JVM, за которой ведется наблюдение, завершает работу. Чтобы получить уведомление в любом из этих случаев, используйте метод onClose(Runnable) для регистрации действия.

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

Следующий пример демонстрирует, как можно использовать EventStream для прослушивания событий на JVM, на которой запущен Flight Recorder

 try (var es = EventStream.openRepository()) {
   es.onEvent("jdk.CPULoad", event -> {
     System.out.println("CPU Load " + event.getEndTime());
     System.out.println(" Machine total: " + 100 * event.getFloat("machineTotal") + "%");
     System.out.println(" JVM User: " + 100 * event.getFloat("jvmUser") + "%");
     System.out.println(" JVM System: " + 100 * event.getFloat("jvmSystem") + "%");
     System.out.println();
   });
   es.onEvent("jdk.GarbageCollection", event -> {
     System.out.println("Garbage collection: " + event.getLong("gcId"));
     System.out.println(" Cause: " + event.getString("cause"));
     System.out.println(" Total pause: " + event.getDuration("sumOfPauses"));
     System.out.println(" Longest pause: " + event.getDuration("longestPause"));
     System.out.println();
   });
   es.start();
 }
 

Чтобы начать запись вместе с потоком, см. RecordingStream.