OpenJDK 27 · jdk.management.jfr.FlightRecorderMXBean

Management interface for controlling Flight Recorder.

The object name for identifying the MXBean in the platform MBean server is:

jdk.management.jfr:type=FlightRecorder

Flight Recorder can be configured in the following ways:

Recording options
Specify how long a recording should last, and where and when data should be dumped.
Settings
Specify which events should be enabled and what kind of information each event should capture.
Configurations
Predefined sets of settings, typically derived from a settings file, that specify the configuration of multiple events simultaneously.

See the package jdk.jfr documentation for descriptions of the settings syntax and the ConfigurationInfo class documentation for configuration information.

Recording options

The following table shows the option names to use with setRecordingOptions(long, Map) and getRecordingOptions(long).

Recording options
Name	Description	Default value	Format	Example values
`name`	Sets a human-readable recording name	String representation of the recording id	`String`	`"My Recording"`, `"profiling"`
`maxAge`	Specify the length of time that the data is kept in the disk repository until the oldest data may be deleted. Only works if `disk=true`, otherwise this parameter is ignored.	`"0"` (no limit)	`"0"` if no limit is imposed, otherwise a string representation of a positive `long` value followed by an empty space and one of the following units, `"ns"` (nanoseconds) `"us"` (microseconds) `"ms"` (milliseconds) `"s"` (seconds) `"m"` (minutes) `"h"` (hours) `"d"` (days)	`"2 h"`, `"24 h"`, `"2 d"`, `"0"`
`maxSize`	Specifies the size, measured in bytes, at which data is kept in the disk repository. Only works if `disk=true`, otherwise this parameter is ignored.	`"0"` (no limit)	String representation of a `long` value, must be positive	`"0"`, `"1000000000"`
`dumpOnExit`	Dumps recording data to disk on Java Virtual Machine (JVM) exit	`"false"`	String representation of a `boolean` value, `"true"` or `"false"`	`"true"`, `"false"`
`destination`	Specifies the path where recording data is written when the recording stops.	`"false"`	See `Paths#getPath` for format. If this method is invoked from another process, the data is written on the machine where the target JVM is running. If destination is a relative path, it is relative to the working directory where the target JVM was started.	`"c:\recording\recording.jfr"`, `"/recordings/recording.jfr"`, `"recording.jfr"`
`disk`	Stores recorded data as it is recorded	`"false"`	String representation of a `boolean` value, `"true"` or `"false"`	`"true"`, `"false"`
`duration`	Specifies the duration of the recording.	`"0"` (no limit, continuous)	`"0"` if no limit should be imposed, otherwise a string representation of a positive `long` followed by an empty space and one of the following units: `"ns"` (nanoseconds) `"us"` (microseconds) `"ms"` (milliseconds) `"s"` (seconds) `"m"` (minutes) `"h"` (hours) `"d"` (days)	`"60 s"`, `"10 m"`, `"4 h"`, `"0"`

Field Summary

Modifier and Type	Field and Description
public static final String	MXBEAN_NAME String representation of the `ObjectName` for the `FlightRecorderMXBean`.

Method Summary

