All templates
/
Observability
CURATED TEMPLATE / AWS

A request fails in production and your team needs enough context to explain what happened.

API execution access logs

View original source

When this becomes useful

When a customer reports a failure, the team needs a trace of what happened without exposing secrets. Logging is useful when it connects an event to a clear response.

What the template offers

API execution access logs is a AWS example pattern from AWS Serverless Patterns. It offers a concrete implementation to inspect and adapt. Shows the logging layer around an API. Decide what customer and credential details must be redacted before adopting a log format.

Technical shape

Examine the API Gateway log format, destination, retention and the fields that could contain customer or credential data.

Questions worth answering

  • What identifiers help trace a customer issue?
  • Which fields must be redacted?
  • Who responds to an alert?

Inspect the source

Read the maintainer's README, license, setup instructions and current repository state before adapting the code.

Open AWS Serverless Patterns

Capabilities to plan next

A deployable pattern is one piece of the product. These guides cover behavior and decisions around it.