This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new ecf345cd598 Polished doc about load
ecf345cd598 is described below
commit ecf345cd598970cc33e106ec898290f652233b72
Author: Claus Ibsen <[email protected]>
AuthorDate: Wed Dec 18 10:39:56 2024 +0100
Polished doc about load
---
.../camel/catalog/main/camel-main-configuration-metadata.json | 2 +-
.../src/main/java/org/apache/camel/spi/ManagementAgent.java | 5 +++--
.../resources/META-INF/camel-main-configuration-metadata.json | 2 +-
core/camel-main/src/main/docs/main.adoc | 2 +-
.../java/org/apache/camel/main/DefaultConfigurationProperties.java | 4 ++--
.../apache/camel/api/management/mbean/ManagedCamelContextMBean.java | 6 +++---
.../org/apache/camel/api/management/mbean/ManagedRouteMBean.java | 6 +++---
.../main/java/org/apache/camel/management/mbean/LoadTriplet.java | 2 +-
8 files changed, 15 insertions(+), 14 deletions(-)
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 77e927f78d3..1e74936c353 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.jmxUpdateRouteEnabled", "description": "Whether to
allow updating routes at runtime via JMX using the ManagedRouteMBean. This is
disabled by default, but can be enabled for development and troubleshooting
purposes, such as updating routes in an existing running Camel via JMX and
other tools.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.lightweight", "description": "Configure the context
to be lightweight. This will trigger some optimizations and memory reduction
options. Lightweight context have some limitations. At this moment, dynamic
endpoint destinations are not supported.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.loadHealthChecks", "description": "Whether to load
custom health checks by scanning classpath.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
- { "name": "camel.main.loadStatisticsEnabled", "description": "Sets whether
context load statistics is enabled (something like the unix load average). The
statistics requires to have camel-management on the classpath as JMX is
required. The default value is false.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
+ { "name": "camel.main.loadStatisticsEnabled", "description": "Sets whether
Camel load (inflight messages, not cpu) statistics is enabled (something like
the unix load average). The statistics requires to have camel-management on the
classpath as JMX is required. The default value is false.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.loadTypeConverters", "description": "Whether to load
custom type converters by scanning classpath. This is used for backwards
compatibility with Camel 2.x. Its recommended to migrate to use fast type
converter loading by setting Converter(loader = true) on your custom type
converter classes.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.logDebugMaxChars", "description": "Is used to limit
the maximum length of the logging Camel message bodies. If the message body is
longer than the limit, the log message is clipped. Use -1 to have unlimited
length. Use for example 1000 to log at most 1000 characters.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "integer",
"javaType": "int" },
{ "name": "camel.main.logExhaustedMessageBody", "description": "Sets
whether to log exhausted message body with message history. Default is false.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type":
"boolean", "javaType": "boolean", "defaultValue": "false" },
diff --git
a/core/camel-api/src/main/java/org/apache/camel/spi/ManagementAgent.java
b/core/camel-api/src/main/java/org/apache/camel/spi/ManagementAgent.java
index 3e5c4a2624c..96b90989f81 100644
--- a/core/camel-api/src/main/java/org/apache/camel/spi/ManagementAgent.java
+++ b/core/camel-api/src/main/java/org/apache/camel/spi/ManagementAgent.java
@@ -273,7 +273,8 @@ public interface ManagementAgent extends Service {
void setManagementNamePattern(String managementNamePattern);
/**
- * Sets whether load statistics is enabled (gathers load statistics using
a background thread per CamelContext).
+ * Sets whether Camel load (inflight messages, not cpu) statistics is
enabled (something like the unix load
+ * average). The statistics requires to have camel-management on the
classpath as JMX is required.
* <p/>
* The default value is <tt>false</tt>
*
@@ -282,7 +283,7 @@ public interface ManagementAgent extends Service {
void setLoadStatisticsEnabled(Boolean flag);
/**
- * Gets whether load statistics is enabled
+ * Gets whether load (inflight messages, not cpu) statistics is enabled
*
* @return <tt>true</tt> if enabled
*/
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 77e927f78d3..1e74936c353 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.jmxUpdateRouteEnabled", "description": "Whether to
allow updating routes at runtime via JMX using the ManagedRouteMBean. This is
disabled by default, but can be enabled for development and troubleshooting
purposes, such as updating routes in an existing running Camel via JMX and
other tools.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.lightweight", "description": "Configure the context
to be lightweight. This will trigger some optimizations and memory reduction
options. Lightweight context have some limitations. At this moment, dynamic
endpoint destinations are not supported.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.loadHealthChecks", "description": "Whether to load
custom health checks by scanning classpath.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
- { "name": "camel.main.loadStatisticsEnabled", "description": "Sets whether
context load statistics is enabled (something like the unix load average). The
statistics requires to have camel-management on the classpath as JMX is
required. The default value is false.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
+ { "name": "camel.main.loadStatisticsEnabled", "description": "Sets whether
Camel load (inflight messages, not cpu) statistics is enabled (something like
the unix load average). The statistics requires to have camel-management on the
classpath as JMX is required. The default value is false.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.loadTypeConverters", "description": "Whether to load
custom type converters by scanning classpath. This is used for backwards
compatibility with Camel 2.x. Its recommended to migrate to use fast type
converter loading by setting Converter(loader = true) on your custom type
converter classes.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "boolean",
"javaType": "boolean", "defaultValue": "false" },
{ "name": "camel.main.logDebugMaxChars", "description": "Is used to limit
the maximum length of the logging Camel message bodies. If the message body is
longer than the limit, the log message is clipped. Use -1 to have unlimited
length. Use for example 1000 to log at most 1000 characters.", "sourceType":
"org.apache.camel.main.DefaultConfigurationProperties", "type": "integer",
"javaType": "int" },
{ "name": "camel.main.logExhaustedMessageBody", "description": "Sets
whether to log exhausted message body with message history. Default is false.",
"sourceType": "org.apache.camel.main.DefaultConfigurationProperties", "type":
"boolean", "javaType": "boolean", "defaultValue": "false" },
diff --git a/core/camel-main/src/main/docs/main.adoc
b/core/camel-main/src/main/docs/main.adoc
index b2158f5e316..1442307f556 100644
--- a/core/camel-main/src/main/docs/main.adoc
+++ b/core/camel-main/src/main/docs/main.adoc
@@ -80,7 +80,7 @@ The camel.main supports 122 options, which are listed below.
| *camel.main.jmxUpdateRoute{zwsp}Enabled* | Whether to allow updating routes
at runtime via JMX using the ManagedRouteMBean. This is disabled by default,
but can be enabled for development and troubleshooting purposes, such as
updating routes in an existing running Camel via JMX and other tools. | false |
boolean
| *camel.main.lightweight* | Configure the context to be lightweight. This
will trigger some optimizations and memory reduction options. Lightweight
context have some limitations. At this moment, dynamic endpoint destinations
are not supported. | false | boolean
| *camel.main.loadHealthChecks* | Whether to load custom health checks by
scanning classpath. | false | boolean
-| *camel.main.loadStatistics{zwsp}Enabled* | Sets whether context load
statistics is enabled (something like the unix load average). The statistics
requires to have camel-management on the classpath as JMX is required. The
default value is false. | false | boolean
+| *camel.main.loadStatistics{zwsp}Enabled* | Sets whether Camel load (inflight
messages, not cpu) statistics is enabled (something like the unix load
average). The statistics requires to have camel-management on the classpath as
JMX is required. The default value is false. | false | boolean
| *camel.main.loadTypeConverters* | Whether to load custom type converters by
scanning classpath. This is used for backwards compatibility with Camel 2.x.
Its recommended to migrate to use fast type converter loading by setting
Converter(loader = true) on your custom type converter classes. | false |
boolean
| *camel.main.logDebugMaxChars* | Is used to limit the maximum length of the
logging Camel message bodies. If the message body is longer than the limit, the
log message is clipped. Use -1 to have unlimited length. Use for example 1000
to log at most 1000 characters. | | int
| *camel.main.logExhaustedMessage{zwsp}Body* | Sets whether to log exhausted
message body with message history. Default is false. | false | boolean
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 f08a61d59a5..3589ab22757 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
@@ -867,8 +867,8 @@ public abstract class DefaultConfigurationProperties<T> {
}
/**
- * Sets whether context load statistics is enabled (something like the
unix load average). The statistics requires
- * to have camel-management on the classpath as JMX is required.
+ * Sets whether Camel load (inflight messages, not cpu) statistics is
enabled (something like the unix load
+ * average). The statistics requires to have camel-management on the
classpath as JMX is required.
*
* The default value is false.
*/
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
index a2b8485f749..1767d4354f4 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedCamelContextMBean.java
@@ -117,13 +117,13 @@ public interface ManagedCamelContextMBean extends
ManagedPerformanceCounterMBean
@ManagedAttribute(description = "Whether to force shutdown now when a
timeout occurred")
boolean isShutdownNowOnTimeout();
- @ManagedAttribute(description = "Average load over the last minute")
+ @ManagedAttribute(description = "Average load (inflight messages, not cpu)
over the last minute")
String getLoad01();
- @ManagedAttribute(description = "Average load over the last five minutes")
+ @ManagedAttribute(description = "Average load (inflight messages, not cpu)
over the last five minutes")
String getLoad05();
- @ManagedAttribute(description = "Average load over the last fifteen
minutes")
+ @ManagedAttribute(description = "Average load (inflight messages, not cpu)
over the last fifteen minutes")
String getLoad15();
@ManagedAttribute(description = "Throughput message/second")
diff --git
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
index 514230d8e83..7c3a4f761a2 100644
---
a/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
+++
b/core/camel-management-api/src/main/java/org/apache/camel/api/management/mbean/ManagedRouteMBean.java
@@ -88,13 +88,13 @@ public interface ManagedRouteMBean extends
ManagedPerformanceCounterMBean {
@ManagedAttribute(description = "Route Policy List")
String getRoutePolicyList();
- @ManagedAttribute(description = "Average load over the last minute")
+ @ManagedAttribute(description = "Average load (inflight messages, not cpu)
over the last minute")
String getLoad01();
- @ManagedAttribute(description = "Average load over the last five minutes")
+ @ManagedAttribute(description = "Average load (inflight messages, not cpu)
over the last five minutes")
String getLoad05();
- @ManagedAttribute(description = "Average load over the last fifteen
minutes")
+ @ManagedAttribute(description = "Average load (inflight messages, not cpu)
over the last fifteen minutes")
String getLoad15();
@ManagedAttribute(description = "Throughput message/second")
diff --git
a/core/camel-management/src/main/java/org/apache/camel/management/mbean/LoadTriplet.java
b/core/camel-management/src/main/java/org/apache/camel/management/mbean/LoadTriplet.java
index 83a6f5df365..6e381c8a536 100644
---
a/core/camel-management/src/main/java/org/apache/camel/management/mbean/LoadTriplet.java
+++
b/core/camel-management/src/main/java/org/apache/camel/management/mbean/LoadTriplet.java
@@ -20,7 +20,7 @@ import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
/**
- * Holds the loads averaged over 1min, 5min, and 15min.
+ * Holds the loads (inflight messages, not cpu) averaged over 1min, 5min, and
15min.
*/
public final class LoadTriplet {