Modifier and Type	Method and Description
public long	Returns: a unique ID that can be used to start, stop, close and configure the recording cloneRecording(long the recording ID of the recording to create a clone from recordingId, boolean if the newly created clone is stopped before returning. stop) Creates a copy of an existing recording, useful for extracting parts of a recording.
public void	closeRecording(long the ID of the recording to close recordingId) Closes the recording with the specified ID and releases any system resources that are associated with the recording.
public void	closeStream(long the ID of the stream streamId) Closes the recording stream with the specified ID and releases any system resources that are associated with the stream.
public void	copyTo(long the ID of the recording to dump data for recordingId, String the system-dependent file name where data is written, not `null` outputFile) Writes recording data to the specified file.
public List<ConfigurationInfo>	Returns: the list of predefined configurations, not `null` getConfigurations() Returns the list of predefined configurations for this Java Virtual Machine (JVM).
public List<EventTypeInfo>	Returns: the list of registered event types, not `null` getEventTypes() Returns the list of currently registered event types.
public Map<String, String>	Returns: a map describing the recording options, not `null` getRecordingOptions(long the ID of the recording to get options for recordingId) Returns a map that contains the options for the recording with the specified ID (for example, the destination file or time span to keep recorded data).
public List<RecordingInfo>	Returns: list of recordings, not `null` getRecordings() Returns the list of available recordings, not necessarily running.
public Map<String, String>	Returns: a map that describes the recording settings, not `null` getRecordingSettings(long the ID of the recording to get settings for recordingId) Returns a `Map` that contains the settings for the recording with the specified ID, (for example, the event thresholds) If multiple recordings are running at the same time, more data could be recorded than what is specified in the `Map` object.
public long	Returns: a unique ID that can be used to start, stop, close and configure the recording newRecording() Creates a recording, but doesn't start it.
public long	Returns: a unique ID for the stream. openStream(long ID of the recording to open the stream for recordingId, Map<String, String> a map that contains the options that controls the amount of data and how it is read, or `null` to get all data for the recording with the default block size streamOptions) Opens a data stream for the recording with the specified ID, or `0` to get data irrespective of recording.
public byte[]	Returns: byte array that contains recording data, or `null` when no more data is available readStream(long the ID of the stream streamId) Reads a portion of data from the stream with the specified ID, or returns `null` if no more data is available.
public void	setConfiguration(long ID of the recording recordingId, String a string representation of the configuration file to use, not `null` contents) Sets a configuration as a string representation for the recording with the specified ID.
public void	setPredefinedConfiguration(long ID of the recording to set the configuration for recordingId, String the name of the configuration (for example, `"profile"` or `"default"`), not `null` configurationName) Sets a predefined configuration for the recording with the specified ID.
public void	setRecordingOptions(long the ID of the recording to set options for recordingId, Map<String, String> name/value map of the settings to set, not `null` options) Configures the recording options (for example, destination file and time span to keep data).
public void	setRecordingSettings(long ID of the recording recordingId, Map<String, String> name value map of the settings to set, not `null` settings) Sets and replaces all previous settings for the specified recording.
public void	startRecording(long ID of the recording to start recordingId) Starts the recording with the specified ID. A recording that is stopped can't be restarted.
public boolean	Returns: `true` if the recording is stopped, `false` otherwise stopRecording(long the ID of the recording to stop recordingId) Stops the running recording with the specified ID.
public long	Returns: a unique ID that can be used for reading recording data takeSnapshot() Creates a snapshot recording of all available recorded data.

Inherited from java.lang.management.PlatformManagedObject:: getObjectName

Field Detail

MXBEAN_NAME	back to summary
public static final String MXBEAN_NAME String representation of the `ObjectName` for the `FlightRecorderMXBean`.

Method Detail

cloneRecording back to summary

cloneRecording	back to summary
public long cloneRecording(long recordingId, boolean stop) throws IllegalArgumentException Creates a copy of an existing recording, useful for extracting parts of a recording. The cloned recording contains the same recording data as the original, but it has a new ID and a name prefixed with `"Clone of recording"`. If the original recording is running, then the clone is also running. Parameters recordingId:long the recording ID of the recording to create a clone from stop:boolean if the newly created clone is stopped before returning. Returns:long a unique ID that can be used to start, stop, close and configure the recording Exceptions IllegalArgumentException: if a recording with the specified ID doesn't exist See Also `Recording`

public long cloneRecording(long recordingId, boolean stop) throws IllegalArgumentException

Creates a copy of an existing recording, useful for extracting parts of a recording.

The cloned recording contains the same recording data as the original, but it has a new ID and a name prefixed with "Clone of recording". If the original recording is running, then the clone is also running.

Parameters

recordingId:long: the recording ID of the recording to create a clone from
stop:boolean: if the newly created clone is stopped before returning.

Returns:long

a unique ID that can be used to start, stop, close and configure the recording

Exceptions

IllegalArgumentException:: if a recording with the specified ID doesn't exist

See Also

Recording

closeRecording back to summary

closeRecording	back to summary
public void closeRecording(long recordingId) throws IOException Closes the recording with the specified ID and releases any system resources that are associated with the recording. If the recording is already closed, invoking this method has no effect. Parameters recordingId:long the ID of the recording to close Exceptions IOException: if an I/O error occurs IllegalArgumentException: if a recording with the specified ID doesn't exist See Also `newRecording()`

public void closeRecording(long recordingId) throws IOException

Closes the recording with the specified ID and releases any system resources that are associated with the recording.

If the recording is already closed, invoking this method has no effect.

Parameters

recordingId:long: the ID of the recording to close

Exceptions

IOException:: if an I/O error occurs
IllegalArgumentException:: if a recording with the specified ID doesn't exist

See Also

newRecording()

closeStream back to summary

