Amazon CloudWatch Integration Guide
Amazon CloudWatch is an observability tool that helps monitor AWS resources and services. It collects data, gains insights and helps track system changes across your AWS platform. It allows alerts to be set for certain metric thresholds. When metrics fall outside the threshold, alerts are triggerd.
Increase the effectiveness and visbility of these alerts with TaskCall's Amazon CloudWatch integration. Alerts will be received in TaskCall immediately after they trigger on CloudWatch, kicking off our powerful and persistent notification mechanism to bring the correct responders on-board and resolve it with urgency.
Pointers
- The integration is between a TaskCall service and Amazon CloudWatch.
- Incidents will automatically resolve in TaskCall when metrics fall back within the normal threshold.
- Similar alerts will be automatically grouped together into one incident to avoid interrupting responders unnecessarily.
- This integration only receives alerts in TaskCall from Amazon CloudWatch.
In TaskCall
- Go to Configurations > Services. Select the service you want to integrate with.
- Once you are on the Service details page, go to the Integrations tab. Click on New Integration.
- Give the integration a name.
- From the integration types, select the top radio button indicating that you are trying to use a built-in integration.
- From the list of built-in integrations, select Amazon CloudWatch.
- Click Save.
- Copy the Integration Url that is issued for the integration.
In AWS
- First, we have to set up a notification service to send alerts to TaskCall. Type SNS (Simple Notification Services) in the search bar up top. Once you are on the SNS page, go to Topics > Create topic.
- Set the topic type to Standard. Give it a name and a display name. Click Create topic.
- Once the topic is created, from the same page go to Subscriptions > Create subscription.
- For the Topic Arn select the topic you just created; set the protocol as HTTPS; paste the Integration Url you copied over from TaskCall in the Endpoint. Nothing else needs to be added. Click Create subscription.
Once the subscription is created, if the "Status" shows as "Pending confirmation", then refresh the page. It will update the status to "Confirmed". - Now you can add the SNS topic you created above to any CloudWatch Alarm and get notified.
If you have not created a CloudWatch Alarm before then please continue reading to understand how one can be configured to create incidents in TaskCall using the SNS topic you created.
Create a CloudWatch Alarm
- In the AWS console, search and select CloudWatch.
- From the navigation bar on the left, go to Alarms > All Alarms. Then click Create Alarm.
- Select the type of metric you would like to monitor. AWS offers a range of metrics that can be monitored across all component groups – EC2, RDS, S3, Elasticache, VPC, etc.
- Set the conditions and thresholds based on which the alarms will be generated. Set the type of statistic (average, sum, maximum, etc) and the period of statistical consideration for the evaluation. Define the condition type (greater than, equal to, etc) and the threshold value for the evaluation. Once you are done with this step, click Next.
- In the next step you will define the notifications that should be sent out for this CloudWatch alarm. We will define two notifications:
- when the metric is In alarm
- when the metric is Ok
For each notification, set the TaskCall SNS topic you created earlier as the endpoint to send notifications to.
You can additionally set up the metric to trigger when there is insufficient data as well. Click Next to continue. - In the next step, you will give the alarm a name and description. Click Next to continue.
- Finally, preview your configurations and click Create alarm when you are done.
That’s it! Your integration should be ready at this point. Whenever the metric you defined goes beyond the acceptable threshold an incident will be created in TaskCall. When the metric falls back within its normal range, the incident will be automatically resolved in TaskCall as well.
You can refer to the AWS's documentation for creating CloudWatch alarms for more details.