Класс 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, в котором зарегистрирован FlightRecorderMXBean. |
RemoteRecordingStream |
Создаёт поток событий, работающий с MBeanServerConnection, в котором зарегистрирован FlightRecorderMXBean. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
void |
awaitTermination() |
Блокирует выполнение до завершения всех действий, закрытия потока, прерывания текущего потока — в зависимости от того, что произойдёт первым. |
void |
awaitTermination |
Блокирует выполнение до завершения всех действий, закрытия потока, истечения времени ожидания или прерывания текущего потока — в зависимости от того, что произойдёт первым. |
void |
close() |
Освобождает все ресурсы, связанные с этим потоком. |
EventSettings |
disable |
Отключает событие с указанным именем. |
void |
dump |
Записывает данные записи в файл. |
EventSettings |
enable |
Включает событие с указанным именем. |
void |
onClose |
Регистрирует действие, выполняемое при закрытии потока. |
void |
onError |
Регистрирует действие, выполняемое при возникновении исключения. |
void |
onEvent |
Регистрирует действие, выполняемое для всех событий, соответствующих имени. |
void |
onEvent |
Регистрирует действие, выполняемое для всех событий в потоке. |
void |
onFlush |
Регистрирует действие, выполняемое после сброса потока. |
boolean |
remove |
Отменяет регистрацию действия. |
void |
setEndTime |
Задаёт время окончания потока. |
void |
setMaxAge |
Определяет, за какой период хранятся данные потока. |
void |
setMaxSize |
Определяет объём данных, хранящихся для потока. |
void |
setOrdered |
Задаёт хронологический порядок событий, отсортированных по времени их фиксации в потоке. |
void |
setReuse |
Указывает, что объект события в действии EventStream.onEvent(Consumer) можно повторно использовать. |
void |
setSettings |
Заменяет все настройки этого потока записи. |
void |
setStartTime |
Задаёт время начала потока. |
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 - См. также:
disable
public EventSettings disable(String name)
Если существует несколько событий с одинаковым именем (например, один и тот же класс загружен разными загрузчиками классов), отключаются все события, соответствующие этому имени.
- Параметры:
-
name— настройки события, неnull - Возвращает:
- настройку события для дальнейшей конфигурации, не
null
enable
public EventSettings enable(String name)
Если несколько событий имеют одинаковое имя (например, один и тот же класс загружен разными загрузчиками классов), включаются все события, соответствующие этому имени.
- Параметры:
-
name— настройки события, неnull - Возвращает:
- настройку события для дальнейшей конфигурации, не
null - См. также:
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 - См. также:
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 - См. также:
close
public void close()
EventStreamЕсли поток запущен — асинхронно или синхронно, — он немедленно останавливается или останавливается после следующего сброса. Этот метод НЕ гарантирует завершение всех зарегистрированных действий до возврата.
Закрытие уже закрытого потока не имеет эффекта.
- Переопределяет:
-
closeв интерфейсеAutoCloseable - Переопределяет:
-
closeв интерфейсеEventStream
remove
public boolean remove(Object action)
EventStreamЕсли действие было зарегистрировано несколько раз, отменяется регистрация всех его экземпляров.
- Переопределяет:
-
removeв интерфейсеEventStream - Параметры:
-
action— действие, регистрацию которого нужно отменить, неnull - Возвращает:
-
true, если регистрация действия отменена, иначеfalse - См. также:
setReuse
public void setReuse(boolean reuse)
EventStreamEventStream.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 - См. также:
setEndTime
public void setEndTime(Instant endTime)
EventStreamВремя окончания необходимо задать до запуска потока.
По достижении времени окончания поток закрывается.
- Переопределяет:
-
setEndTimeв интерфейсеEventStream - Параметры:
-
endTime— время окончания, неnull - См. также:
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
- См. также:
awaitTermination
public void awaitTermination(Duration timeout) throws InterruptedException
EventStream- Переопределяет:
-
awaitTerminationв интерфейсеEventStream - Параметры:
-
timeout— максимальное время ожидания, неnull - Исключения:
-
InterruptedException— если ожидание прервано - См. также:
awaitTermination
public void awaitTermination() throws InterruptedException
EventStream- Переопределяет:
-
awaitTerminationв интерфейсеEventStream - Исключения:
-
InterruptedException— если ожидание прервано - См. также:
© 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