Класс Recording

public Recording(Map<String,String> settings)

Создает запись с настройками из карты пар имя-значение.

Новая запись находится в состоянии RecordingState.NEW. Чтобы начать запись, вызовите метод start().

public Recording()

Создаёт запись без настроек.

Новая запись находится в состоянии RecordingState.NEW. Чтобы начать запись, вызовите метод start().

public Recording(Configuration configuration)

Создаёт запись с настройками из конфигурации.

Следующий пример показывает, как создать запись, использующую предопределённую конфигурацию.

 Recording r = new Recording(Configuration.getConfiguration("default"));
 

Новая запись находится в состоянии RecordingState.NEW. Чтобы начать запись, вызовите метод start().

public void start()

Запускает эту запись.

Рекомендуется настроить параметры записи и настройки событий перед вызовом этого метода. Это обеспечит более согласованное состояние при анализе записанных данных и повысит производительность, поскольку конфигурация может быть применена атомарно.

После успешного вызова этого метода эта запись находится в состоянии RUNNING.

public void scheduleStart(Duration delay)

Запускает эту запись после задержки.

После успешного вызова этого метода эта запись находится в состоянии DELAYED.

public boolean stop()

Останавливает эту запись.

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

После успешного вызова этого метода эта запись будет находиться в состоянии STOPPED.

public Map<String,String> getSettings()

Возвращает настройки, используемые этой записью.

Изменение возвращаемой Map не изменит настройки для этой записи.

Если для этой записи нет настроек, возвращается пустая Map.

public long getSize()

Возвращает текущий размер этой записи в хранилище на диске, измеряемый в байтах.

Размер обновляется при сбросе буферов записи. Если запись не записывается в хранилище на диске, возвращаемый размер всегда 0.

public Instant getStopTime()

Возвращает время остановки этой записи.

public Instant getStartTime()

Возвращает время запуска этой записи.

public long getMaxSize()

Возвращает максимальный размер, измеренный в байтах, при котором данные больше не хранятся в хранилище на диске.

public Duration getMaxAge()

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

public String getName()

Возвращает имя этой записи.

По умолчанию имя совпадает с идентификатором записи.

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

Заменяет все настройки для этой записи.

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

     Map<String, String> settings = new HashMap<>();
     settings.putAll(EventSettings.enabled("jdk.CPUSample").withPeriod(Duration.ofSeconds(2)).toMap());
     settings.putAll(EventSettings.enabled(MyEvent.class).withThreshold(Duration.ofSeconds(2)).withoutStackTrace().toMap());
     settings.put("jdk.ExecutionSample#period", "10 ms");
     recording.setSettings(settings);
 

Следующий пример показывает, как объединить настройки.

     Map<String, String> settings = recording.getSettings();
     settings.putAll(additionalSettings);
     recording.setSettings(settings);
 

public RecordingState getState()

Возвращает текущее состояние записи.

public void close()

Освобождает все данные, связанные с этой записью.

После успешного вызова этого метода эта запись находится в состоянии CLOSED.

public Recording copy(boolean stop)

Возвращает клон этой записи с новым идентификатором и именем записи. Клоны полезны для выгрузки данных без остановки записи. После создания клона объём копируемых данных ограничивается методами setMaxAge(Duration) и setMaxSize(long).

public void dump(Path destination) throws IOException

Записывает данные записи в файл.

Запись должна быть запущена, но не обязательно остановлена.

public boolean isToDisk()

Возвращает true если эта запись использует хранилище на диске, false в противном случае.

Если значение не установлено, возвращается true.

public void setMaxSize(long maxSize)

Определяет, сколько данных хранится в репозитории диска.

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

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

public void setMaxAge(Duration maxAge)

Определяет, как давно данные хранятся в репозитории диска.

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

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

public void setDestination(Path destination) throws IOException

Устанавливает местоположение, куда данные записываются при остановке записи, или null если данные не должны быть скопированы.

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

Если назначение не установлено, Flight Recorder сохраняет данные записи до тех пор, пока эта запись не будет закрыта. Используйте метод dump(Path), чтобы вручную записать данные в файл.

public Path getDestination()

Возвращает файл назначения, куда записываются данные записи при остановке записи, или null если назначение не установлено.

public long getId()

Возвращает уникальный идентификатор для этой записи.

public void setName(String name)

Устанавливает удобочитаемое имя (например, "My Recording").

public void setDumpOnExit(boolean dumpOnExit)

Устанавливает, записывается ли эта запись на диск при выходе JVM.

public boolean getDumpOnExit()

Возвращает значение, указывающее, записывается ли эта запись на диск при выходе JVM.

Если запись на диск при выходе не установлена, возвращается false.

public void setToDisk(boolean disk)

Определяет, записывается ли эта запись непрерывно в репозиторий диска, или данные ограничены доступными буферами памяти.

public InputStream getStream(Instant start, Instant end) throws IOException

Создаёт поток данных для указанного интервала.

Поток может содержать некоторые данные за пределами указанного диапазона.

Если запись не на диске, поток создать нельзя и возвращается null.

public Duration getDuration()

Возвращает заданную продолжительность для этой записи, или null если продолжительность не задана.

Продолжительность можно задать только когда запись находится в состоянии RecordingState.NEW.

public void setDuration(Duration duration)

Устанавливает продолжительность, в течение которой запись выполняется до остановки.

По умолчанию запись не имеет продолжительности (null).

public EventSettings enable(String name)

Включает событие с указанным именем.

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

public EventSettings disable(String name)

Отключает событие с указанным именем.

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

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

Включает событие.

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

Отключает событие.