closeStream	back to summary
public void closeStream(long streamId) throws IOException Closes the recording stream with the specified ID and releases any system resources that are associated with the stream. If the stream is already closed, invoking this method has no effect. Parameters streamId:long the ID of the stream Exceptions IOException: if an I/O error occurs while trying to close the stream IllegalArgumentException: if a stream with the specified ID doesn't exist See Also `openStream(long, Map)`

public void closeStream(long streamId) throws IOException

Closes the recording stream with the specified ID and releases any system resources that are associated with the stream.

If the stream is already closed, invoking this method has no effect.

Parameters

streamId:long: the ID of the stream

Exceptions

IOException:: if an I/O error occurs while trying to close the stream
IllegalArgumentException:: if a stream with the specified ID doesn't exist

See Also

openStream(long, Map)

copyTo back to summary

copyTo	back to summary
public void copyTo(long recordingId, String outputFile) throws IOException Writes recording data to the specified file. If this method is invoked remotely from another process, the data is written to a file named `outputFile` on the machine where the target Java Virtual Machine (JVM) is running. If the file location is a relative path, it is relative to the working directory where the target JVM was started. Parameters recordingId:long the ID of the recording to dump data for outputFile:String the system-dependent file name where data is written, not `null` Exceptions IOException: if the recording can't be dumped due to an I/O error (for example, an invalid path) IllegalArgumentException: if a recording with the specified ID doesn't exist IllegalStateException: if the recording is not yet started or if it is already closed See Also `java.nio.file.Path#toString()`, `Recording#dump(java.nio.file.Path)`

public void copyTo(long recordingId, String outputFile) throws IOException

Writes recording data to the specified file.

If this method is invoked remotely from another process, the data is written to a file named outputFile on the machine where the target Java Virtual Machine (JVM) is running. If the file location is a relative path, it is relative to the working directory where the target JVM was started.

Parameters

recordingId:long: the ID of the recording to dump data for
outputFile:String: the system-dependent file name where data is written, not null

Exceptions

IOException:: if the recording can't be dumped due to an I/O error (for example, an invalid path)
IllegalArgumentException:: if a recording with the specified ID doesn't exist
IllegalStateException:: if the recording is not yet started or if it is already closed

getConfigurations back to summary

getConfigurations	back to summary
public List<ConfigurationInfo> getConfigurations() Returns the list of predefined configurations for this Java Virtual Machine (JVM). MBeanServer access: The mapped type of `ConfigurationInfo` is `CompositeData` with attributes as specified in the `ConfigurationInfo.from` method. Returns:List<ConfigurationInfo> the list of predefined configurations, not `null` See Also `ConfigurationInfo`, `Configuration`

public List<ConfigurationInfo> getConfigurations()

Returns the list of predefined configurations for this Java Virtual Machine (JVM).

MBeanServer access:
The mapped type of ConfigurationInfo is CompositeData with attributes as specified in the ConfigurationInfo.from method.

Returns:List<ConfigurationInfo>: the list of predefined configurations, not null
See Also: ConfigurationInfo, Configuration

getEventTypes back to summary

getEventTypes	back to summary
public List<EventTypeInfo> getEventTypes() Returns the list of currently registered event types. MBeanServer access: The mapped type of `EventTypeInfo` is `CompositeData` with attributes as specified in the `EventTypeInfo.from` method. Returns:List<EventTypeInfo> the list of registered event types, not `null` See Also `EventTypeInfo`, `EventType`

public List<EventTypeInfo> getEventTypes()

Returns the list of currently registered event types.

MBeanServer access:
The mapped type of EventTypeInfo is CompositeData with attributes as specified in the EventTypeInfo.from method.

Returns:List<EventTypeInfo>: the list of registered event types, not null
See Also: EventTypeInfo, EventType

getRecordingOptions back to summary

getRecordingOptions	back to summary
public Map<String, String> getRecordingOptions(long recordingId) throws IllegalArgumentException Returns a map that contains the options for the recording with the specified ID (for example, the destination file or time span to keep recorded data). See `FlightRecorderMXBean` for available option names. Parameters recordingId:long the ID of the recording to get options for Returns:Map<String, String> a map describing the recording options, not `null` Exceptions IllegalArgumentException: if no recording with the specified ID exists

public Map<String, String> getRecordingOptions(long recordingId) throws IllegalArgumentException

Returns a map that contains the options for the recording with the specified ID (for example, the destination file or time span to keep recorded data).

See FlightRecorderMXBean for available option names.

Parameters

recordingId:long: the ID of the recording to get options for

Returns:Map<String, String>

a map describing the recording options, not null

