AWS CloudWatch

Discover more about the AWS CloudWatch connector and how to use it on the Digibee Integration Platform.

AWS CloudWatch allows you to send custom metrics data from the pipeline to the Amazon CloudWatch service. This allows for greater flexibility in monitoring the health of pipelines beyond the predefined metrics provided by the Digibee Integration Platform.

Further information can be found in the CloudWatch API documentation.

Parameters

Take a look at the configuration parameters of the connector. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
AWS CloudWatch Client Account	The account used to connect the pipeline to the CloudWatch PutMetricData API.	N/A	BASIC, AWS-V4
Region	The AWS region in which the CloudWatch client needs to work.	AWS Global	String
Namespace (DB)	The namespace for the metric data. You can use ASCII characters for the namespace, except for control characters, which aren’t supported. To avoid conflicts with AWS service namespaces, you shouldn’t specify a namespace that begins with “AWS/”.	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Advanced tab

Parameter	Description	Default value	Data type
Metric Name (DB)	The name of the metric.	N/A	String
Metric Value (DB)	The value for the metric.	0	Integer
Metric Timestamp (DB)	The time at which the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.	N/A	String
Metric Unit (DB)	Determines which unit you want to use when storing the metric. Allowed values: Seconds	Microseconds	Milliseconds
Metric Dimensions (DB)	A dimension is a key/value pair that is part of the identity of a metric. Since dimensions are part of the unique identifier of a metric, whenever you add a unique key/value pair to one of your metrics, you create a new variant of that metric.	N/A	Key-value pairs

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String

Usage examples

Given the flexibility of the service, the possibilities for custom metrics with Amazon CloudWatch are extensive. Some examples that might be interesting in the context of pipelines are:

• Health metrics for pipelines:

  • Execution time

  • Requests count

  • Size of uploaded files

  • Execution time for specific pipeline sections (bottlenecks)

• Custom business metrics:

  • User-initiated requests versus machine-initiated requests

  • Success rate of API calls

  • Size of orders received

  • Lead conversion rate