+ * The following example shows how to record events using the default + * configuration and print the Garbage Collection, CPU Load and JVM Information + * event to standard out. + *
+ *
+ * Configuration c = Configuration.getConfiguration("default");
+ * try (var rs = new RecordingStream(c)) {
+ * rs.onEvent("jdk.GarbageCollection", System.out::println);
+ * rs.onEvent("jdk.CPULoad", System.out::println);
+ * rs.onEvent("jdk.JVMInformation", System.out::println);
+ * rs.start();
+ * }
+ * }
+ *
+ *
+ *
+ * @since 14
+ */
+public final class RecordingStream implements AutoCloseable, EventStream {
+
+ private final Recording recording;
+ private final EventDirectoryStream directoryStream;
+
+ /**
+ * Creates an event stream for the current JVM (Java Virtual Machine).
+ *
+ * @throws 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)
+ *
+ * @throws SecurityException if a security manager exists and the caller
+ * does not have
+ * {@code FlightRecorderPermission("accessFlightRecorder")}
+ */
+ public RecordingStream() {
+ Utils.checkAccessFlightRecorder();
+ AccessControlContext acc = AccessController.getContext();
+ this.recording = new Recording();
+ this.recording.setFlushInterval(Duration.ofMillis(1000));
+ try {
+ this.directoryStream = new EventDirectoryStream(acc, null, SecuritySupport.PRIVILIGED, true);
+ } catch (IOException ioe) {
+ this.recording.close();
+ throw new IllegalStateException(ioe.getMessage());
+ }
+ }
+
+ /**
+ * Creates a recording stream using settings from a configuration.
+ * + * The following example shows how to create a recording stream that uses a + * predefined configuration. + * + *
+ *
+ * var c = Configuration.getConfiguration("default");
+ * try (var rs = new RecordingStream(c)) {
+ * rs.onEvent(System.out::println);
+ * rs.start();
+ * }
+ *
+ *
+ *
+ * @param configuration configuration that contains the settings to use,
+ * not {@code null}
+ *
+ * @throws 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)
+ *
+ * @throws SecurityException if a security manager is used and
+ * FlightRecorderPermission "accessFlightRecorder" is not set.
+ *
+ * @see Configuration
+ */
+ public RecordingStream(Configuration configuration) {
+ this();
+ recording.setSettings(configuration.getSettings());
+ }
+
+ /**
+ * Enables the event with the specified name.
+ * + * If multiple events have the same name (for example, the same class is + * loaded in different class loaders), then all events that match the name + * are enabled. To enable a specific class, use the {@link #enable(Class)} + * method or a {@code String} representation of the event type ID. + * + * @param name the settings for the event, not {@code null} + * + * @return an event setting for further configuration, not {@code null} + * + * @see EventType + */ + public EventSettings enable(String name) { + return recording.enable(name); + } + + /** + * Replaces all settings for this recording stream. + *
+ * The following example records 20 seconds using the "default" configuration + * and then changes settings to the "profile" configuration. + * + *
+ *
+ * Configuration defaultConfiguration = Configuration.getConfiguration("default");
+ * Configuration profileConfiguration = Configuration.getConfiguration("profile");
+ * try (var rs = new RecordingStream(defaultConfiguration) {
+ * rs.onEvent(System.out::println);
+ * rs.startAsync();
+ * Thread.sleep(20_000);
+ * rs.setSettings(profileConfiguration.getSettings());
+ * Thread.sleep(20_000);
+ * }
+ *
+ *
+ *
+ * @param settings the settings to set, not {@code null}
+ *
+ * @see Recording#setSettings(Map)
+ */
+ public void setSettings(Map+ * If multiple events with same name (for example, the same class is loaded + * in different class loaders), then all events that match the name are + * disabled. To disable a specific class, use the {@link #disable(Class)} + * method or a {@code String} representation of the event type ID. + * + * @param name the settings for the event, not {@code null} + * + * @return an event setting for further configuration, not {@code null} + * + */ + public EventSettings disable(String name) { + return recording.disable(name); + } + + /** + * Disables event. + * + * @param eventClass the event to enable, not {@code null} + * + * @throws IllegalArgumentException if {@code eventClass} is an abstract + * class or not a subclass of {@link Event} + * + * @return an event setting for further configuration, not {@code null} + * + */ + public EventSettings disable(Class eventClass) { + return recording.disable(eventClass); + } + + /** + * Determines how far back data is kept for the stream. + *
+ * To control the amount of recording data stored on disk, the maximum + * length of time to retain the data can be specified. Data stored on disk + * that is older than the specified length of time is removed by the Java + * Virtual Machine (JVM). + *
+ * If neither maximum limit or the maximum age is set, the size of the + * recording may grow indefinitely if events are on + * + * @param maxAge the length of time that data is kept, or {@code null} if + * infinite + * + * @throws IllegalArgumentException if {@code maxAge} is negative + * + * @throws IllegalStateException if the recording is in the {@code CLOSED} + * state + */ + public void setMaxAge(Duration maxAge) { + recording.setMaxAge(maxAge); + } + + /** + * Determines how much data is kept for the stream. + *
+ * To control the amount of recording data that is stored on disk, the + * maximum amount of data to retain can be specified. When the maximum limit + * is exceeded, the Java Virtual Machine (JVM) removes the oldest chunk to + * make room for a more recent chunk. + *
+ * If neither maximum limit or the maximum age is set, the size of the + * recording may grow indefinitely. + *
+ * The size is measured in bytes.
+ *
+ * @param maxSize the amount of data to retain, {@code 0} if infinite
+ *
+ * @throws IllegalArgumentException if {@code maxSize} is negative
+ *
+ * @throws IllegalStateException if the recording is in {@code CLOSED} state
+ */
+ public void setMaxSize(long maxSize) {
+ recording.setMaxSize(maxSize);
+ }
+
+ /**
+ * Determines how often events are made available for streaming.
+ *
+ * @param interval the interval at which events are made available to the
+ * stream, no {@code null}
+ *
+ * @throws IllegalArgumentException if {@code interval} is negative
+ *
+ * @throws IllegalStateException if the stream is closed
+ */
+ public void setFlushInterval(Duration interval) {
+ recording.setFlushInterval(interval);
+ }
+
+ @Override
+ public void setReuse(boolean reuse) {
+ directoryStream.setReuse(reuse);
+ }
+
+ @Override
+ public void setOrdered(boolean ordered) {
+ directoryStream.setOrdered(ordered);
+ }
+
+ @Override
+ public void setStartTime(Instant startTime) {
+ directoryStream.setStartTime(startTime);
+ }
+
+ @Override
+ public void setEndTime(Instant endTime) {
+ directoryStream.setEndTime(endTime);
+ }
+
+ @Override
+ public void onEvent(String eventName, Consumer