serverless / serverless/serverless
Option to enable AWS api logging without full request/response
Open
Nobody has claimed this yet.
cat/aws-event-api-gateway
enhancement
- Dominant language
- JavaScript
- Stars
- 46.9k
- Forks
- 5.7k
- Avg merge
- 10h 7m
- Merged PRs (30d)
- 57
Description
Feature proposal for more granular AWS API Gateway logging
Description
Actual behavior:
- Enabling logging at the API GW level via provider->logs->restApi=true is useful, but it also adds "log full requests/responses data" (
/*/*/logging/dataTrace), which may not be desired due to compliance requirements or just plain cost concerns
Desired behavior:
- Cloudwatch basic logs, cloudwatch full (dataTrace) logs, and access logging can be individually enabled/disabled.
Nice to have: have option of overriding the access log format and CloudWatch Group (in a shared API GW situation, you don't want the service name being encoded into the CloudWatch Group).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with lib/plugins/aws/package/compile/events/apiGateway/lib/hack/updateStage.js around the referenced logging configuration. Review how provider->logs->restApi currently enables API Gateway logging, then define and implement independently controllable basic logs, dataTrace logs, and access logging; the access-log format and CloudWatch Group overrides are optional nice-to-haves.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, javascript
- Domain
- api, cloud, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100