Класс RecordingStream

public RecordingStream()

Возбуждает:

IllegalStateException - если Flight Recorder не может быть создан (например, если в виртуальной машине Java (JVM) отсутствует поддержка Flight Recorder или если репозиторий файлов не может быть создан или доступен)

public RecordingStream(Configuration configuration)

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

Параметры:

configuration - конфигурация, содержащая используемые настройки, не null

Возбуждает:

IllegalStateException - если Flight Recorder не может быть создан (например, если в виртуальной машине Java (JVM) отсутствует поддержка Flight Recorder или если репозиторий файлов не может быть создан или доступен)

См. также:

• Configuration

public EventSettings enable(String name)

Параметры:

name - настройки для события, не null

Возвращает:

настройку события для дальнейшей конфигурации, не null

См. также:

• EventType

public void setSettings(Map<String,String> settings)

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);
}

Параметры:

settings - настройки для установки, не null

См. также:

• Recording.setSettings(Map)

public EventSettings enable(Class<? extends Event> eventClass)

Параметры:

eventClass - событие для включения, не null

Возвращает:

настройку события для дальнейшей конфигурации, не null

Возбуждает:

IllegalArgumentException - если eventClass является абстрактным классом или не является подклассом Event

public EventSettings disable(String name)

Параметры:

name - настройки для события, не null

Возвращает:

настройку события для дальнейшей конфигурации, не null

public EventSettings disable(Class<? extends Event> eventClass)

Параметры:

eventClass - событие для отключения, не null

Возвращает:

настройку события для дальнейшей конфигурации, не null

Возбуждает:

IllegalArgumentException - если eventClass является абстрактным классом или не является подклассом Event

public void setMaxAge(Duration maxAge)

Параметры:

maxAge - длительность сохранения данных, или null если бесконечно

Возбуждает:

IllegalArgumentException - если maxAge отрицательно

IllegalStateException - если запись находится в состоянии CLOSED

public void setMaxSize(long maxSize)

Параметры:

maxSize - объём сохраняемых данных, 0 если бесконечно

Возбуждает:

IllegalArgumentException - если maxSize отрицательно

IllegalStateException - если запись находится в состоянии CLOSED

public void setReuse(boolean reuse)

Указано в:

setReuse в интерфейсе EventStream

Параметры:

reuse - true если объект события может быть повторно использован, false в противном случае

public void setOrdered(boolean ordered)

Указано в:

setOrdered в интерфейсе EventStream

Параметры:

ordered - если объекты событий приходят в хронологическом порядке в EventStream.onEvent(Consumer)

public void setStartTime(Instant startTime)

Указано в:

setStartTime в интерфейсе EventStream

Параметры:

startTime - начальное время, не null

См. также:

• EventStream.start()
• EventStream.startAsync()

public void setEndTime(Instant endTime)

Указано в:

setEndTime в интерфейсе EventStream

Параметры:

endTime - конечное время, не null

См. также:

• EventStream.start()
• EventStream.startAsync()

public void onEvent(String eventName, Consumer<RecordedEvent> action)

Указано в:

onEvent в интерфейсе EventStream

Параметры:

eventName - имя события, не null

action - действие для выполнения для каждого RecordedEvent, соответствующего имени события, не null

public void onEvent(Consumer<RecordedEvent> action)

Указано в:

onEvent в интерфейсе EventStream

Параметры:

action - действие для выполнения для каждого RecordedEvent, не null

См. также:

• EventStream.onEvent(Consumer)
• EventStream.onMetadata(Consumer)

public void onFlush(Runnable action)

Указано в:

onFlush в интерфейсе EventStream

Параметры:

action - действие для выполнения после сброса потока, не null

public void onClose(Runnable action)

Указано в:

onClose в интерфейсе EventStream

Параметры:

action - действие для выполнения после закрытия потока, не null

См. также:

• EventStream.close()

public void onError(Consumer<Throwable> action)

Указано в:

onError в интерфейсе EventStream

Параметры:

action - действие для выполнения, если произойдёт исключение, не null

public void close()

Указано в:

close в интерфейсе AutoCloseable

Указано в:

close в интерфейсе EventStream

public boolean remove(Object action)

Указано в:

remove в интерфейсе EventStream

Параметры:

action - действие для отмены регистрации, не null

Возвращает:

true, если действие было отменено, false в противном случае

См. также:

• EventStream.onEvent(Consumer)
• EventStream.onEvent(String, Consumer)
• EventStream.onFlush(Runnable)
• EventStream.onClose(Runnable)
• EventStream.onError(Consumer)

public void start()

Указано в:

start в интерфейсе EventStream

public void startAsync()

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);
}

Указано в:

startAsync в интерфейсе EventStream

Исключения:

IllegalStateException - если поток уже запущен или закрыт

public boolean stop()

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");
    }
}

Возвращает:

true, если запись остановлена, false в противном случае

Исключения:

IllegalStateException - если запись не запущена или уже остановлена

С момента:

20

public void dump(Path destination) throws IOException

Параметры:

destination - местоположение, куда записываются данные записи, не null

Исключения:

IOException - если данные записи не могут быть скопированы в указанное местоположение, или если поток закрыт, или не запущен.

С момента:

17

См. также:

• setMaxAge(Duration)
• setMaxSize(long)

public void awaitTermination(Duration timeout) throws InterruptedException

Указано в:

awaitTermination в интерфейсе EventStream

Параметры:

timeout - максимальное время ожидания, не null

Исключения:

InterruptedException - если прервано ожидание

См. также:

• EventStream.start()
• EventStream.startAsync()
• Thread.interrupt()

public void awaitTermination() throws InterruptedException

Указано в:

awaitTermination в интерфейсе EventStream

Исключения:

InterruptedException - если прервано ожидание

См. также:

• EventStream.start()
• EventStream.startAsync()
• Thread.interrupt()

public void onMetadata(Consumer<MetadataEvent> action)

static long count = 0;
public static void main(String... args) throws Exception {
    String regExp = args[0];
    var pr = Pattern.compile(regExp).asMatchPredicate();
    Configuration c = Configuration.getConfiguration("default");
    try (var s = new RecordingStream(c)) {
        s.setOrdered(false);
        s.onMetadata(metadata -> metadata.getAddedEventTypes()
         .stream().map(EventType::getName).filter(pr)
         .forEach(eventName -> s.onEvent(eventName, event -> count++)));
        s.startAsync();
        System.out.println("Running recording for 5 s. Please wait.");
        s.awaitTermination(Duration.ofSeconds(5));
        System.out.println(count + " events matches " + regExp);
    }
}

Specified by:

onMetadata в интерфейсе EventStream

Parameters:

action - для выполнения, не null

Throws:

IllegalStateException - если действие добавлено после запуска потока

Since:

16