Spec-Zone.ru › OpenJDK 25

Класс RemoteRecordingStream

java.lang.Object
jdk.management.jfr.RemoteRecordingStream
Все реализуемые интерфейсы:
AutoCloseable, EventStream
public final class RemoteRecordingStream extends Object implements EventStream
Реализация EventStream, которая может сериализовать события по сети с использованием MBeanServerConnection.

В следующем примере показано, как записывать паузы сборки мусора и использование ЦП на удалённом узле и выводить события в стандартный поток вывода.

    
    String host = "com.example";
    int port = 4711;

    String url = "service:jmx:rmi:///jndi/rmi://" + host + ":" + port + "/jmxrmi";

    JMXServiceURL u = new JMXServiceURL(url);
    JMXConnector c = JMXConnectorFactory.connect(u);
    MBeanServerConnection conn = c.getMBeanServerConnection();

    try (var rs = new RemoteRecordingStream(conn)) {
        rs.enable("jdk.GCPhasePause").withoutThreshold();
        rs.enable("jdk.CPULoad").withPeriod(Duration.ofSeconds(1));
        rs.onEvent("jdk.CPULoad", System.out::println);
        rs.onEvent("jdk.GCPhasePause", System.out::println);
        rs.start();
    }
    
С версии:
16

Краткое описание конструкторов

Конструктор Описание
RemoteRecordingStream(MBeanServerConnection connection)
Создаёт поток событий, работающий с MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean.
RemoteRecordingStream(MBeanServerConnection connection, Path directory)
Создаёт поток событий, работающий с MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean.

Краткое описание методов

Модификатор и тип Метод Описание
void awaitTermination()
Блокирует выполнение до завершения всех действий, закрытия потока, прерывания текущего потока — в зависимости от того, что произойдёт первым.
void awaitTermination(Duration timeout)
Блокирует выполнение до завершения всех действий, закрытия потока, истечения времени ожидания или прерывания текущего потока — в зависимости от того, что произойдёт первым.
void close()
Освобождает все ресурсы, связанные с этим потоком.
EventSettings disable(String name)
Отключает событие с указанным именем.
void dump(Path destination)
Записывает данные записи в файл.
EventSettings enable(String name)
Включает событие с указанным именем.
void onClose(Runnable action)
Регистрирует действие, выполняемое при закрытии потока.
void onError(Consumer<Throwable> action)
Регистрирует действие, выполняемое при возникновении исключения.
void onEvent(String eventName, Consumer<RecordedEvent> action)
Регистрирует действие, выполняемое для всех событий, соответствующих имени.
void onEvent(Consumer<RecordedEvent> action)
Регистрирует действие, выполняемое для всех событий в потоке.
void onFlush(Runnable action)
Регистрирует действие, выполняемое после сброса потока.
boolean remove(Object action)
Отменяет регистрацию действия.
void setEndTime(Instant endTime)
Задаёт время окончания потока.
void setMaxAge(Duration maxAge)
Определяет, за какой период хранятся данные потока.
void setMaxSize(long maxSize)
Определяет объём данных, хранящихся для потока.
void setOrdered(boolean ordered)
Задаёт хронологический порядок событий, отсортированных по времени их фиксации в потоке.
void setReuse(boolean reuse)
Указывает, что объект события в действии EventStream.onEvent(Consumer) можно повторно использовать.
void setSettings(Map<String,String> settings)
Заменяет все настройки этого потока записи.
void setStartTime(Instant startTime)
Задаёт время начала потока.
void start()
Запускает обработку действий.
void startAsync()
Запускает асинхронную обработку действий.
boolean stop()
Останавливает поток записи.

Методы, объявленные в классе Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Методы, объявленные в интерфейсе EventStream

onMetadata

Подробное описание конструкторов

RemoteRecordingStream

public RemoteRecordingStream(MBeanServerConnection connection) throws IOException
Создаёт поток событий, работающий с MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean.

Для настройки событий используйте setSettings(Map).

Параметры:
connection — MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean, не null
Исключения:
IOException — если не удаётся открыть поток, при попытке доступа к репозиторию возникает ошибка ввода-вывода или FlightRecorderMXBean

RemoteRecordingStream

public RemoteRecordingStream(MBeanServerConnection connection, Path directory) throws IOException
Создаёт поток событий, работающий с MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean.

Для настройки событий используйте setSettings(Map).

Параметры:
connection — MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean, не null
directory — каталог для сохранения загруженных данных событий, не null
Исключения:
IOException — если не удаётся открыть поток, при попытке доступа к репозиторию возникает ошибка ввода-вывода или FlightRecorderMXBean