Exceptions

IllegalArgumentException:: if no recording with the specified ID exists

getRecordings back to summary

getRecordings	back to summary
public List<RecordingInfo> getRecordings() Returns the list of available recordings, not necessarily running. MBeanServer access: The mapped type of `RecordingInfo` is `CompositeData` with attributes as specified in the `RecordingInfo.from` method. Returns:List<RecordingInfo> list of recordings, not `null` See Also `RecordingInfo`, `Recording`

public List<RecordingInfo> getRecordings()

Returns the list of available recordings, not necessarily running.

MBeanServer access:
The mapped type of RecordingInfo is CompositeData with attributes as specified in the RecordingInfo.from method.

Returns:List<RecordingInfo>: list of recordings, not null
See Also: RecordingInfo, Recording

getRecordingSettings back to summary

getRecordingSettings	back to summary
public Map<String, String> getRecordingSettings(long recordingId) throws IllegalArgumentException Returns a `Map` that contains the settings for the recording with the specified ID, (for example, the event thresholds) If multiple recordings are running at the same time, more data could be recorded than what is specified in the `Map` object. The name in the `Map` is the event name and the setting name separated by `"#"` (for example, `"jdk.VMInfo#period"`). The value is a textual representation of the settings value (for example, `"60 s"`). Parameters recordingId:long the ID of the recording to get settings for Returns:Map<String, String> a map that describes the recording settings, not `null` Exceptions IllegalArgumentException: if no recording with the specified ID exists

public Map<String, String> getRecordingSettings(long recordingId) throws IllegalArgumentException

Returns a Map that contains the settings for the recording with the specified ID, (for example, the event thresholds)

If multiple recordings are running at the same time, more data could be recorded than what is specified in the Map object.

The name in the Map is the event name and the setting name separated by "#" (for example, "jdk.VMInfo#period"). The value is a textual representation of the settings value (for example, "60 s").

Parameters

recordingId:long: the ID of the recording to get settings for

Returns:Map<String, String>

a map that describes the recording settings, not null

Exceptions

IllegalArgumentException:: if no recording with the specified ID exists

newRecording back to summary

newRecording	back to summary
public long newRecording() throws IllegalStateException Creates a recording, but doesn't start it. Returns:long a unique ID that can be used to start, stop, close and configure the recording Exceptions IllegalStateException: if Flight Recorder can't be created (for example, if the Java Virtual Machine (JVM) lacks Flight Recorder support, or if the file repository can't be created or accessed) See Also `Recording`

public long newRecording() throws IllegalStateException

Creates a recording, but doesn't start it.

Returns:long

a unique ID that can be used to start, stop, close and configure the recording

Exceptions

IllegalStateException:: if Flight Recorder can't be created (for example, if the Java Virtual Machine (JVM) lacks Flight Recorder support, or if the file repository can't be created or accessed)

See Also

Recording

openStream back to summary

public long openStream(long recordingId, Map<String, String> streamOptions) throws IOException

Opens a data stream for the recording with the specified ID, or 0 to get data irrespective of recording.

Recording stream options
Name	Description	Default value	Format	Example values
`startTime`	Specifies the point in time to start a recording stream. Due to how data is stored, some events that start or end prior to the start time may be included.	`Instant.MIN_VALUE.toString()`	ISO-8601. See `Instant#toString` or milliseconds since epoch	`"2015-11-03T00:00"`, `"1446508800000"`
`endTime`	Specifies the point in time to end a recording stream. Due to how data is stored, some events that start or end after the end time may be included.	`Instant.MAX_VALUE.toString()`	ISO-8601. See `Instant#toString` or milliseconds since epoch	`"2015-11-03T01:00"`, `"1446512400000"`
`blockSize`	Specifies the maximum number of bytes to read with a call to `readStream`	`"50000"`	A positive `long` value. Setting `blockSize` to a very high value may result in `OutOfMemoryError` or an `IllegalArgumentException`, if the Java Virtual Machine (JVM) deems the value too large to handle.	`"50000"`, `"1000000"`,
`streamVersion`	Specifies format to use when reading data from a running recording	`"1.0"`	A version number with a major and minor. To be able to read from a running recording the value must be set to	`"1.0"`

If an option is omitted from the map the default value is used.

The recording with the specified ID must be stopped before a stream can be opened, unless the option "streamVersion" is specified.

Parameters

recordingId:long: ID of the recording to open the stream for
streamOptions:Map<String, String>: a map that contains the options that controls the amount of data and how it is read, or null to get all data for the recording with the default block size

