1. 표준 로깅 라이브러리 사용
: Log4j, Logback과 같은 표준 로깅 라이브러리를 권장
2. Appenders를 현명하게 선택
: 기존 파일 또는 데이터 구조 끝에 추가하는 소프트에어 및 구성요소를 현명하게 선택
3. 의미 있는 메시지 사용
: "오류 발생" 대신 "데이터베이스에 연결하지 못함" 등의 행동 실패를 기록
4. 로그 메시지 형식 지정 및 구조하
: 각 메시지에 대해 일관되고 명확한 패턴 사용
: 표준 날짜 및 시간 형식 사용 (ISO 8601)
: 공통 구분 기호를 사용하여 서로 다른 필드 구분
: JSON을 사용하여 중첩된 데이터 표시
: 문자열 연결 대신 변수화된 메시지 사용
5. 로깅 필터 및 인터셉터 구현
: 요청 및 응답 세부 정보 기록
: REST API의 실행 시간 및 성능 메트릭 기록
: 발생하는 예외 및 오류 기록
: 인증 및 권한 정보 기록
: 비즈니스 로직 및 유효성 검사 기록
6. 민감한 정보는 마스킹 및 암호화
: 정규식 또는 패턴으로 민감한 데이터를 *로 변경
: 혹은 해싱 및 암호화 알고리즘으로 읽을 수 없도록 변환
7. 적절한 로그 레벨 사용
8. 로그 파일 갱신 및 보관
: 시간 개별 갱신, 크기 별 갱신, 하이브리드 갱신 (시간 + 크기), 압축, 삭제 등
Reference
조서희 / 자바 REST API 로깅: 모범 사례와 가이드라인 | 커리어리
로그는 애플리케이션의 작동 방식을 이해하는 데 필수적입니다. 로그를 분석하는 것은 무엇이 잘못되었는지 가장 ...
careerly.co.kr
appender: 뜻과 사용법 살펴보기 | RedKiwi Words
Appender는 기존 파일 또는 데이터 구조의 끝에 데이터를 추가하는 소프트웨어 구성 요소 또는 기능을 의미합니다. 사용자가 기존 파일이나 데이터 구조에 새 데이터를 추가할 수 있도록 프로그래
redkiwiapp.com
Java REST API Logging: Best Practices and Guidelines
Logging is essential for understanding how an application works, both in the present and the past. Analyzing logs is the fastest way to…
romanglushach.medium.com
'Development > Development' 카테고리의 다른 글
| CQRS (Command And Query Responsibility Segregation) 아키텍처 패턴에 대해 (0) | 2023.12.28 |
|---|---|
| 코딩 표기법 (0) | 2023.11.07 |
| 의사 코드 (Pseudo-code) 작성법 (0) | 2023.11.07 |
| GoF 디자인 패턴에 대한 이해하기 쉬운 총 정리 (개념 / 필요성 / 현실의 예시) (0) | 2023.09.23 |
| 멋진 API를 만드는 3가지 비결 (0) | 2023.08.19 |