How to resolve Sprinto check for monitoring API gateway error
About
Sprinto Check: AWS API gateway V2 errors should be monitored or AWS API gateway V1 errors should be monitored
AWS API Gateway serves as a crucial component for managing and securing APIs. It is essential to actively monitor API Gateway errors to ensure the reliability and performance of your APIs. Sprinto requires the implementation of CloudWatch alarms to detect and respond to 5XX errors promptly.
Note: At this time, our platform does not support AWS CloudWatch Composite Alarms or Math-Based Alarms.
This means you cannot create alarms that:
Combine multiple alarms using logical conditions (e.g., ALARM1 AND ALARM2)
Use metric math expressions (e.g., calculating averages or deltas across metrics)
Purpose
The purpose of this Sprinto check is to actively monitor and create alerts for API Gateway 5XX errors using CloudWatch alarms. By doing so, you can:
Proactively Detect Errors: Set up alarms to detect any surge in 5XX errors, allowing you to respond promptly.
Improve Incident Management: Receive notifications for potential issues, enabling faster incident response and resolution.
Ensure Reliability: Ensure that your API Gateway operates reliably and delivers a seamless experience for your users.
How to Resolve
To pass the Sprinto check for monitoring API Gateway errors, follow the steps below to create a CloudWatch alarm:
Before you begin
Ensure you have "Admin" access on the AWS account to modify the configuration.
Log in on Sprinto as administrator.
If you have imported instances from API Websocket on Sprinto, create a CloudWatch alarm for metric IntegrationError instead of 5XXError to pass the check. To create a CloudWatch alarm, follow the procedure below.
Procedure
Visit the CloudWatch console and choose ALARM under Alarms.
Choose Create alarm.
Select Select metric and then ApiGateway from the AWS Namespaces section.
Choose the 5XXError metric to continue.
Change Statistic to Sum and enter 5 as the threshold value.
Select Next.
On the next page, Configure actions, select Remove from the Notification section and then select Next. No notification action is created for this example during the lab.
Enter AppConfig-API-5XX-Alarm in the Name field and provide an optional Alarm description.
Select Next and then select Create alarm.
Once these steps are completed, the Sprinto retrieve the changes and set the check status to “Passing.”
If you need any assistance with the Sprinto check, please get in touch with Sprinto support.
Last updated