This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push:
new d800937 camel-jfr - Do not start recording automatic
d800937 is described below
commit d80093733209c401ac47d2b67415d146cab29f42
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Tue Feb 9 09:00:58 2021 +0100
camel-jfr - Do not start recording automatic
---
.../generated/resources/org/apache/camel/catalog/docs/jfr.adoc | 6 +++++-
.../camel/catalog/main/camel-main-configuration-metadata.json | 2 +-
components/camel-jfr/src/main/docs/jfr.adoc | 6 +++++-
.../resources/META-INF/camel-main-configuration-metadata.json | 2 +-
core/camel-main/src/main/docs/main.adoc | 2 +-
.../org/apache/camel/main/DefaultConfigurationProperties.java | 10 +++-------
docs/components/modules/others/pages/jfr.adoc | 6 +++++-
7 files changed, 21 insertions(+), 13 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jfr.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jfr.adoc
index 0b66da7..20c4114 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jfr.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/jfr.adoc
@@ -23,7 +23,11 @@ See the __startupRecorder__ options from
xref:components:others:main.adoc[Camel
[[jfr-Example]]
== Example
-To enable you just need to add `camel-jfr` to the classpath.
+To enable you just need to add `camel-jfr` to the classpath, and enable JFR
recording.
+
+JFR recordings can be started either at:
+- When running the JVM using JVM arguments
+- When starting Camel by setting `camel.main.startup-recorder-recording=true`.
See the `camel-example-flight-recorder` from the Camel Examples.
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
index bab09f1..d443467 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/main/camel-main-configuration-metadata.json
@@ -79,7 +79,7 @@
{ "name": "camel.main.startupRecorderDuration", "description": "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 startupRec [...]
{ "name": "camel.main.startupRecorderMaxDepth", "description": "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.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type":
"integer", "javaType": "int", "defaultValue": -1 },
{ "name": "camel.main.startupRecorderProfile", "description": "To use a
specific Java Flight Recorder profile configuration, such as default or
profile. The default is default.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "string",
"javaType": "java.lang.String", "defaultValue": "default" },
- { "name": "camel.main.startupRecorderRecording", "description": "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 true.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": true },
+ { "name": "camel.main.startupRecorderRecording", "description": "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, and to enable this option.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean" },
{ "name": "camel.main.startupSummaryLevel", "description": "Controls the
level of information logged during startup (and shutdown) of CamelContext.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type":
"object", "javaType": "org.apache.camel.StartupSummaryLevel", "defaultValue":
"Default" },
{ "name": "camel.main.streamCachingAnySpoolRules", "description": "Sets
whether if just any of the org.apache.camel.spi.StreamCachingStrategy.SpoolRule
rules returns true then shouldSpoolCache(long) returns true, to allow spooling
to disk. If this option is false, then all the
org.apache.camel.spi.StreamCachingStrategy.SpoolRule must return true. The
default value is false which means that all the rules must return true.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProp [...]
{ "name": "camel.main.streamCachingBufferSize", "description": "Sets the
stream caching buffer size to use when allocating in-memory buffers used for
in-memory stream caches. The default size is 4096.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "integer",
"javaType": "int" },
diff --git a/components/camel-jfr/src/main/docs/jfr.adoc
b/components/camel-jfr/src/main/docs/jfr.adoc
index 0b66da7..20c4114 100644
--- a/components/camel-jfr/src/main/docs/jfr.adoc
+++ b/components/camel-jfr/src/main/docs/jfr.adoc
@@ -23,7 +23,11 @@ See the __startupRecorder__ options from
xref:components:others:main.adoc[Camel
[[jfr-Example]]
== Example
-To enable you just need to add `camel-jfr` to the classpath.
+To enable you just need to add `camel-jfr` to the classpath, and enable JFR
recording.
+
+JFR recordings can be started either at:
+- When running the JVM using JVM arguments
+- When starting Camel by setting `camel.main.startup-recorder-recording=true`.
See the `camel-example-flight-recorder` from the Camel Examples.
diff --git
a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
index bab09f1..d443467 100644
---
a/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
+++
b/core/camel-main/src/generated/resources/META-INF/camel-main-configuration-metadata.json
@@ -79,7 +79,7 @@
{ "name": "camel.main.startupRecorderDuration", "description": "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 startupRec [...]
{ "name": "camel.main.startupRecorderMaxDepth", "description": "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.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type":
"integer", "javaType": "int", "defaultValue": -1 },
{ "name": "camel.main.startupRecorderProfile", "description": "To use a
specific Java Flight Recorder profile configuration, such as default or
profile. The default is default.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "string",
"javaType": "java.lang.String", "defaultValue": "default" },
- { "name": "camel.main.startupRecorderRecording", "description": "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 true.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": true },
+ { "name": "camel.main.startupRecorderRecording", "description": "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, and to enable this option.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean" },
{ "name": "camel.main.startupSummaryLevel", "description": "Controls the
level of information logged during startup (and shutdown) of CamelContext.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type":
"object", "javaType": "org.apache.camel.StartupSummaryLevel", "defaultValue":
"Default" },
{ "name": "camel.main.streamCachingAnySpoolRules", "description": "Sets
whether if just any of the org.apache.camel.spi.StreamCachingStrategy.SpoolRule
rules returns true then shouldSpoolCache(long) returns true, to allow spooling
to disk. If this option is false, then all the
org.apache.camel.spi.StreamCachingStrategy.SpoolRule must return true. The
default value is false which means that all the rules must return true.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProp [...]
{ "name": "camel.main.streamCachingBufferSize", "description": "Sets the
stream caching buffer size to use when allocating in-memory buffers used for
in-memory stream caches. The default size is 4096.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "integer",
"javaType": "int" },
diff --git a/core/camel-main/src/main/docs/main.adoc
b/core/camel-main/src/main/docs/main.adoc
index 176b620..435375a 100644
--- a/core/camel-main/src/main/docs/main.adoc
+++ b/core/camel-main/src/main/docs/main.adoc
@@ -91,7 +91,7 @@ The following table lists all the options:
| *camel.main.startupRecorder{zwsp}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) | | long
| *camel.main.startupRecorderMax{zwsp}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. | -1 | int
| *camel.main.startupRecorder{zwsp}Profile* | To use a specific Java Flight
Recorder profile configuration, such as default or profile. The default is
default. | default | String
-| *camel.main.startupRecorder{zwsp}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
true. | true | boolean
+| *camel.main.startupRecorder{zwsp}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, and to enable this
option. | | boolean
| *camel.main.startupSummaryLevel* | Controls the level of information logged
during startup (and shutdown) of CamelContext. | Default | StartupSummaryLevel
| *camel.main.streamCachingAny{zwsp}SpoolRules* | Sets whether if just any of
the org.apache.camel.spi.StreamCachingStrategy.SpoolRule rules returns true
then shouldSpoolCache(long) returns true, to allow spooling to disk. If this
option is false, then all the
org.apache.camel.spi.StreamCachingStrategy.SpoolRule must return true. The
default value is false which means that all the rules must return true. | |
boolean
| *camel.main.streamCachingBuffer{zwsp}Size* | Sets the stream caching buffer
size to use when allocating in-memory buffers used for in-memory stream caches.
The default size is 4096. | | int
diff --git
a/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
b/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
index 7d2f0c6..c66cd89 100644
---
a/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
+++
b/core/camel-main/src/main/java/org/apache/camel/main/DefaultConfigurationProperties.java
@@ -105,7 +105,7 @@ public abstract class DefaultConfigurationProperties<T> {
private boolean routeControllerUnhealthyOnExhausted;
private String startupRecorder;
private int startupRecorderMaxDepth = -1;
- private boolean startupRecorderRecording = true;
+ private boolean startupRecorderRecording;
private String startupRecorderProfile = "default";
private long startupRecorderDuration;
private String startupRecorderDir;
@@ -1126,9 +1126,7 @@ public abstract class DefaultConfigurationProperties<T> {
* 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 true.
+ * This requires that camel-jfr is on the classpath, and to enable this
option.
*/
public void setStartupRecorderRecording(boolean startupRecorderRecording) {
this.startupRecorderRecording = startupRecorderRecording;
@@ -1936,9 +1934,7 @@ public abstract class DefaultConfigurationProperties<T> {
* 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 in use.
- *
- * The default is false.
+ * This requires that camel-jfr is on the classpath, and to enable this
option.
*/
public T withStartupRecorderRecording(boolean startupRecorderRecording) {
this.startupRecorderRecording = startupRecorderRecording;
diff --git a/docs/components/modules/others/pages/jfr.adoc
b/docs/components/modules/others/pages/jfr.adoc
index 45f5abb..30b6895 100644
--- a/docs/components/modules/others/pages/jfr.adoc
+++ b/docs/components/modules/others/pages/jfr.adoc
@@ -25,7 +25,11 @@ See the __startupRecorder__ options from
xref:components:others:main.adoc[Camel
[[jfr-Example]]
== Example
-To enable you just need to add `camel-jfr` to the classpath.
+To enable you just need to add `camel-jfr` to the classpath, and enable JFR
recording.
+
+JFR recordings can be started either at:
+- When running the JVM using JVM arguments
+- When starting Camel by setting `camel.main.startup-recorder-recording=true`.
See the `camel-example-flight-recorder` from the Camel Examples.
