AWS 2 CloudWatch
Since Camel 3.1
Only producer is supported
The AWS2 Cloudwatch component allows messages to be sent to an Amazon CloudWatch metrics. The implementation of the Amazon API is provided by the AWS SDK.
Prerequisites
You must have a valid Amazon Web Services developer account, and be signed up to use Amazon CloudWatch. More information is available at Amazon CloudWatch.
|
The AWS2 CW component is not supported in OSGI |
URI Format
aws2-cw://namespace[?options]The metrics will be created if they don’t already exists.
You can append query options to the URI in the following format,
?options=value&option2=value&…
URI Options
The AWS 2 CloudWatch component supports 16 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
amazonCwClient (producer) |
To use the AmazonCloudWatch as the client |
CloudWatchClient |
|
autoDiscoverClient (common) |
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. |
true |
boolean |
configuration (producer) |
The component configuration |
Cw2Configuration |
|
lazyStartProducer (producer) |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
name (producer) |
The metric name |
String |
|
proxyHost (producer) |
To define a proxy host when instantiating the CW client |
String |
|
proxyPort (producer) |
To define a proxy port when instantiating the CW client |
Integer |
|
proxyProtocol (producer) |
To define a proxy protocol when instantiating the CW client. There are 2 enums and the value can be one of: HTTP, HTTPS |
HTTPS |
Protocol |
region (producer) |
The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id() |
String |
|
timestamp (producer) |
The metric timestamp |
Instant |
|
trustAllCertificates (producer) |
If we want to trust all certificates in case of overriding the endpoint |
false |
boolean |
unit (producer) |
The metric unit |
String |
|
value (producer) |
The metric value |
Double |
|
basicPropertyBinding (advanced) |
Deprecated Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
accessKey (security) |
Amazon AWS Access Key |
String |
|
secretKey (security) |
Amazon AWS Secret Key |
String |
The AWS 2 CloudWatch endpoint is configured using URI syntax:
aws2-cw:namespace
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
namespace |
Required The metric namespace |
String |
Query Parameters (16 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
amazonCwClient (producer) |
To use the AmazonCloudWatch as the client |
CloudWatchClient |
|
autoDiscoverClient (common) |
Setting the autoDiscoverClient mechanism, if true, the component will look for a client instance in the registry automatically otherwise it will skip that checking. |
true |
boolean |
lazyStartProducer (producer) |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
boolean |
name (producer) |
The metric name |
String |
|
proxyHost (producer) |
To define a proxy host when instantiating the CW client |
String |
|
proxyPort (producer) |
To define a proxy port when instantiating the CW client |
Integer |
|
proxyProtocol (producer) |
To define a proxy protocol when instantiating the CW client. There are 2 enums and the value can be one of: HTTP, HTTPS |
HTTPS |
Protocol |
region (producer) |
The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id() |
String |
|
timestamp (producer) |
The metric timestamp |
Instant |
|
trustAllCertificates (producer) |
If we want to trust all certificates in case of overriding the endpoint |
false |
boolean |
unit (producer) |
The metric unit |
String |
|
value (producer) |
The metric value |
Double |
|
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
accessKey (security) |
Amazon AWS Access Key |
String |
|
secretKey (security) |
Amazon AWS Secret Key |
String |
Required CW component options
You have to provide the amazonCwClient in the Registry or your accessKey and secretKey to access the Amazon’s CloudWatch.
Usage
Message headers evaluated by the CW producer
| Header | Type | Description |
|---|---|---|
|
|
The Amazon CW metric name. |
|
|
The Amazon CW metric value. |
|
|
The Amazon CW metric unit. |
|
|
The Amazon CW metric namespace. |
|
|
The Amazon CW metric timestamp. |
|
|
The Amazon CW metric dimension name. |
|
|
The Amazon CW metric dimension value. |
|
|
A map of dimension names and dimension values. |
Advanced CloudWatchClient configuration
If you need more control over the CloudWatchClient instance
configuration you can create your own instance and refer to it from the
URI:
from("direct:start")
.to("aws2-cw://namespace?amazonCwClient=#client");The #client refers to a CloudWatchClient in the
Registry.
Automatic detection of CloudWatchClient client in registry
The component is capable of detecting the presence of an CloudWatchClient bean into the registry. If it’s the only instance of that type it will be used as client and you won’t have to define it as uri parameter. This may be really useful for smarter configuration of the endpoint.
Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws2-cw</artifactId>
<version>${camel-version}</version>
</dependency>where ${camel-version} must be replaced by the actual version of Camel.
Spring Boot Auto-Configuration
When using aws2-cw with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-aws2-cw-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 16 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.aws2-cw.access-key |
Amazon AWS Access Key |
String |
|
camel.component.aws2-cw.amazon-cw-client |
To use the AmazonCloudWatch as the client. The option is a software.amazon.awssdk.services.cloudwatch.CloudWatchClient type. |
CloudWatchClient |
|
camel.component.aws2-cw.autowired-enabled |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
camel.component.aws2-cw.configuration |
The component configuration. The option is a org.apache.camel.component.aws2.cw.Cw2Configuration type. |
Cw2Configuration |
|
camel.component.aws2-cw.enabled |
Whether to enable auto configuration of the aws2-cw component. This is enabled by default. |
Boolean |
|
camel.component.aws2-cw.lazy-start-producer |
Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
false |
Boolean |
camel.component.aws2-cw.name |
The metric name |
String |
|
camel.component.aws2-cw.proxy-host |
To define a proxy host when instantiating the CW client |
String |
|
camel.component.aws2-cw.proxy-port |
To define a proxy port when instantiating the CW client |
Integer |
|
camel.component.aws2-cw.proxy-protocol |
To define a proxy protocol when instantiating the CW client |
Protocol |
|
camel.component.aws2-cw.region |
The region in which EKS client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You’ll need to use the name Region.EU_WEST_1.id() |
String |
|
camel.component.aws2-cw.secret-key |
Amazon AWS Secret Key |
String |
|
camel.component.aws2-cw.timestamp |
The metric timestamp. The option is a java.time.Instant type. |
Instant |
|
camel.component.aws2-cw.trust-all-certificates |
If we want to trust all certificates in case of overriding the endpoint |
false |
Boolean |
camel.component.aws2-cw.unit |
The metric unit |
String |
|
camel.component.aws2-cw.value |
The metric value |
Double |