Skip to main content

Configure AWS CloudWatch

This guide will help you set up AWS CloudWatch integration with Unmeshed to monitor your processes and workflows.

Prerequisites​

Before configuring AWS CloudWatch, ensure you have:

  • Create AWS IAM User

Create AWS IAM User​

  1. Login to AWS Console and navigate to IAM service
  2. Create a new IAM user with programmatic access
  3. Attach the following policy to the user:
    • CloudWatchAgentServerPolicy - Required for sending metrics to AWS CloudWatch

Add CloudWatch Integration​

  1. Navigate to the Unmeshed Dashboard
  2. Go to Integrations in the left sidebar
  3. Filter by "Monitoring" category
  4. Find "Amazon CloudWatch" in the integrations list
  5. Click "Add +" to enable the CloudWatch integration

CloudWatch Integration Interface

The integration page showing the "Add +" button to enable publishing metrics from Unmeshed to AWS CloudWatch.

Configure CloudWatch Integration​

After clicking "Add +", you'll be taken to the CloudWatch integration configuration screen. Here's what you need to configure:

Basic Configuration​

  1. Name: Enter a suitable name for your integration

    • Use underscores (_) or hyphens (-) and avoid spaces
    • Example: my-cloudwatch-integration

  2. Enabled: Check this box to activate the integration

note

Enabling/disabling takes up to 30 minutes to take effect

AWS Configuration​

  1. Metric Namespace: Enter the CloudWatch namespace where your metrics will be stored

    • Example: MyApp/Metrics or Unmeshed/Processes
    • This namespace will appear in AWS CloudWatch

  2. Access Key: Enter the AWS access key for the IAM user with CloudWatchAgentServerPolicy

  3. Secret Key: Enter the AWS secret key for the IAM user

  4. Region: Select the AWS region where you want to publish metrics

    • Choose the region closest to your application or where your CloudWatch is configured

Process Configuration​

Configure how process-level metrics are collected and sent to CloudWatch:

  1. Process Metric Name: Enter a descriptive name for your process metrics

    • This name will be used in CloudWatch to identify your process metrics
    • Example: unmeshed_process_executions

  2. Process Dimensions: Select dimensions to categorize your metrics

    • Available dimensions: namespace, name, type, processId, id, status, requestId, correlationId
warning

Avoid high cardinality dimensions such as id, processId, requestId, and correlationId as they can cause performance issues and increased costs in CloudWatch

note

id and processId represent the same value

  1. Process Statuses Filter: Choose which process statuses to include

    • Available statuses: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, CANCELLED
    • Use "Select All" to include all statuses
    • For detailed information about process statuses, see Process Status

  2. Process Names Filter: Choose which processes to monitor

    • Use "Select All" to monitor all processes
    • Or select specific process names to filter

Step Configuration​

Configure how step-level metrics are collected and sent to CloudWatch:

  1. Step Metric Name: Enter a descriptive name for your step metrics

    • This name will be used in CloudWatch to identify your step metrics
    • Example: unmeshed_step_executions

  2. Step Dimensions: Select dimensions to categorize your step metrics

    • Available dimensions: namespace, name, stepRef, type, id, status
warning

Avoid high cardinality dimensions such as id as they can cause performance issues and increased costs in CloudWatch

  1. Step Names Filter: Choose which step names to include

    • Use "Select All" to include all steps
    • Or select specific step names to filter

  2. Step Refs Filter: Choose which step references to include

    • Use "Select All" to include all step references
    • Or select specific step references to filter

  3. Step Statuses Filter: Choose which step statuses to include

    • Available statuses: PENDING, SCHEDULED, RUNNING, COMPLETED, FAILED, TIMED_OUT, SKIPPED, CANCELLED
    • Use "Select All" to include all step statuses

Save Configuration​

Once you've configured all the settings:

  1. Click "Save" to apply your configuration
  2. Wait up to 30 minutes for the integration to take effect
  3. Verify in AWS CloudWatch that metrics are being published to your specified namespace