Returns:long

a unique ID for the stream.

Exceptions

IOException:: if the recording is closed, an I/O error occurs, or no data is available for the specified recording or interval
IllegalArgumentException:: if a recording with the ID doesn't exist, or if options contains invalid values

readStream back to summary

readStream	back to summary
public byte[] readStream(long streamId) throws IOException Reads a portion of data from the stream with the specified ID, or returns `null` if no more data is available. To read all data for a recording, invoke this method repeatedly until `null` is returned. Parameters streamId:long the ID of the stream Returns:byte[] byte array that contains recording data, or `null` when no more data is available Exceptions IOException: if the stream is closed, or an I/O error occurred while trying to read the stream IllegalArgumentException: if no recording with the stream ID exists

public byte[] readStream(long streamId) throws IOException

Reads a portion of data from the stream with the specified ID, or returns null if no more data is available.

To read all data for a recording, invoke this method repeatedly until null is returned.

Parameters

streamId:long: the ID of the stream

Returns:byte[]

byte array that contains recording data, or null when no more data is available

Exceptions

IOException:: if the stream is closed, or an I/O error occurred while trying to read the stream
IllegalArgumentException:: if no recording with the stream ID exists

setConfiguration back to summary

setConfiguration	back to summary
public void setConfiguration(long recordingId, String contents) throws IllegalArgumentException Sets a configuration as a string representation for the recording with the specified ID. Parameters recordingId:long ID of the recording contents:String a string representation of the configuration file to use, not `null` Exceptions IllegalArgumentException: if no recording with the specified ID exists or if the configuration could not be parsed. See Also `Configuration#getContents()`

public void setConfiguration(long recordingId, String contents) throws IllegalArgumentException

Sets a configuration as a string representation for the recording with the specified ID.

Parameters

recordingId:long: ID of the recording
contents:String: a string representation of the configuration file to use, not null

Exceptions

IllegalArgumentException:: if no recording with the specified ID exists or if the configuration could not be parsed.

See Also

Configuration#getContents()

setPredefinedConfiguration back to summary

setPredefinedConfiguration	back to summary
public void setPredefinedConfiguration(long recordingId, String configurationName) throws IllegalArgumentException Sets a predefined configuration for the recording with the specified ID. Parameters recordingId:long ID of the recording to set the configuration for configurationName:String the name of the configuration (for example, `"profile"` or `"default"`), not `null` Exceptions IllegalArgumentException: if no recording with the specified ID exists See Also `getConfigurations()`

public void setPredefinedConfiguration(long recordingId, String configurationName) throws IllegalArgumentException

Sets a predefined configuration for the recording with the specified ID.

Parameters

recordingId:long: ID of the recording to set the configuration for
configurationName:String: the name of the configuration (for example, "profile" or "default"), not null

Exceptions

IllegalArgumentException:: if no recording with the specified ID exists

See Also

getConfigurations()

setRecordingOptions back to summary

setRecordingOptions	back to summary
public void setRecordingOptions(long recordingId, Map<String, String> options) throws IllegalArgumentException Configures the recording options (for example, destination file and time span to keep data). See `FlightRecorderMXBean` for a description of the options and values that can be used. Setting a value to `null` restores the value to the default value. Parameters recordingId:long the ID of the recording to set options for options:Map<String, String> name/value map of the settings to set, not `null` Exceptions IllegalArgumentException: if no recording with the specified ID exists See Also `Recording#getId()`

public void setRecordingOptions(long recordingId, Map<String, String> options) throws IllegalArgumentException

Configures the recording options (for example, destination file and time span to keep data).

See FlightRecorderMXBean for a description of the options and values that can be used. Setting a value to null restores the value to the default value.

Parameters

recordingId:long: the ID of the recording to set options for
options:Map<String, String>: name/value map of the settings to set, not null

Exceptions

IllegalArgumentException:: if no recording with the specified ID exists

See Also

Recording#getId()

setRecordingSettings back to summary