Подробное описание методов

setSettings

public void setSettings(Map<String,String> settings)
Заменяет все настройки этого потока записи.

В следующем примере выполняется подключение к удалённому узлу и потоковая передача событий с настройками из конфигурации "default".

{
    

    String host = "com.example";
    int port = 4711;

    String url = "service:jmx:rmi:///jndi/rmi://" + host + ":" + port + "/jmxrmi";

    JMXServiceURL u = new JMXServiceURL(url);
    JMXConnector c = JMXConnectorFactory.connect(u);
    MBeanServerConnection conn = c.getMBeanServerConnection();

    try (final var rs = new RemoteRecordingStream(conn)) {
        rs.onMetadata(e -> {
            for (Configuration c : e.getConfigurations()) {
                if (c.getName().equals("default")) {
                    rs.setSettings(c.getSettings());
                }
            }
        });
        rs.onEvent(System.out::println);
        rs.start();
    }


Параметры:
settings — задаваемые настройки, не null
См. также:
  • Recording.setSettings(Map)

disable

public EventSettings disable(String name)
Отключает событие с указанным именем.

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

Параметры:
name — настройки события, не null
Возвращает:
настройку события для дальнейшей конфигурации, не null

enable

public EventSettings enable(String name)
Включает событие с указанным именем.

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

Параметры:
name — настройки события, не null
Возвращает:
настройку события для дальнейшей конфигурации, не null
См. также:
  • EventType

setMaxAge

public void setMaxAge(Duration maxAge)
Определяет, за какой период хранятся данные потока.

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

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

Параметры:
maxAge — срок хранения данных или null, если он не ограничен
Исключения:
IllegalArgumentException — если maxAge отрицательно
IllegalStateException — если запись находится в состоянии CLOSED

setMaxSize

public void setMaxSize(long maxSize)
Определяет объём данных, хранящихся для потока.

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

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

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

Параметры:
maxSize — объём сохраняемых данных, 0, если он не ограничен
Исключения:
IllegalArgumentException — если maxSize отрицательно
IllegalStateException — если запись находится в состоянии CLOSED

onEvent

public void onEvent(Consumer<RecordedEvent> action)
Описание скопировано из интерфейса: EventStream
Регистрирует действие, выполняемое для всех событий в потоке.

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

Переопределяет:
onEvent в интерфейсе EventStream
Параметры:
action — действие, выполняемое для каждого RecordedEvent, не null
См. также:
  • EventStream.onEvent(Consumer)
  • EventStream.onMetadata(Consumer)

onEvent

public void onEvent(String eventName, Consumer<RecordedEvent> action)
Описание скопировано из интерфейса: EventStream
Регистрирует действие, выполняемое для всех событий, соответствующих имени.
Переопределяет:
onEvent в интерфейсе EventStream
Параметры:
eventName — имя события, не null
action — действие, выполняемое для каждого RecordedEvent, соответствующего имени события, не null

onFlush

public void onFlush(Runnable action)
Описание скопировано из интерфейса: EventStream
Регистрирует действие, выполняемое после сброса потока.
Переопределяет:
onFlush в интерфейсе EventStream
Параметры:
action — действие, выполняемое после сброса потока, не null

onError

public void onError(Consumer<Throwable> action)
Описание скопировано из интерфейса: EventStream
Регистрирует действие, выполняемое при возникновении исключения.

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

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

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

Переопределяет:
onError в интерфейсе EventStream
Параметры:
action — действие, выполняемое при возникновении исключения, не null

onClose

public void onClose(Runnable action)
Описание скопировано из интерфейса: EventStream
Регистрирует действие, выполняемое при закрытии потока.

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

Переопределяет:
onClose в интерфейсе EventStream
Параметры:
action — действие, выполняемое после закрытия потока, не null
См. также:
  • EventStream.close()

close

public void close()
Описание скопировано из интерфейса: EventStream
Освобождает все ресурсы, связанные с этим потоком.

Если поток запущен — асинхронно или синхронно, — он немедленно останавливается или останавливается после следующего сброса. Этот метод НЕ гарантирует завершение всех зарегистрированных действий до возврата.

Закрытие уже закрытого потока не имеет эффекта.

Переопределяет:
close в интерфейсе AutoCloseable
Переопределяет:
close в интерфейсе EventStream

remove

public boolean remove(Object action)
Описание скопировано из интерфейса: EventStream
Отменяет регистрацию действия.

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

Переопределяет:
remove в интерфейсе EventStream
Параметры:
action — действие, регистрацию которого нужно отменить, не null
Возвращает:
true, если регистрация действия отменена, иначе false
См. также:
  • EventStream.onEvent(Consumer)
  • EventStream.onEvent(String, Consumer)
  • EventStream.onFlush(Runnable)
  • EventStream.onClose(Runnable)
  • EventStream.onError(Consumer)

setReuse

public void setReuse(boolean reuse)
Описание скопировано из интерфейса: EventStream
Указывает, что объект события в действии EventStream.onEvent(Consumer) можно повторно использовать.

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

Переопределяет:
setReuse в интерфейсе EventStream
Параметры:
reuse — true, если объект события можно повторно использовать, иначе false

setOrdered

public void setOrdered(boolean ordered)
Описание скопировано из интерфейса: EventStream
Указывает, что события поступают в хронологическом порядке, отсортированные по времени их фиксации в потоке.
Переопределяет:
setOrdered в интерфейсе EventStream
Параметры:
ordered — указывает, поступают ли объекты событий в хронологическом порядке в EventStream.onEvent(Consumer)

setStartTime

public void setStartTime(Instant startTime)
Описание скопировано из интерфейса: EventStream
Задаёт время начала потока.

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

Переопределяет:
setStartTime в интерфейсе EventStream
Параметры:
startTime — время начала, не null
См. также:
  • EventStream.start()
  • EventStream.startAsync()

setEndTime

public void setEndTime(Instant endTime)
Описание скопировано из интерфейса: EventStream
Задаёт время окончания потока.

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

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

Переопределяет:
setEndTime в интерфейсе EventStream
Параметры:
endTime — время окончания, не null
См. также:
  • EventStream.start()
  • EventStream.startAsync()

start

public void start()
Описание скопировано из интерфейса: EventStream
Запускает обработку действий.

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

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

Переопределяет:
start в интерфейсе EventStream

startAsync

public void startAsync()
Описание скопировано из интерфейса: EventStream
Запускает асинхронную обработку действий.

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

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

Переопределяет:
startAsync в интерфейсе EventStream

stop

public boolean stop()
Останавливает поток записи.

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

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

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

  AtomicLong bytesWritten = new AtomicLong();
  try (var r = new RemoteRecordingStream(connection)) {
    r.setMaxSize(Long.MAX_VALUE);
    r.enable("jdk.FileWrite").withoutThreshold();
    r.onEvent(event ->
      bytesWritten.addAndGet(event.getLong("bytesWritten"))
    );
    r.startAsync();
    testFoo();
    r.stop();
    if (bytesWritten.get() > 1_000_000L) {
      r.dump(Path.of("file-write-events.jfr"));
      throw new AssertionError("testFoo() writes too much data to disk");
    }
  }
Возвращает:
true, если запись остановлена, иначе false
Исключения:
IllegalStateException — если запись не запущена или уже остановлена
С версии:
20

dump

public void dump(Path destination) throws IOException
Записывает данные записи в файл.

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

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

Параметры:
destination — расположение для записи данных записи, не null
Исключения:
IOException — если данные записи не удаётся скопировать в указанное расположение, либо если поток закрыт или не запущен.
С версии:
17
См. также:
  • setMaxAge(Duration)
  • setMaxSize(long)

awaitTermination

public void awaitTermination(Duration timeout) throws InterruptedException
Описание скопировано из интерфейса: EventStream
Блокирует выполнение до завершения всех действий, закрытия потока, истечения времени ожидания или прерывания текущего потока — в зависимости от того, что произойдёт первым.
Переопределяет:
awaitTermination в интерфейсе EventStream
Параметры:
timeout — максимальное время ожидания, не null
Исключения:
InterruptedException — если ожидание прервано
См. также:
  • EventStream.start()
  • EventStream.startAsync()
  • Thread.interrupt()

awaitTermination

public void awaitTermination() throws InterruptedException
Описание скопировано из интерфейса: EventStream
Блокирует выполнение до завершения всех действий, закрытия потока или прерывания текущего потока — в зависимости от того, что произойдёт первым.
Переопределяет:
awaitTermination в интерфейсе EventStream
Исключения:
InterruptedException — если ожидание прервано
См. также:
  • EventStream.start()
  • EventStream.startAsync()
  • Thread.interrupt()

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе документации Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры рабочего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/jdk.management.jfr/jdk/management/jfr/RemoteRecordingStream.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API