Класс 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);
    }
}

Определен в:

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

Параметры:

action — действие для выполнения, не null

Исключения:

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

С версии:

16