aldettinger commented on a change in pull request #3319:
URL: https://github.com/apache/camel-quarkus/pull/3319#discussion_r754936967
##########
File path: docs/modules/ROOT/pages/reference/extensions/jfr.adoc
##########
@@ -34,38 +38,75 @@ Please refer to the above link for usage and configuration
details.
Check the xref:user-guide/index.adoc[User guide] for more information about
writing Camel Quarkus applications.
+== Usage
+
+### Starting flight recording
+
+To enable Java Flight Recorder to start a recording and automatically dump the
recording to disk after Camel startup is complete, use the following
configuration in `application.properties`.
+
+[source,properties]
+----
+quarkus.camel.jfr.startup-recorder-recording=true
+----
+
+Alternatively you can pass some Java options to the runnable application JAR
or the native executable to enable flight recording at application startup.
+
+In JVM mode the application runnable JAR can be executed as follows.
+
+[source,shell]
+----
+$ java -XX:+FlightRecorder -XX:StartFlightRecording=filename=recording.jfr
-jar quarkus-run.jar
+----
+
+In native mode, the native executable can be executed as follows.
+
+[source,shell]
+----
+$ ./my-application-runner -XX:+FlightRecorder
-XX:StartFlightRecording=filename=recording.jfr
+----
+
+### Flight recording in native mode
+
+To build a native image with Java Flight Recorder support, it is mandatory to
enable VM inspection via the following configuration property in
`application.properties`.
+
+[source,properties]
+----
+quarkus.native.enable-vm-inspection=true
+----
+
+
== Additional Camel Quarkus configuration
[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default
Review comment:
It's not really linked to this PR. I've noticed that the default value
column is empty.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
