Skip to main content

AWS CloudWatch

Oodle supports visualizing Amazon CloudWatch metrics through two integration methods:

  1. CloudWatch API Integration - Make API calls to CloudWatch to get metrics.
  2. Metric Streaming - Stream metrics to Oodle with near-real-time latency using CloudWatch Metric Streams

CloudWatch API Integration​

The CloudWatch API integration retrieves metrics from AWS services using API calls to CloudWatch.

Set up CloudWatch API Integration​

Please follow the steps below to set up CloudWatch integration:

  1. Go to the gear icon on the Oodle UI and click Connect on the CloudWatch Dashboard tile.

  2. Please follow the instructions in the pop-up to create a cross-account IAM role in your AWS account that Oodle will assume to read CloudWatch metrics.

  3. Click on Add Data Source to add the CloudWatch data source.

  4. Fill in the required fields:

    • Role ARN: The ARN of the IAM role created in the first step.
    • External ID: The external ID used when creating the IAM role.
    • Region: The region of your AWS account.

  5. Click on Save & test to add the data source.

Visualize CloudWatch metrics from API Integration​

After setting up the data source, you can visualize your CloudWatch metrics in Oodle. Go to Explore Metrics and choose your newly added CloudWatch data source. You should now be able to query and visualize your metrics.

Metrics Streaming Integration​

CloudWatch Metric Streams allows you to continually stream CloudWatch metrics to Oodle, with near-real-time delivery and low latency (3-5 minutes). This streaming integration is powered by Amazon CloudWatch Metric Streams and Amazon Kinesis Data Firehose.

Set up Metrics Streaming​

  1. We'll set up CloudWatch streaming and Amazon Kinesis Firehose using a CloudFormation template. Download the template from this link

  2. Each AWS service has its own namespace and set of metrics. Here are some common AWS services and their namespaces:

    • AWS/EC2: EC2 instance metrics like CPUUtilization, NetworkIn/Out, DiskReadOps/WriteOps
    • AWS/RDS: Database metrics including DatabaseConnections, ReadIOPS, WriteIOPS, CPUUtilization
    • AWS/ECS: Container metrics like CPUUtilization, MemoryUtilization, NetworkRxBytes/TxBytes
    • AWS/DynamoDB: Database metrics including ConsumedReadCapacityUnits, ConsumedWriteCapacityUnits
    • AWS/ApplicationELB: Load balancer metrics including RequestCount, TargetResponseTime, HTTPCode_Target_2XX_Count

    You can identify the namespaces you want to monitor using one of these methods:

    a. List all namespaces in your AWS account using the AWS CLI:

    aws cloudwatch list-metrics --output json | jq -r '.Metrics[].Namespace' | sort -u

    b. View specific namespaces by opening your All Metrics page in CloudWatch to see a list of all available namespaces for the services you are using

    Choose the namespaces based on the AWS services you want to monitor. The corresponding metrics for those namespaces will be streamed to Oodle.

    For more details on available metrics for each service, see Viewing available metrics in the AWS CloudWatch documentation.

  3. Once you have identified the namespaces, modify the template downloaded in step 1 to specify which CloudWatch namespaces you want to monitor by adding them to the MetricsStream.Properties.IncludeFilters array. Example:

MetricStream:
    Type: AWS::CloudWatch::MetricStream
    Properties:
      .
      .
      .
      IncludeFilters:
        - Namespace: AWS/GlobalAccelerator
        - Namespace: AWS/NetworkELB
        - Namespace: AWS/ECS
        - Namespace: AWS/DynamoDB
        - Namespace: ECS/ContainerInsights
        - Namespace: AWS/ElastiCache
        - Namespace: AWS/ES

This example will stream metrics from Global Accelerator, Network Load Balancer, Amazon ECS, DynamoDB, ECS Container Insights, ElastiCache, and Elasticsearch Service to Oodle.

  1. To run the template, you will need two parameters:

    • OodleHttpEndpoint - The URL to send metrics to
    • OodleApiKey - The API key for authentication

    Navigate to the integrations page in your Oodle account and click the "View API Key" button in the top right to find the instance name and API key. You can use the following URL for OodleHttpEndpoint: https://{OODLE_INSTANCE}.collector.oodle.ai/v1/aws/${OODLE_INSTANCE}/metrics

  2. Deploy the CloudFormation template in your AWS account using the AWS Console, AWS CLI, or AWS SDK. Use the parameters from the previous step. For detailed instructions on creating a CloudFormation stack using the AWS Console, see Creating a stack on the AWS CloudFormation console.

Note: To add additional namespaces for monitoring later, you can modify the template directly through the AWS Console using Infrastructure Composer. For detailed instructions, see Working with AWS CloudFormation Templates.

Visualize CloudWatch Metrics from Metric Streaming​

After setting up metric streaming, you can visualize your CloudWatch metrics in Oodle:

  1. Go to Explore Metrics
  2. Choose Oodle data source
  3. Query and visualize your metrics

CloudWatch metrics are translated to Oodle metric names following this template: amazonaws_com_{namespace}_{metricName}_{aggregation} Note: Forward slashes (/) in the namespace are converted to underscores (_)

For example, the CloudWatch metric:

  • Namespace: AWS/ECS (becomes AWS_ECS)
  • Metric Name: CPUUtilization

Gets translated to these Oodle metrics:

  • amazonaws_com_AWS_ECS_CPUUtilization_sum - Sum aggregation
  • amazonaws_com_AWS_ECS_CPUUtilization_count - Count aggregation
  • amazonaws_com_AWS_ECS_CPUUtilization_quantile{quantile="0"} - Minimum value
  • amazonaws_com_AWS_ECS_CPUUtilization_quantile{quantile="1"} - Maximum value

Billing Considerations for Metric Streaming​

While Oodle does not charge extra for metric streaming, AWS pricing is based on metric updates and associated services. Each metric update includes four default statistics (Minimum, Maximum, Sample Count, and Sum). You will also incur Amazon Kinesis Data Firehose charges for data ingestion. For detailed pricing information, please refer to the "Metric streams" section under the Metrics tab on the CloudWatch pricing page.

Alerting on CloudWatch Metrics​

Oodle supports alerting on AWS CloudWatch metrics only when using the metric stream integration method.

To set up alerts on your CloudWatch metrics:

  1. Ensure you have configured the metric stream integration as described above
  2. Navigate to the Alerts section in Oodle
  3. Create a new alert using your streamed CloudWatch metrics

The alert will use the translated metric names described in the previous section. For example, to alert on average ECS CPU utilization, you would use the query amazonaws_com_AWS_ECS_CPUUtilization_sum/amazonaws_com_AWS_ECS_CPUUtilization_count .

Support​

If you have any questions or need assistance, please contact us via our help chat app located at the bottom-right of the page or by reaching out to support@oodle.ai.