setRecordingSettings	back to summary
public void setRecordingSettings(long recordingId, Map<String, String> settings) throws IllegalArgumentException Sets and replaces all previous settings for the specified recording. A setting consists of a name/value pair, where name specifies the event and setting to configure, and the value specifies what to set it to. The name can be formed in the following ways: `<event-name> + "#" + <setting-name>` or `<event-id> + "#" + <setting-name>` For example, to set the sample interval of the CPU Load event to once every second, use the name `"jdk.CPULoad#period"` and the value `"1 s"`. If multiple events use the same name, for example if an event class is loaded in multiple class loaders, and differentiation is needed between them, then the name is `"56#period"`. The ID for an event is obtained by invoking `jdk.jfr.EventType#getId()` method and is valid for the Java Virtual Machine (JVM) instance that the event is registered in. A list of available event names is retrieved by invoking `jdk.jfr.FlightRecorder#getEventTypes()` and `jdk.jfr.EventType#getName()`. A list of available settings for an event type is obtained by invoking `jdk.jfr.EventType#getSettingDescriptors()` and `jdk.jfr.ValueDescriptor#getName()`. Parameters recordingId:long ID of the recording settings:Map<String, String> name value map of the settings to set, not `null` Exceptions IllegalArgumentException: if no recording with the specified ID exists See Also `Recording#getId()`

public void setRecordingSettings(long recordingId, Map<String, String> settings) throws IllegalArgumentException

Sets and replaces all previous settings for the specified recording.

A setting consists of a name/value pair, where name specifies the event and setting to configure, and the value specifies what to set it to.

The name can be formed in the following ways:

<event-name> + "#" + <setting-name>

<event-id> + "#" + <setting-name>

For example, to set the sample interval of the CPU Load event to once every second, use the name "jdk.CPULoad#period" and the value "1 s". If multiple events use the same name, for example if an event class is loaded in multiple class loaders, and differentiation is needed between them, then the name is "56#period". The ID for an event is obtained by invoking jdk.jfr.EventType#getId() method and is valid for the Java Virtual Machine (JVM) instance that the event is registered in.

A list of available event names is retrieved by invoking jdk.jfr.FlightRecorder#getEventTypes() and jdk.jfr.EventType#getName(). A list of available settings for an event type is obtained by invoking jdk.jfr.EventType#getSettingDescriptors() and jdk.jfr.ValueDescriptor#getName().

Parameters

recordingId:long: ID of the recording
settings:Map<String, String>: name value map of the settings to set, not null

Exceptions

IllegalArgumentException:: if no recording with the specified ID exists

See Also

Recording#getId()

startRecording back to summary

startRecording	back to summary
public void startRecording(long recordingId) throws IllegalStateException Starts the recording with the specified ID. A recording that is stopped can't be restarted. Parameters recordingId:long ID of the recording to start Exceptions IllegalArgumentException: if a recording with the specified ID doesn't exist See Also `Recording`

public void startRecording(long recordingId) throws IllegalStateException

Starts the recording with the specified ID.

A recording that is stopped can't be restarted.

Parameters

recordingId:long: ID of the recording to start

Exceptions

IllegalArgumentException:: if a recording with the specified ID doesn't exist

See Also

Recording

stopRecording back to summary

stopRecording	back to summary
public boolean stopRecording(long recordingId) throws IllegalArgumentException, IllegalStateException Stops the running recording with the specified ID. Parameters recordingId:long the ID of the recording to stop Returns:boolean `true` if the recording is stopped, `false` otherwise Exceptions IllegalArgumentException: if a recording with the specified ID doesn't exist IllegalStateException: if the recording is not running See Also `newRecording()`

public boolean stopRecording(long recordingId) throws IllegalArgumentException, IllegalStateException

Stops the running recording with the specified ID.

Parameters

recordingId:long: the ID of the recording to stop

Returns:boolean

true if the recording is stopped, false otherwise

Exceptions

IllegalArgumentException:: if a recording with the specified ID doesn't exist
IllegalStateException:: if the recording is not running

See Also

newRecording()

takeSnapshot back to summary

takeSnapshot	back to summary
public long takeSnapshot() Creates a snapshot recording of all available recorded data. A snapshot is a synthesized recording in a stopped state. If no data is available, a recording with size `0` is returned. A snapshot provides stable access to data for later operations (for example, operations to change the time interval or to reduce the data size). The caller must close the recording when access to the data is no longer needed. Returns:long a unique ID that can be used for reading recording data See Also `Recording`

public long takeSnapshot()

Creates a snapshot recording of all available recorded data.

A snapshot is a synthesized recording in a stopped state. If no data is available, a recording with size 0 is returned.

A snapshot provides stable access to data for later operations (for example, operations to change the time interval or to reduce the data size).

The caller must close the recording when access to the data is no longer needed.

Returns:long: a unique ID that can be used for reading recording data
See Also: Recording

public Interface FlightRecorderMXBean

Recording options

Field Summary

Method Summary

Field Detail

Method Detail