You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by or...@apache.org on 2024/02/25 11:48:26 UTC
(camel) branch main updated (ebc17f01f13 -> d778e5f952c)
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
from ebc17f01f13 CAMEL-18858: camel-core - Mark route as created by Kamelet so we know this, so we can filter out in tooling and whereelse (kamelet is a blackbox)
new 9651df6fadf CAMEL-20459: documentation fixes for the fault tolerance EIP.
new 87f3832b9d4 CAMEL-20459: documentation fixes for the filter EIP.
new 8d166e93c3d CAMEL-20459: documentation fixes for the from EIP.
new f4cf029a83f CAMEL-20459: documentation fixes for the guaranteed delivery EIP.
new eee42bd0952 CAMEL-20459: documentation fixes for the idempotent consumer EIP.
new 2aecdb71484 CAMEL-20459: documentation fixes for the intercept EIP.
new 1a2dcb09ae7 CAMEL-20459: documentation fixes for the kamelet EIP.
new 452e96068aa CAMEL-20459: documentation fixes for the load-balance EIP.
new d778e5f952c CAMEL-20459: documentation fixes for the log EIP.
The 9 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../modules/eips/pages/fault-tolerance-eip.adoc | 18 +-
.../main/docs/modules/eips/pages/filter-eip.adoc | 8 +-
.../src/main/docs/modules/eips/pages/from-eip.adoc | 4 +-
.../modules/eips/pages/guaranteed-delivery.adoc | 4 +-
.../modules/eips/pages/idempotentConsumer-eip.adoc | 5 +-
.../main/docs/modules/eips/pages/intercept.adoc | 187 +++++++++++++++------
.../main/docs/modules/eips/pages/kamelet-eip.adoc | 23 ++-
.../docs/modules/eips/pages/loadBalance-eip.adoc | 8 +-
.../src/main/docs/modules/eips/pages/log-eip.adoc | 83 ++++++---
9 files changed, 240 insertions(+), 100 deletions(-)
(camel) 05/09: CAMEL-20459: documentation fixes for the idempotent consumer EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit eee42bd0952c4cf975cba99756cc9b3454e6f4bd
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 09:02:36 2024 +0100
CAMEL-20459: documentation fixes for the idempotent consumer EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc
index bf4e269c443..45c532990a8 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/idempotentConsumer-eip.adoc
@@ -7,8 +7,7 @@
:tabs-sync-option:
The
-http://www.enterpriseintegrationpatterns.com/IdempotentReceiver.html[Idempotent
-Consumer] from the xref:enterprise-integration-patterns.adoc[EIP
+http://www.enterpriseintegrationpatterns.com/IdempotentReceiver.html[Idempotent Consumer] from the xref:enterprise-integration-patterns.adoc[EIP
patterns] is used to filter out duplicate messages.
The Idempotent Consumer essentially acts like a
@@ -59,4 +58,4 @@ xref:ROOT:sql-component.adoc[JdbcOrphanLockAwareIdempotentRepository]
== Example
-For example see the above implementations for more details.
+For example, see the above implementations for more details.
(camel) 04/09: CAMEL-20459: documentation fixes for the guaranteed delivery EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit f4cf029a83f1c3aeb8e36dfb5b4af2260f5079b7
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 09:00:29 2024 +0100
CAMEL-20459: documentation fixes for the guaranteed delivery EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/guaranteed-delivery.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/guaranteed-delivery.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/guaranteed-delivery.adoc
index d1ad9983c0e..1e64dd41fbd 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/guaranteed-delivery.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/guaranteed-delivery.adoc
@@ -8,12 +8,12 @@ patterns] using among others the following components:
* xref:ROOT:file-component.adoc[File] for using file systems as a persistent store of
messages
-* xref:ROOT:jms-component.adoc[JMS] when using persistent delivery (the default) for
+* xref:ROOT:jms-component.adoc[JMS] when using persistent delivery, the default, for
working with JMS queues and topics for high performance, clustering and load balancing
* xref:ROOT:kafka-component.adoc[Kafka] when using persistent delivery for
working with streaming events for high performance, clustering and load balancing
* xref:ROOT:jpa-component.adoc[JPA] for using a database as a persistence layer, or use
-any of the other database component such as xref:ROOT:sql-component.adoc[SQL],
+any of the other database components such as xref:ROOT:sql-component.adoc[SQL],
xref:ROOT:jdbc-component.adoc[JDBC], or xref:ROOT:mybatis-component.adoc[MyBatis]
image::eip/GuaranteedMessagingSolution.gif[image]
(camel) 06/09: CAMEL-20459: documentation fixes for the intercept EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 2aecdb7148414acfeda93d0c3a30d6cfa5698d22
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 09:20:49 2024 +0100
CAMEL-20459: documentation fixes for the intercept EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../main/docs/modules/eips/pages/intercept.adoc | 187 +++++++++++++++------
1 file changed, 139 insertions(+), 48 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/intercept.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/intercept.adoc
index e412b14351a..b63b491813b 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/intercept.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/intercept.adoc
@@ -7,9 +7,9 @@ xref:manual::exchange.adoc[Exchange]'s' while they are being routed.
Camel supports three kinds of interceptors:
-* `intercept` that intercepts every processing step as they happen during routing
-* `interceptFrom` that intercepts only the incoming step (i.e. xref:from-eip.adoc[from])
-* `interceptSendToEndpoint` that intercepts only when an
+* <<Intercept-Intercept, `intercept`>> that intercepts every processing step as they happen during routing
+* <<Intercept-InterceptFrom, `interceptFrom`>> that intercepts only the incoming step (i.e., xref:from-eip.adoc[from])
+* <<Intercept-InterceptSendToEndpoint, `interceptSendToEndpoint`>> that intercepts only when an
xref:manual::exchange.adoc[Exchange] is about to be sent to the given xref:message-endpoint.adoc[endpoint].
The `interceptSendToEndpoint` is dynamic hence it will also trigger if a
@@ -29,7 +29,13 @@ xref:manual::route-configuration.adoc[Route Configuration].
This means multiple interceptors can be _triggered_.
Most of the examples in this page are on global scope.
-To use route scope, then it is similar, but it is done on the route as shown in the following example.
+To use route scope, then it is similar, but it is done on the route as shown in the following example:
+
+[tabs]
+====
+
+Java::
++
[source,java]
-------------------------------------------------------------------------
@@ -39,8 +45,8 @@ from("jms:queue:order")
.to("bean:processOrder");
-------------------------------------------------------------------------
-And in XML:
-
+XML::
++
[source,xml]
----
<route>
@@ -53,6 +59,8 @@ And in XML:
</route>
----
+====
+
=== Common features of the interceptors
All these interceptors support the following features:
@@ -61,19 +69,26 @@ All these interceptors support the following features:
* `stop` forces stopping continue routing the Exchange and mark it as completed successful (it's actually the xref:stop-eip.adoc[Stop] EIP).
* `skip` when used with `interceptSendToEndpoint` will *skip* sending the message to the original intended endpoint.
* `afterUri` when used with `interceptSendToEndpoint` allows to send
-the message to an xref:message-endpoint.adoc[endpoint] afterwards.
+the message to an xref:message-endpoint.adoc[endpoint] afterward.
* `interceptFrom` and `interceptSendToEndpoint` support endpoint
URI pattern matching by exact uri, wildcard and regular expression. See further below for more details.
* The intercepted endpoint uri is stored as exchange property with the key
`Exchange.INTERCEPTED_ENDPOINT`.
-=== Using intercept
+[[Intercept-Intercept]]
+== Using `intercept`
The `Intercept` is intercepting the xref:manual::exchange.adoc[Exchange]
-on every processing steps during routing.
+on every processing step during routing.
Given the following example:
+[tabs]
+====
+
+Java::
++
+
[source,java]
-------------------------------------------------------------------------
// global interceptor for all routes
@@ -84,17 +99,8 @@ from("jms:queue:order")
.to("bean:processOrder");
-------------------------------------------------------------------------
-What happens is that the `Exchange` is intercepted
-before each processing step, that means that it will be intercepted
-before
-
-* `.to("bean:validateOrder")`
-* `.to("bean:processOrder")`
-
-So in this example we intercept the `Exchange` twice.
-
-The example is as follows in XML:
-
+XML::
++
[source,xml]
----
<camelContext>
@@ -112,14 +118,30 @@ The example is as follows in XML:
</camelContext>
----
+====
+
+What happens is that the `Exchange` is intercepted
+before each processing step, that means that it will be intercepted
+before
+
+* `.to("bean:validateOrder")`
+* `.to("bean:processOrder")`
+
+So in this example we intercept the `Exchange` twice.
=== Controlling when to intercept using a predicate
If you only want to intercept "sometimes", then you can use a xref:manual::predicate.adoc[predicate].
-For instance in the sample below we only intercept if the message body
+For instance, in the sample below, we only intercept if the message body
contains the string word Hello:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
intercept().when(body().contains("Hello")).to("mock:intercepted");
@@ -129,7 +151,8 @@ from("jms:queue:order")
.to("bean:processOrder");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -151,11 +174,19 @@ And in XML:
</camelContext>
----
+====
+
=== Stop routing after being intercepted
-It is also possible to stop continue routing after being intercepted.
+It is also possible to stop routing after being intercepted.
Now suppose that if the message body contains the word Hello we want to log and stop, then we can do:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
intercept().when(body().contains("Hello"))
@@ -167,7 +198,8 @@ from("jms:queue:order")
.to("bean:processOrder");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -190,19 +222,28 @@ And in XML:
</camelContext>
----
-== Using intercept from
+====
+
+[[Intercept-InterceptFrom]]
+== Using `interceptFrom`
The `interceptFrom` is for intercepting any incoming
-Exchange, in any route (it intercepts all the xref:from-eip.adoc[from] EIPs)
+Exchange, in any route (it intercepts all the xref:from-eip.adoc[`from`] EIPs)
This allows you to do some custom behavior for received Exchanges.
You can provide a specific uri for a given Endpoint then it only
applies for that particular route.
-So lets start with the logging example. We want to log all the
-incoming messages, so we use `interceptFrom` to route to the
+So let's start with the logging example.
+We want to log all the incoming messages, so we use `interceptFrom` to route to the
xref:ROOT:log-component.adoc[Log] component.
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
interceptFrom()
@@ -213,7 +254,8 @@ from("jms:queue:order")
.to("bean:processOrder");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -232,9 +274,17 @@ And in XML:
</camelContext>
----
+====
+
If you want to only apply a specific endpoint, such as all jms endpoints,
you can do:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
interceptFrom("jms*")
@@ -248,12 +298,8 @@ from("file:inbox")
.to("ftp:someserver/backup")
----
-In this example then only messages from the JMS route are intercepted, because
-we specified a pattern in the `interceptFrom` as `jms*` (uses a wildcard).
-
-The pattern syntax is documented in more details later.
-
-And in XML:
+XML::
++
[source,xml]
----
@@ -276,14 +322,22 @@ And in XML:
</camelContext>
----
-== Using intercept when sending to an endpoint
+====
-You can also intercept when Camel is sending a message to an xref:message-endpoint.adoc[endpoint].
+In this example then only messages from the JMS route are intercepted, because
+we specified a pattern in the `interceptFrom` as `jms*` (uses a wildcard).
+
+The pattern syntax is documented in more details later.
+
+[[Intercept-InterceptSendToEndpoint]]
+== Using `interceptSendToEndpoint`
+
+You can also intercept when Apache Camel is sending a message to an xref:message-endpoint.adoc[endpoint].
This can be used to do some custom processing before the
message is sent to the intended destination.
-The interceptor can also be configured to not send to the destination (skip)
+The interceptor can also be configured to not send to the destination (`skip`)
which means the message is detoured instead.
A xref:manual::predicate.adoc[Predicate] can also be used
@@ -291,11 +345,17 @@ to control when to intercept, which has been previously covered.
The `afterUri` option, is used when you need to process
the response message from the intended destination. This functionality
-was added later to the interceptor, in a form of sending to yet another xref:message-endpoint.adoc[endpoint].
+was added later to the interceptor, in a way of sending to yet another xref:message-endpoint.adoc[endpoint].
Let's start with a basic example, where we want to intercept when a
message is being sent to xref:ROOT:kafka-component.adoc[kafka]:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
interceptSendToEndpoint("kafka*")
@@ -307,7 +367,8 @@ from("jms:queue:order")
.to("kafka:order");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -327,9 +388,17 @@ And in XML:
</camelContext>
----
+====
+
When you also want to process the message after it has been sent to the intended destination,
then the example is slightly _odd_ because you have to use the `afterUri` as shown:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
interceptSendToEndpoint("kafka*")
@@ -342,7 +411,8 @@ from("jms:queue:order")
.to("kafka:order");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -362,13 +432,21 @@ And in XML:
</camelContext>
----
+====
+
=== Skip sending to original endpoint
Sometimes you want to *intercept and skip* sending messages to a specific endpoint.
-For example to avoid sending any message to kafka, but detour them to a
+For example, to avoid sending any message to kafka, but detour them to a
xref:ROOT:mock-component.adoc[mock] endpoint, it can be done as follows:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
interceptSendToEndpoint("kafka*").skipSendToOriginalEndpoint()
@@ -380,7 +458,8 @@ from("jms:queue:order")
.to("kafka:order");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -400,12 +479,20 @@ And in XML:
</camelContext>
----
+====
+
=== Conditional skipping sending to endpoint
You can combine both a xref:manual::predicate.adoc[predicate] and skip sending to the original endpoint.
-For example suppose you have some "test" messages that sometimes occur, and that you
+For example, suppose you have some "test" messages that sometimes occur, and that you
want to avoid sending these messages to a downstream kafka system, then this can be done as shown:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
interceptSendToEndpoint("kafka*").skipSendToOriginalEndpoint()
@@ -418,7 +505,8 @@ from("jms:queue:order")
.to("kafka:order");
----
-And in XML:
+XML::
++
[source,xml]
----
@@ -439,6 +527,8 @@ And in XML:
</camelContext>
----
+====
+
== Intercepting endpoints using pattern matching
The `interceptFrom` and `interceptSendToEndpoint` support endpoint pattern
@@ -452,7 +542,7 @@ matching by the following rules in the given order:
This matches only a specific endpoint with exactly the same URI.
-For example to intercept messages being sent to a specific JMS queue you can do:
+For example, to intercept messages being sent to a specific JMS queue, you can do:
[source,java]
-------------------------------------
@@ -462,7 +552,8 @@ interceptSendToEndpoint("jms:queue:cheese").to("log:smelly");
=== Intercepting when matching endpoints by wildcard
Match by wildcard allows you to match a range of endpoints or all of a
-given type. For instance use `file:*` will match all xref:ROOT:file-component.adoc[file] based endpoints.
+given type.
+For instance use `file:*` will match all xref:ROOT:file-component.adoc[file-based] endpoints.
[source,java]
-------------------------------------
@@ -484,7 +575,7 @@ interceptFrom("file:order/inbox/*").to("log:new-file-orders");
Match by regular expression is just like match by wildcard but using
regex instead. So if we want to intercept incoming messages from gold
-and silver JMS queues we can do:
+and silver JMS queues, we can do:
[source,java]
-----------------------------------------------------------
(camel) 07/09: CAMEL-20459: documentation fixes for the kamelet EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 1a2dcb09ae72241e089a19f33e8b742b605ae652
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 09:22:56 2024 +0100
CAMEL-20459: documentation fixes for the kamelet EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../main/docs/modules/eips/pages/kamelet-eip.adoc | 23 +++++++++++++++-------
1 file changed, 16 insertions(+), 7 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc
index 7f3f10c3ecb..69abc78643b 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/kamelet-eip.adoc
@@ -7,18 +7,19 @@
:tabs-sync-option:
Kamelets (Kamel route snippets) allow users to connect to external systems via a simplified interface,
-hiding all the low level details about how those connections are implemented.
+hiding all the low-level details about how those connections are implemented.
[IMPORTANT]
By default, calling kamelets should be done as xref:message-endpoint.adoc[endpoints] with
the xref:components::kamelet-component.adoc[kamelet] component, such as `to("kamelet:mykamelet")`.
-The Kamelet EIP allows calling Kamelets (i.e. xref:manual::route-template.adoc[Route Template]),
+The Kamelet EIP allows calling Kamelets (i.e., xref:manual::route-template.adoc[Route Template]),
**for special use-cases**.
When a Kamelet is designed for a special use-case such as aggregating messages, and returning
-a response message only when a group of aggregated message is completed. In other words the kamelet
-does not return a response message for every incoming message. In special situations like these,
+a response message only when a group of aggregated messages is completed.
+In other words, kamelet does not return a response message for every incoming message.
+In special situations like these,
then you **must** use this Kamelet EIP instead of using the xref:components::kamelet-component.adoc[kamelet] component.
Given the following Kamelet (as a route template):
@@ -61,7 +62,7 @@ from("direct:start")
.to("mock:result");
----
-When calling a Kamelet you may just refer to the name (template id) of the Kamelet in the EIP as shown below:
+When calling a Kamelet, you may refer to the name (template id) of the Kamelet in the EIP as shown below:
== Options
// eip options: START
@@ -76,6 +77,12 @@ include::partial$eip-exchangeProperties.adoc[]
== Using Kamelet EIP
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
from("direct:start")
@@ -83,8 +90,8 @@ from("direct:start")
.to("mock:result");
----
-And in XML
-
+XML::
++
[source,xml]
----
<route>
@@ -94,6 +101,8 @@ And in XML
</route>
----
+====
+
Camel will then, when starting:
* Lookup the xref:manual::route-template.adoc[Route Template] with the given id (in the example above its foo) from the `CamelContext`
(camel) 01/09: CAMEL-20459: documentation fixes for the fault tolerance EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 9651df6fadf621d127a4878de8f3710c7270d569
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 08:55:44 2024 +0100
CAMEL-20459: documentation fixes for the fault tolerance EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../docs/modules/eips/pages/fault-tolerance-eip.adoc | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/fault-tolerance-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/fault-tolerance-eip.adoc
index a08eedc93ef..00d3c7fb40b 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/fault-tolerance-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/fault-tolerance-eip.adoc
@@ -6,12 +6,12 @@ xref:others:microprofile-fault-tolerance.adoc[MicroProfile Fault Tolerance] libr
== Options
-The Fault Tolerance EIP supports 2 options which are listed below:
+The Fault Tolerance EIP supports two options which are listed below:
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
-| *faultToleranceConfiguration* | Configures the Fault Tolerance EIP Use end when configuration is complete, to return back to the Fault Tolerance EIP. | | FaultToleranceConfigurationDefinition
+| *faultToleranceConfiguration* | Configure the Fault Tolerance EIP. When the configuration is complete, use `end()` to return to the Fault Tolerance EIP. | | `FaultToleranceConfigurationDefinition`
| *faultToleranceConfigurationRef* | Refers to a Fault Tolerance configuration to use for configuring the Fault Tolerance EIP. | | String
|===
@@ -57,18 +57,18 @@ XML::
----
====
-In case the calling the downstream HTTP service is failing, and an exception is thrown
+In case the calling the downstream HTTP service is failing, and an exception is thrown,
then the circuit breaker will react and execute the fallback route instead.
If there was no fallback, then the circuit breaker will throw an exception.
-TIP: For more information about fallback see xref:onFallback-eip.adoc[onFallback].
+TIP: For more information about fallback, see xref:onFallback-eip.adoc[onFallback].
=== Configuring Fault Tolerance
You can fine-tune the Fault Tolerance EIP by the many xref:faultToleranceConfiguration-eip.adoc[Fault Tolerance Configuration] options.
-For example to use 2 second execution timeout, you can do as follows:
+For example, to use a 2-second execution timeout, you can do as follows:
[tabs]
====
@@ -78,7 +78,7 @@ Java::
----
from("direct:start")
.circuitBreaker()
- // use 2 second timeout
+ // use a 2-second timeout
.faultToleranceConfiguration().timeoutEnabled(true).timeoutDuration(2000).end()
.log("Fault Tolerance processing start: ${threadName}")
.to("http://fooservice.com/faulty")
@@ -104,7 +104,7 @@ XML::
----
====
-In this example if calling the downstream service does not return a response within 2 seconds,
+In this example, if calling the downstream service does not return a response within 2 seconds,
a timeout is triggered, and the exchange will fail with a TimeoutException.
== Camel's Error Handler and Circuit Breaker EIP
@@ -136,7 +136,7 @@ This example is from a test, where you can see the Circuit Breaker EIP block has
to always fail by throwing an exception. Because the `inheritErrorHandler` has been enabled,
then Camel's error handler will attempt to call the Circuit Breaker EIP block again.
-That means the `mock:a` endpoint will receive the message again, and a total of 1 + 3 = 4 message
+That means the `mock:a` endpoint will receive the message again, and a total of `1 + 3 = 4` message
(first time + 3 redeliveries).
If we turn off the `inheritErrorHandler` option (default) then the Circuit Breaker EIP will only be
@@ -147,7 +147,7 @@ executed once because it handled the error itself.
[NOTE]
====
Camel provides the xref:circuitBreaker-eip.adoc[Circuit Breaker] EIP in the route model,
-which allows to plugin different implementations.
+which allows to plug in different implementations.
MicroProfile Fault Tolerance is one such implementation.
====
(camel) 02/09: CAMEL-20459: documentation fixes for the filter EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 87f3832b9d4b6269bc45bfec654a8b62dd11e91d
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 08:57:56 2024 +0100
CAMEL-20459: documentation fixes for the filter EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/filter-eip.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc
index 043a3bc1d6a..be8f28c735c 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/filter-eip.adoc
@@ -117,7 +117,7 @@ public static class MyBean {
}
----
-And in XML we can call the bean in `<method>` where we can specify the FQN classname
+And in XML we can call the bean in `<method>` where we can specify the FQN class name
of the bean as shown:
[source,xml]
@@ -172,7 +172,7 @@ whether it was `true` or `false`.
When using the Message Filter EIP, then it only applies to its children.
-For example in the previous example:
+For example, in the previous example:
[source,xml]
----
@@ -186,11 +186,11 @@ For example in the previous example:
</route>
----
-Then for a message that is a gold customer will be routed to both mock:gold and mock:all (predicate is true).
+Then for a message that is a gold customer will be routed to both `mock:gold` and `mock:all` (predicate is true).
However, for a non-gold message (predicate is false) then the message will not be routed in the filter block,
but will be routed to mock:all.
-Sometimes you may want to stop continue routing for messages that was filtered.
+Sometimes you may want to stop routing for messages that were filtered.
To do this, you can use the xref:stop-eip.adoc[Stop] EIP as shown:
[source,xml]
(camel) 09/09: CAMEL-20459: documentation fixes for the log EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit d778e5f952c2ee685f211f7c7a634b45d65bfb7a
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 09:27:49 2024 +0100
CAMEL-20459: documentation fixes for the log EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/log-eip.adoc | 83 ++++++++++++++++------
1 file changed, 62 insertions(+), 21 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc
index 60af5d21fa5..31c4fdba159 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/log-eip.adoc
@@ -11,7 +11,7 @@ How can I log the processing of a xref:message.adoc[Message]?
Camel provides many ways to log the fact that you are processing a message. Here are just a few examples:
* You can use the xref:ROOT:log-component.adoc[Log] component which logs the Message content.
-* You can use the xref:manual::tracer.adoc[Tracer] which trace logs message flow.
+* You can use the xref:manual::tracer.adoc[Tracer] that traces logs message flow.
* You can also use a xref:manual::processor.adoc[Processor] or xref:manual::bean-binding.adoc[Bean] and log from Java code.
* You can use this log EIP.
@@ -32,7 +32,7 @@ include::partial$eip-exchangeProperties.adoc[]
This log EIP is much lighter and meant for logging human logs such as `Starting to do ...` etc.
It can only log a message based on the xref:languages:simple-language.adoc[Simple] language.
-The xref:ROOT:log-component.adoc[log] component is meant for logging the message content (body, headers, etc.).
+The xref:ROOT:log-component.adoc[log] component is meant for logging the message content (body, headers, etc).
There are many options on the log component to configure what content to log.
== Example
@@ -41,6 +41,12 @@ You can use the log EIP which allows you to use xref:languages:simple-language.a
For example, you can do
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
from("direct:start")
@@ -48,8 +54,8 @@ from("direct:start")
.to("bean:foo");
----
-And in XML:
-
+XML::
++
[source,xml]
----
<route>
@@ -59,14 +65,16 @@ And in XML:
</route>
----
+====
+
This will be evaluated using the xref:languages:simple-language.adoc[Simple]
-to construct the `String` containg the message to be logged.
+to construct the `String` containing the message to be logged.
=== Logging message body with streaming
-If the message body is stream based, then logging the message body, may cause the message body to be empty afterwards. See this xref:manual:faq:why-is-my-message-body-empty.adoc[FAQ]. For streamed messages you can use Stream caching to allow logging the message body and be able to read the message body afterwards again.
+If the message body is stream based, then logging the message body may cause the message body to be empty afterward. See this xref:manual:faq:why-is-my-message-body-empty.adoc[FAQ]. For streamed messages, you can use Stream caching to allow logging the message body and be able to read the message body afterward again.
-The log DSL have overloaded methods to set the logging level and/or name as well.
+The log DSL has overloaded methods to set the logging level and/or name as well.
[source,java]
----
from("direct:start")
@@ -90,7 +98,7 @@ from("direct:start")
.to("bean:foo");
----
-For example you can use this to log the file name being processed if you consume files.
+For example, you can use this to log the file name being processed if you consume files.
[source,java]
----
from("file://target/files")
@@ -98,7 +106,7 @@ from("file://target/files")
.to("bean:foo");
----
-In XML DSL it is also easy to use log DSL as shown below:
+In XML DSL, it is also easy to use log DSL as shown below:
[source,xml]
----
<route id="foo">
@@ -142,6 +150,12 @@ So for example, if you have not assigned an id to the route, then Camel will use
To use "fooRoute" as the route id, you can do:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
from("direct:start").routeId("fooRoute")
@@ -149,7 +163,7 @@ from("direct:start").routeId("fooRoute")
.to("bean:foo");
----
-And in XML:
+XML::
[source,xml]
----
@@ -160,16 +174,18 @@ And in XML:
</route>
----
+====
+
TIP: If you enable `sourceLocationEnabled=true` on `CamelContext` then Camel will use source file:line as logger name,
instead of the route id. This is for example what `camel-jbang` do, to make it easy to see where in the source code the log is located.
==== Using custom logger from the Registry
If the Log EIP has not been configured with a specific logger to use,
-then Camel will will lookup in the xref:manual::registry.adoc[Registry]
+then Camel will look up in the xref:manual::registry.adoc[Registry]
if there is a single instance of `org.slf4j.Logger`.
-If such an instance exists then this logger is used,
+If such an instance exists, then this logger is used
if not the behavior defaults to creating a new instance of logger.
=== Configuring logging name globally
@@ -177,14 +193,20 @@ if not the behavior defaults to creating a new instance of logger.
You can configure a global log name that is used instead of the route id,
by setting the global option on the `CamelContext`.
-In Java you can do:
+In Java, you can do:
+
+[tabs]
+====
+
+Java::
++
[source,java]
----
camelContext.getGlobalOptions().put(Exchange.LOG_EIP_NAME, "com.foo.myapp");
----
-And in XML:
+XML::
[source,xml]
----
@@ -195,28 +217,45 @@ And in XML:
</camelContext>
----
+====
+
== Masking sensitive information like password
You can enable security masking for logging by setting `logMask` flag to `true`.
-Note that this option also affects xref:ROOT:log-component.adoc[Log] component.
+Note that this option also affects the xref:ROOT:log-component.adoc[Log] component.
To enable mask in Java DSL at CamelContext level:
+[tabs]
+====
+
+Java::
++
+
[source,java]
----
camelContext.setLogMask(true);
----
-And in XML you set the option on `<camelContext>`:
+XML::
++
+.And in XML you set the option on `<camelContext>`:
[source,xml]
----
<camelContext logMask="true">
</camelContext>
----
+====
-You can also turn it on|off at route level. To enable mask in Java DSL at route level:
+You can also turn it on|off at route level. To enable mask in at route level:
+
+[tabs]
+====
+
+Java::
++
[source,java]
----
@@ -225,8 +264,8 @@ from("direct:start").logMask()
.to("bean:foo");
----
-And in XML:
-
+XML::
++
[source,xml]
----
<route logMask="true">
@@ -234,15 +273,17 @@ And in XML:
</route>
----
+====
+
=== Using custom masking formatter
`org.apache.camel.support.processor.DefaultMaskingFormatter` is used for the masking by default.
If you want to use a custom masking formatter, put it into registry with the name `CamelCustomLogMask`.
Note that the masking formatter must implement `org.apache.camel.spi.MaskingFormatter`.
-The know set of keywords to mask is gathered from all the different component options, that are marked as secret.
+The know set of keywords to mask is gathered from all the different component options that are marked as secret.
The list is generated into the source code in `org.apache.camel.util.SensitiveUtils`.
-At this time of writing there is more than 65 different keywords.
+At this time of writing, there are more than 65 different keywords.
Custom keywords can be added as shown:
(camel) 08/09: CAMEL-20459: documentation fixes for the load-balance EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 452e96068aad8b24f08eca5c42f692904fedd3e2
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 09:23:50 2024 +0100
CAMEL-20459: documentation fixes for the load-balance EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
.../src/main/docs/modules/eips/pages/loadBalance-eip.adoc | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc
index f7603a22313..5db9d289db1 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/loadBalance-eip.adoc
@@ -16,10 +16,10 @@ Camel provides the following policies out-of-the-box:
|=======================================================================
| Policy | Description
| xref:customLoadBalancer-eip.adoc[Custom Load Balancer] | To use a custom load balancer implementation.
-| xref:failover-eip.adoc[Failover Load Balancer] | In case of failures the exchange will be tried on the next endpoint.
-| xref:roundRobin-eip.adoc[Round Robin Load Balancer] | The destination endpoints are selected in a round-robin fashion. This is a well known and classic policy, which spreads the load evenly.
-| xref:random-eip.adoc[Random Load Balancer] | The destination endpoints are selected by random.
+| xref:failover-eip.adoc[Fail-over Load Balancer] | In case of failures, the exchange will be tried on the next endpoint.
+| xref:roundRobin-eip.adoc[Round Robin Load Balancer] | The destination endpoints are selected in a round-robin fashion. This is a well-known and classic policy, which spreads the load evenly.
+| xref:random-eip.adoc[Random Load Balancer] | The destination endpoints are selected randomly.
| xref:sticky-eip.adoc[Sticky Load Balancer] | Sticky load balancing using an xref:manual::expression.adoc[Expression] to calculate a correlation key to perform the sticky load balancing.
| xref:topic-eip.adoc[Topic Load Balancer] | Topic which sends to all destinations.
-| xref:weighted-eip.adoc[Weighted Loader Balancer] | Uses a weighted load distribution ratio for each server with respect to others.
+| xref:weighted-eip.adoc[Weighted Loader Balancer] | Use a weighted load distribution ratio for each server with respect to others.
|=======================================================================
(camel) 03/09: CAMEL-20459: documentation fixes for the from EIP.
Posted by or...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
orpiske pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 8d166e93c3d426b467931ef3bca135d2e2e90380
Author: Otavio R. Piske <an...@gmail.com>
AuthorDate: Sun Feb 25 08:59:32 2024 +0100
CAMEL-20459: documentation fixes for the from EIP.
Signed-off-by: Otavio R. Piske <an...@gmail.com>
---
core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc b/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc
index 53ac55dea0e..ac6a8709c09 100644
--- a/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc
+++ b/core/camel-core-engine/src/main/docs/modules/eips/pages/from-eip.adoc
@@ -9,7 +9,7 @@
Every Camel xref:manual::routes.adoc[route] starts from an xref:manual::endpoint.adoc[Endpoint]
as the input (source) to the route.
-The From EIP is the input.
+The `from` EIP is the input.
== Options
@@ -25,7 +25,7 @@ include::partial$eip-exchangeProperties.adoc[]
== Example
-In the route below the route starts from
+In the route below, the route starts from
a xref:ROOT:file-component.adoc[File] endpoint.
[tabs]