Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

CW Component

*Available as of Camel 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.

Info
titlePrerequisites

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

Code Block

aws-cw://namespace[?options]

The metrics will be created if they don't already exists.
You can append query options Query options can be appended to the URI in using the following format, : ?options=value&option2=value&...

URI Options

Name

Default Value

Context

Description

amazonCwClient

null

Producer

Reference to a com.amazonaws.services.cloudwatch.AmazonCloudWatch in the Registry.

accessKey

null

Producer

Amazon AWS Access Key.

secretKey

null

Producer

Amazon AWS Secret Key.

name

null

Producer

The metric name which is used if the message header 'header CamelAwsCwMetricName' is not present.

value

1.0

Producer

The metric value which is used if the message header 'header CamelAwsCwMetricValue' is not present.

unit

Count

Producer

The metric unit which is used if the message header 'header CamelAwsCwMetricUnit' is not present.

namespace

null

Producer

The metric namespace which is used if the message header 'header CamelAwsCwMetricNamespace' is not present.

timestamp

null

Producer

The metric timestamp which is used if the message header 'header CamelAwsCwMetricTimestamp' is not present.

amazonCwEndpoint

null

Producer

The region with which the AWS-CW client wants to work with.

proxyHost

null

Producer

Camel 2.16: Specify a proxy host to be used inside the client definition.

proxyPort

null

Producer

Camel 2.16: Specify a proxy port to be used inside the client definition.

Info
titleRequired CW component options

You have to provide the the amazonCwClient in the Registry or your your accessKey and and secretKey to access the Amazon's CloudWatch.

...

If you need more control over the AmazonCloudWatch instance configuration you can create your own instance and refer to it from the URI:

Code Block

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:

Code Block

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);

...

Maven users will need to add the following dependency to their pom.xml.

Code Block
xml
xml
titlepom.xmlxml

<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).

Include Page
Endpoint See Also
Endpoint See Also