API 로그를 나중에 검색할 수 있게 남기는 법, 요청마다 ID를 붙여 같은 요청의 기록을 묶는다(qiita.com)
작성 언어: 한국어작성 언어로 보기
쉬운 요약
- 서버가 남기는 기록에 요청마다 고유한 번호(requestId)를 붙이면, 동시에 처리된 요청 중 어느 것이 실패했는지 시각만으로 알 수 없는 문제를 피할 수 있다. 일본 개발자 masashige0904가 Qiita에 쓴 설계 예시다.
- 로그는 한 건을 한 줄 JSON으로 남기고 이벤트명, 요청 ID, 실패 분류처럼 검색할 값을 별도 항목으로 둔다. 여러 줄 오류 기록은 수집 방식에 따라 여러 이벤트로 쪼개질 수 있다고 한다.
- 비밀번호, 인증 토큰, 이메일, 요청 본문, 안전성을 확인하지 않은 예외 원문과 SQL은 남기지 않는 방침을 세우고, 공통 로그 창구를 만들어 이 규칙을 한곳에서 점검하는 방법을 제시한다.
- AWS CloudWatch Logs Insights에서 requestId로 걸러 시간순으로 정렬하면 한 요청의 시작과 실패를 이어 볼 수 있다. 글의 검색 결과 표는 AWS에서 실행한 것이 아닌 가상 예시이며, 보관 기간과 요금은 따로 확인해야 한다고 적었다.
발견한 곳
Qiita ↗ / 매체 발행 글
비슷한 일을 겪어 본 적이 있나요? 그때 어떻게 했는지 한두 줄로 들려주세요. 제품을 잘 몰라도 괜찮습니다.