// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
= Jfr
:linkattrs:
:cq-artifact-id: camel-quarkus-jfr
:cq-native-supported: false
:cq-status: Preview
:cq-status-deprecation: Preview
:cq-description: Diagnose Camel applications with Java Flight Recorder
:cq-deprecated: false
:cq-jvm-since: 1.7.0
:cq-native-since: n/a

[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.7.0## [.badge-key]##Native##[.badge-unsupported]##unsupported##

Diagnose Camel applications with Java Flight Recorder

== What's inside

* xref:{cq-camel-components}:others:jfr.adoc[Jfr]

Please refer to the above link for usage and configuration details.

== Maven coordinates

[source,xml]
----
<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-jfr</artifactId>
</dependency>
----

Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.

== Additional Camel Quarkus configuration

[width="100%",cols="80,5,15",options="header"]
|===
| Configuration property | Type | Default


|icon:lock[title=Fixed at build time] [[quarkus.camel.jfr.startup-recorder-dir]]`link:#quarkus.camel.jfr.startup-recorder-dir[quarkus.camel.jfr.startup-recorder-dir]`

Directory to store the recording. By default the current directory will be used. Use false to turn off saving the recording to disk.
| `string`
| 

|icon:lock[title=Fixed at build time] [[quarkus.camel.jfr.startup-recorder-duration]]`link:#quarkus.camel.jfr.startup-recorder-duration[quarkus.camel.jfr.startup-recorder-duration]`

How long time to run the startup recorder. Use 0 (default) to keep the recorder running until the JVM is exited. Use -1 to stop the recorder right after Camel has been started (to only focus on potential Camel startup performance bottlenecks) Use a positive value to keep recording for N seconds. When the recorder is stopped then the recording is auto saved to disk (note: save to disk can be disabled by setting startupRecorderDir to false).
| `java.lang.Long`
| 

|icon:lock[title=Fixed at build time] [[quarkus.camel.jfr.startup-recorder-max-depth]]`link:#quarkus.camel.jfr.startup-recorder-max-depth[quarkus.camel.jfr.startup-recorder-max-depth]`

To filter our sub steps at a maximum depth. Use -1 for no maximum. Use 0 for no sub steps. Use 1 for max 1 sub step, and so forth. The default is -1.
| `java.lang.Integer`
| 

|icon:lock[title=Fixed at build time] [[quarkus.camel.jfr.startup-recorder-profile]]`link:#quarkus.camel.jfr.startup-recorder-profile[quarkus.camel.jfr.startup-recorder-profile]`

To use a specific Java Flight Recorder profile configuration, such as default or profile. The default is default.
| `string`
| 

|icon:lock[title=Fixed at build time] [[quarkus.camel.jfr.startup-recorder-recording]]`link:#quarkus.camel.jfr.startup-recorder-recording[quarkus.camel.jfr.startup-recorder-recording]`

To enable Java Flight Recorder to start a recording and automatic dump the recording to disk after startup is complete. This requires that camel-jfr is on the classpath. The default is false.
| `java.lang.Boolean`
| 
|===

[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime.

