Cloudwatch alarm for 5xx API responses doesn't work

Open
  • Is something wrong?
#2,044 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
aws, python
Domain
cloud, observability

Research direction

Start with apps/monitoring-cf.yml.j2 at the alarm definition around line 34, then check the linked AWS API Gateway metrics and dimensions documentation. Confirm the dimension and metric names used by the alarm against that reference. Done means the alarm reports the 5xx response metric instead of No Data and can trigger an SNS message when responses occur.

Written by the indexing model from the issue text.

Description

Our API alarm specifies ApiId, but the cloudwatch docs suggest the correct dimension is ApiName. The metric is 5xx, but should be 5XXError.

https://github.com/ASFHyP3/hyp3/blob/develop/apps/monitoring-cf.yml.j2#L34

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.html

The alarm is created, but the metric always reports as No Data even when there are 5xx responses, so the alarm never triggers and no SNS message is ever sent.

Dominant language
Python
Stars
53
Forks
13
Avg merge
1d 2h
Merged PRs (30d)
20

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ASFHyP3/hyp3

All issues in ASFHyP3/hyp3

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.