aws-samples / aws-samples/aws-cloudwatch-dashboard-generator

Add support for Amazon API Gateway REST API

Open
#17 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
25
Forks
6
PR merge metrics
No merged PRs in 30d

Description

## Description
Request to add support for Amazon API Gateway REST APIs to the CloudWatch Dashboard Generator tool.
API Gateway is a commonly used service for building serverless APIs that would benefit from monitoring during Countdown scenarios.

## Proposed Implementation
Add API Gateway REST API support with the following dimensions:

- **Namespace**: `AWS/ApiGateway`
- **Dimensions**:
- `ApiName` and `Stage`
- **Metrics**:
- Count (number of API calls)
- Latency (overall latency of API requests)
- IntegrationLatency (latency of backend integration)
- 4XXError (client-side errors)
- 5XXError (server-side errors)

## Expected CSV Format
service,region_code,dim1_name,dim1_value,dim2_name,dim2_value
APIGW_REST,us-east-1,ApiName,my-rest-api,Stage,prod
APIGW_REST,us-east-1,ApiName,my-rest-api,Stage,dev

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing service implementations and the CLI's CSV input and dashboard-generation entry points. Add the AWS/ApiGateway service using the ApiName and Stage dimensions and listed metrics, then verify that the documented APIGW_REST CSV rows produce the expected dashboard configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, python
Domain
cli, cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.