Skip to content

Latest commit

 

History

History
15 lines (12 loc) · 1.08 KB

gateway-api-log.md

File metadata and controls

15 lines (12 loc) · 1.08 KB

Gateway API Log

Data related to the identity of the caller, the request, and the response of requests made against our API. These logs can be helpful for monitoring, troubleshooting, and analyzing the usage of the API.

Setup

If you're a member of the github team "hmpps-integration-api" you should be able to view log in AWS Console

Steps

  1. Follow Cloud Platform's documentation to log in AWS Console
  2. Select CloudWatch service and go to Log groups LogGroups
  3. Search log groups by name. e.g. integration-api-dev
  4. Click on log gtroup name and go to Log streams tab
  5. Choose a log stream by click on the name

Example Use Case

We'd like to debug a request. Gateway API excution log can provide details on the request payload, the endpoint and response of the request. This helps in troubleshooting and identifying the root cause of issues.