guardian / guardian/cdk

Enable API Gateway logs when creating a GuApiLambda

Open
#1,935 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
22
Forks
6
Avg merge
1d 17h
Merged PRs (30d)
9

Description

I spent a while today debugging an alert for a large percentage of 5XX responses from a cdk-configured GuApiLambda. It turned out the lambda is taking longer than 30 seconds on each invocation, and so the API Gateway is timing out. However, this was a little hard to debug, because the API Gateway logs (as distinct from the lambda logs) were disabled – I was able to turn them on in the web UI, but had to be shown that that was possible.

Would it be possible for those logs to be enabled by default if using the GuApiLambda (and ideally sent to the same log group as the lambda’s logs)? I think it would be helpful for people debugging errors like these in the future.

Contributor guide

Open the contributing guide

Research direction

Start by locating the GuApiLambda construct and the API Gateway configuration it creates. Check how the Lambda log group is configured, then determine how API Gateway access logs can be enabled by default and directed to that group. Done means GuApiLambda deployments expose API Gateway logs without manual console configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
api, cloud, observability
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.