AWS CloudWatch Component
Available as of Camel version 2.11
The CW 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 are available at Amazon CloudWatch.
URI Format
aws-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 CloudWatch component has no options.
The AWS CloudWatch endpoint is configured using URI syntax:
aws-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 (12 parameters):
Name | Description | Default | Type |
---|---|---|---|
accessKey (producer) |
Amazon AWS Access Key |
String |
|
amazonCwClient (producer) |
To use the AmazonCloudWatch as the client |
AmazonCloudWatch |
|
amazonCwEndpoint (producer) |
The endpoint with which the AWS-CW client wants to work with. |
String |
|
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 |
|
region (producer) |
The region in which CW client needs to work |
String |
|
secretKey (producer) |
Amazon AWS Secret Key |
String |
|
timestamp (producer) |
The metric timestamp |
Date |
|
unit (producer) |
The metric unit |
String |
|
value (producer) |
The metric value |
Double |
|
synchronous (advanced) |
Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
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. |
|
|
Camel 2.12: The Amazon CW metric dimension name. |
|
|
Camel 2.12: The Amazon CW metric dimension value. |
|
|
Camel 2.12: A map of dimension names and dimension values. |
Advanced AmazonCloudWatch configuration
If you need more control over the AmazonCloudWatch
instance
configuration you can create your own instance and refer to it from the
URI:
from("direct:start")
.to("aws-cw://namepsace?amazonCwClient=#client");
The #client
refers to a AmazonCloudWatch
in the
Registry.
For example if your Camel Application is running behind a firewall:
AWSCredentials awsCredentials = new BasicAWSCredentials("myAccessKey", "mySecretKey");
ClientConfiguration clientConfiguration = new ClientConfiguration();
clientConfiguration.setProxyHost("http://myProxyHost");
clientConfiguration.setProxyPort(8080);
AmazonCloudWatch client = new AmazonCloudWatchClient(awsCredentials, clientConfiguration);
registry.bind("client", client);
Dependencies
Maven users will need to add the following dependency to their pom.xml.
pom.xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-aws</artifactId>
<version>${camel-version}</version>
</dependency>
where ${camel-version
} must be replaced by the actual version of Camel
(2.10 or higher).