Skip to main content
Sumo Logic

View the AWS Observability API Gateway Dashboards

View examples and descriptions for each of the AWS API Gateway App pre-configured dashboards.

This page provides examples and descriptions for each of the AWS Observability API Gateway pre-configured dashboards.

The Amazon API Gateway service allows you to create RESTful APIs and WebSocket APIs for real-time two-way communication applications in containerized and serverless environments, as well as web applications.

The Sumo Logic AWS Observability API Gateway dashboards provide insights into API Gateway tasks while accepting and processing concurrent API calls throughout your infrastructure, including traffic management, CORS support, authorization, and access control, throttling, monitoring, and API version management.

1. AWS API Gateway - Overview

AWS API Gateway - Overview dashboard provides insights into API Gateway performance throughout your infrastructure, including API calls, latency, client and server-side errors, API cache hits, and back-end cache misses.

Use this dashboard to:

  • Get a high-level overview of your API Gateway infrastructure.
  • Compare API requests made today, yesterday, and last week to identify any abnormal deviations in load.
  • Get quick statistics on the number of requests and frequently used APIs.
  • Monitor the number of client-side and server-side errors processed by API Gateway instances.
  • Monitor relative, backend, and overall API responsiveness.
  • Monitor API cache hits and misses by API Gateway across your infrastructure to optimize cache capacities and achieve the desired performance. 

1. AWS API Gateway - Overview.png

2. AWS API Gateway - Audit Events

AWS API Gateway - Audit Events dashboard provides detailed audit insights into API Gateway events by various dimensions including event names, trends, regions, user agents, and recipient account IDs.

Use this dashboard to:

  • Monitor all API Gateway related audit logs available via CloudTrail events.
  • Monitor incoming user activity locations for both successful and failed events to ensure the activity matches expectations.
  • Monitor successful and failed API Gateway events, users, and user agents / fail activities and failure reasons. 
  • Monitor requests coming in from known malicious IP addresses detected via Sumo Logic Threat Intel.

2. AWS API Gateway - Audit Events.png

1. AWS API Gateway - Latency, Cache

AWS API Gateway - Latency, Cache dashboard provides insights into API Gateway performance including API requests, latency, API cache hits, and back-end cache misses.

Use this dashboard to:

  • Monitor the overall responsiveness of API calls (latency), comparing times (in milliseconds) between receiving a request from and returning a response to a client. 
  • Monitor the responsiveness of the backend (integration latency), comparing times (in milliseconds) between API Gateway relay requests to and receiving a response back from the backend.
  • Monitor API cache hits and misses to optimize cache capacities across your infrastructure and achieve the desired performance.
  • Compare API requests made today, yesterday, and last week identify any abnormal deviations.

1. AWS API Gateway - Latency, Cache.png

2. AWS API Gateway - 4xx and 5xx Errors

AWS API Gateway - 4xx and 5xx Errors dashboard provides insights into API Gateway HTTP 4xx and 5xx code errors throughout your infrastructure, including API requests, client-side errors, and server-side errors.

Use this dashboard to:

  • Monitor the total number of client-side errors based on API name and region across your infrastructure.
  • Monitor the total number of server-side errors based on API name and region across your infrastructure.
  • Compare API requests made today, yesterday, and last week to identify any abnormal deviations.

2. AWS API Gateway - 4XX and 5XX Errors.png

3. AWS API Gateway - Enhanced Monitoring

AWS API Gateway - Enhanced Monitoring dashboard provides detailed insights into API Gateway performance throughout your infrastructure, including the number and types of API calls, API resources, cache hits and misses, latency averages, and errors by HTTP method. 

Use this dashboard to:

  • Monitor API Gateways across your infrastructure using enhanced metrics. 
  • Monitor API requests trend by resource, HTTP method, and deployment stage. 
  • Monitor API cache hits and misses to optimize cache capacities to achieve the desired performance.
  • Monitor the overall responsiveness of API calls and the backend origin servers.
  • Monitor the total number of client-side and server-side errors based on HTTP methods.

3. AWS API Gateway - Enhanced Monitoring.png