AWS CloudWatch Metrics Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Send messages to AWS CloudWatch metrics.

Access Key/Secret Key are the basic method for authenticating to the AWS CloudWatch Service. These parameters are optional, because the Kamelet provide also the 'useDefaultCredentialsProvider'.

When using a default Credentials Provider the CloudWatch client will load the credentials through this provider and won’t use the static credential. This is reason for not having the access key and secret key as mandatory parameter for this Kamelet.

The Kamelet expects the following headers to be set:

There are several properties you can set in the headers, such as:

metric-name / ce-metricname for the metric name. metric-value / ce-metricvalue for the metric value. metric-unit / ce-metricunit for the metric unit. metric-timestamp / ce-metrictimestamp for the metric timestamp. metric-dimension-name / ce-metricdimensionname for the dimension name. metric-dimension-value / ce-metricdimensionvalue for the dimension value.

Configuration Options

The following table summarizes the configuration options available for the aws-cloudwatch-sink Kamelet:

Property	Name	Description	Type	Default	Example
cwNamespace	Cloud Watch Namespace	Required The cloud watch metric namespace.	string
region	AWS Region	Required The AWS region to connect to.	string		eu-west-1
accessKey	Access Key	The access key obtained from AWS.	string
overrideEndpoint	Endpoint Overwrite	Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting.	boolean	false
secretKey	Secret Key	The secret key obtained from AWS.	string
uriEndpointOverride	Overwrite Endpoint URI	Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option.	string
useDefaultCredentialsProvider	Default Credentials Provider	Set whether the CloudWatch client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.	boolean	false

Property

Name

Description

Type

Default

Example

cwNamespace

Cloud Watch Namespace

Required The cloud watch metric namespace.

string

region

AWS Region

Required The AWS region to connect to.

string

eu-west-1

accessKey

Access Key

The access key obtained from AWS.

string

overrideEndpoint

Endpoint Overwrite

Set the need for overiding the endpoint URI. This option needs to be used in combination with uriEndpointOverride setting.

boolean

false

secretKey

Secret Key

The secret key obtained from AWS.

string

uriEndpointOverride

Overwrite Endpoint URI

Set the overriding endpoint URI. This option needs to be used in combination with overrideEndpoint option.

string

useDefaultCredentialsProvider

Default Credentials Provider

Set whether the CloudWatch client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in.

boolean

false

Dependencies

At runtime, the aws-cloudwatch-sink Kamelet relies upon the presence of the following dependencies:

camel:core
camel:aws2-cw
camel:kamelet

Usage

This section describes how you can use the aws-cloudwatch-sink.

Knative sink

You can use the aws-cloudwatch-sink Kamelet as a Knative sink by binding it to a Knative object.

aws-cloudwatch-sink-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-cloudwatch-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-cloudwatch-sink
    properties:
      cwNamespace: The Cloud Watch Namespace
      region: eu-west-1

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the aws-cloudwatch-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

Run the sink by using the following command:

kubectl apply -f aws-cloudwatch-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind aws-cloudwatch-sink -p "sink.cwNamespace=The Cloud Watch Namespace" -p "sink.region=eu-west-1" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

You can use the aws-cloudwatch-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

aws-cloudwatch-sink-binding.yaml

apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: aws-cloudwatch-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: aws-cloudwatch-sink
    properties:
      cwNamespace: The Cloud Watch Namespace
      region: eu-west-1

Prerequisites

You’ve installed Strimzi.
You’ve created a topic named my-topic in the current namespace.
You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the aws-cloudwatch-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

Run the sink by using the following command:

kubectl apply -f aws-cloudwatch-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind aws-cloudwatch-sink -p "sink.cwNamespace=The Cloud Watch Namespace" -p "sink.region=eu-west-1" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/aws-cloudwatch-sink.kamelet.yaml