Класс Recording

public Recording(Map<String,String> settings)

Параметры:

settings — параметры в виде карты пар «имя-значение», не null

Исключения:

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

С версии:

11

См. также:

• jdk.jfr

public Recording()

Исключения:

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

public Recording(Configuration configuration)

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

Параметры:

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

Исключения:

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

См. также:

• Configuration

public void start()

Исключения:

IllegalStateException — если запись уже запущена или находится в состоянии CLOSED

public void scheduleStart(Duration delay)

Параметры:

delay — время ожидания перед запуском этой записи, не null

Исключения:

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

public boolean stop()

Возвращает:

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

Исключения:

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

См. также:

• setDestination(Path)

public Map<String,String> getSettings()

Возвращает:

параметры записи, не null

public long getSize()

Возвращает:

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

public Instant getStopTime()

Возвращает:

время или null, если эта запись не остановлена

public Instant getStartTime()

Возвращает:

время или null, если эта запись не запущена

public long getMaxSize()

Возвращает:

максимальный размер в байтах или 0, если максимальный размер не задан

public Duration getMaxAge()

Возвращает:

максимальный период времени или null, если максимальный период времени не задан

public String getName()

Возвращает:

имя записи, не null

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

Параметры:

settings — задаваемые параметры, не null

public RecordingState getState()

Возвращает:

состояние записи, не null

См. также:

• RecordingState

public void close()

Определено в:

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

Определено в:

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

public Recording copy(boolean stop)

Параметры:

stop — true, если только что созданную копию следует немедленно остановить, и false в противном случае

Возвращает:

копию записи, не null

public void dump(Path destination) throws IOException

Параметры:

destination — место записи данных, не null

Исключения:

IOException — если данные записи не удается скопировать в указанное место, например, если запись закрыта или путь назначения недоступен для записи

См. также:

• getState()
• isToDisk()

public boolean isToDisk()

Возвращает:

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

public void setMaxSize(long maxSize)

Параметры:

maxSize — объем сохраняемых данных, 0 для бесконечного объема

Исключения:

IllegalArgumentException — если maxSize имеет отрицательное значение

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

public void setMaxAge(Duration maxAge)

Параметры:

maxAge — срок хранения данных или null для неограниченного срока

Исключения:

IllegalArgumentException — если maxAge имеет отрицательное значение

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

public void setDestination(Path destination) throws IOException

Параметры:

destination — путь назначения или null, если при остановке запись не следует выгружать

Исключения:

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

IOException — если путь недоступен для записи

public Path getDestination()

Возвращает:

файл назначения или null, если он не задан.

public long getId()

Возвращает:

идентификатор записи

public void setName(String name)

Параметры:

name — имя записи, не null

Исключения:

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

public void setDumpOnExit(boolean dumpOnExit)

Параметры:

dumpOnExit — следует ли выгружать эту запись при завершении работы JVM

public boolean getDumpOnExit()

Возвращает:

true, если запись выгружается при завершении работы, и false в противном случае.

public void setToDisk(boolean disk)

Параметры:

disk — true, если эта запись сохраняется на диск, и false, если она хранится в памяти

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

Параметры:

start — время начала потока или null, чтобы получить данные с момента начала записи

end — время окончания потока или null, чтобы получить данные по настоящее время.

Возвращает:

входной поток или null, если в интервале нет данных либо запись не сохранялась на диск

Исключения:

IllegalArgumentException — если end наступает раньше start

IOException — если не удается открыть поток

См. также:

• setToDisk(boolean)

public Duration getDuration()

Возвращает:

требуемую длительность записи или null, если длительность не задана.

public void setDuration(Duration duration)

Параметры:

duration — длительность или null, если длительность не задана

Исключения:

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

public EventSettings enable(String name)

Параметры:

name — параметры события, не null

Возвращает:

параметр события для дальнейшей настройки, не null

См. также:

• EventType

public EventSettings disable(String name)

Параметры:

name — параметры события, не null

Возвращает:

параметр события для дальнейшей настройки, не null

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

Параметры:

eventClass — включаемое событие, не null

Возвращает:

параметр события для дальнейшей настройки, не null

Исключения:

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

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

Параметры:

eventClass — отключаемое событие, не null

Возвращает:

параметр события для дальнейшей настройки, не null

Исключения:

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