[Feature] - 로깅 프레임워크 적용 #177

eunjungL · 2024-07-31T10:19:06Z

✅ 작업 내용

성공 응답 로깅 filter 적용
logback-spring.yml 작성

github-actions · 2024-07-31T10:20:36Z

Test Results

52 tests 51 ✅ 4s ⏱️
14 suites 1 💤
14 files 0 ❌

Results for commit 47b7f4d.

♻️ This comment has been updated with latest results.

…s/2024-touroot into feature/be/#167

Libienz

클로버 고생하셨습니다 👍
간단한 질문 남겼어요 확인 부탁드립니다 🙇🏻‍♂️

Libienz · 2024-07-31T10:26:16Z

backend/src/main/java/kr/touroot/global/logging/LoggingFilter.java

+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/h2-console/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.POST, "/h2-console/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/favicon/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/swagger-ui/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/swagger-resources/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/v3/api-docs/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.OPTIONS, "/**")


요고 괜찮은가요? 저희 상위 패키지 명이 바뀌었는데 🤔

좋은지적 감사합니다리
바로 반영 완료 굿

Libienz · 2024-07-31T10:27:18Z

backend/src/main/java/kr/touroot/global/logging/LoggingFilter.java

+@Slf4j
+@Component
+public class LoggingFilter extends OncePerRequestFilter {
+


인터셉터 말고 필터에 한 이유 간단히 설명 들을 수 있을까요?
참고하신 링크 정도만 주셔도 좋을 것 같습니다.

Logging은 모든 응답에 대해 기록돼야하므로 모든 요청에 전역적인 적용이 되는 Filter를 활용했습니다!

eunjungL

리비 코멘트 반영 완료!
좋은 리뷰 감사합니다람쥐

eunjungL · 2024-07-31T10:31:24Z

backend/src/main/java/kr/touroot/global/logging/LoggingFilter.java

+@Slf4j
+@Component
+public class LoggingFilter extends OncePerRequestFilter {
+


Logging은 모든 응답에 대해 기록돼야하므로 모든 요청에 전역적인 적용이 되는 Filter를 활용했습니다!

eunjungL · 2024-07-31T10:32:13Z

backend/src/main/java/kr/touroot/global/logging/LoggingFilter.java

+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/h2-console/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.POST, "/h2-console/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/favicon/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/swagger-ui/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/swagger-resources/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.GET, "/v3/api-docs/**"),
+            new woowacourse.touroot.global.auth.dto.HttpRequestInfo(HttpMethod.OPTIONS, "/**")


좋은지적 감사합니다리
바로 반영 완료 굿

hangillee

로깅 작업 고생하셨습니다! 문제 없어보이네요!

hangillee · 2024-08-01T01:10:43Z

backend/.gitignore

좋은 지적 감삼다

hangillee · 2024-08-01T01:20:16Z

backend/src/main/resources/logback-spring.xml

로그 파일이 저장되는 경로를 나중에 팀 문서에 공유 부탁드립니다!

넵! 도커에서는 어디에 저장될지 예상이 안가서 한 번 돌려봐야될 것 같습니다

nak-honest

하나만 확인해 주시면 approve 드릴게요!

nak-honest · 2024-08-01T01:37:35Z

backend/.gitignore

nak-honest · 2024-08-01T01:37:54Z

backend/src/main/java/kr/touroot/global/auth/JwtAuthFilter.java

-            request.setAttribute("memberId", memberId);
+            request.setAttribute(MEMBER_ID_ATTRIBUTE, memberId);


레벨 1을 잊지 않으셨군요

nak-honest · 2024-08-01T01:38:22Z

backend/src/main/java/kr/touroot/global/auth/JwtAuthFilter.java

+        log.warn("UNAUTHORIZED_EXCEPTION :: message = {}", message);
+


warn 로그 레벨 도입 좋습니다

nak-honest · 2024-08-01T02:01:19Z

backend/src/main/java/kr/touroot/global/logging/LoggingFilter.java

+        if (memberId == null) {
+            log.info("{} {} ({})", method, url, statusCode);
+            filterChain.doFilter(request, response);
+            return;
+        }
+
+        log.info("{} {} ({}) :: userId = {}", method, url, statusCode, memberId);
+        filterChain.doFilter(request, response);


응답은 doFilter 호출 후에 로깅해야 하지 않나요?
한번 확인 부탁 드립니닷!!

뿐만 아니라 에러 응답에 대한 로깅도 ExceptionHandler 말고 여기서 찍으면 어떨까 싶습니다!
여기서 응답 코드에 따라 로그 레벨을 구분해서 로깅하면 좋을 것 같아요!

좋은 지적 감사합니다 낙낙! 200 응답만 확인해봤더니 미처 놓쳤네요
응답에 대한 로깅은 다른 팀원들과 얘기해본 결과

GlobalExceptionHandler에서는 예외에 대한 정보를 로깅 -> 에외에 대한 정보가 한 곳에 모여있도록

LoggingFilter에서는 응답에 대한 정보를 로깅

이렇게 역할을 주기로 결정했습니다!

eunjungL

리뷰 반영 완료했습니다! 확인 부탁드려요!

eunjungL · 2024-08-01T01:42:27Z

backend/.gitignore

좋은 지적 감삼다

eunjungL · 2024-08-01T01:46:52Z

backend/src/main/resources/logback-spring.xml

넵! 도커에서는 어디에 저장될지 예상이 안가서 한 번 돌려봐야될 것 같습니다

eunjungL · 2024-08-01T02:34:49Z

backend/src/main/java/kr/touroot/global/logging/LoggingFilter.java

+        if (memberId == null) {
+            log.info("{} {} ({})", method, url, statusCode);
+            filterChain.doFilter(request, response);
+            return;
+        }
+
+        log.info("{} {} ({}) :: userId = {}", method, url, statusCode, memberId);
+        filterChain.doFilter(request, response);


좋은 지적 감사합니다 낙낙! 200 응답만 확인해봤더니 미처 놓쳤네요
응답에 대한 로깅은 다른 팀원들과 얘기해본 결과

GlobalExceptionHandler에서는 예외에 대한 정보를 로깅 -> 에외에 대한 정보가 한 곳에 모여있도록

LoggingFilter에서는 응답에 대한 정보를 로깅

이렇게 역할을 주기로 결정했습니다!

* refactor: local/dev profile에서 show sql false로 변경 * feat: 401 exception logging 추가 및 attribute 이름 상수화 * feat: LoggingFilter 추가 * feat: loggback-spring.xml 작성 * fix: dev profile일 때 파일로 넣게 변경 * fix: logginFilter에서 userId memberId로 수정 * fix: HttpRequestInfo package 변경 * fix: HttpRequestInfo package 변경 * fix: .gitignore EOL 추가 * fix: logging 로직 dofilter 이후로 변경

eunjungL added 6 commits July 31, 2024 15:10

refactor: local/dev profile에서 show sql false로 변경

6d21eed

feat: 401 exception logging 추가 및 attribute 이름 상수화

6cdaf3f

feat: LoggingFilter 추가

6eaaa60

Merge branch 'develop/be' into feature/be/#167

72db36d

feat: loggback-spring.xml 작성

d736e52

fix: dev profile일 때 파일로 넣게 변경

2cde6f1

eunjungL added the BE label Jul 31, 2024

eunjungL added this to the sprint 3 milestone Jul 31, 2024

eunjungL requested review from hangillee, Libienz, nak-honest and slimsha2dy July 31, 2024 10:19

eunjungL self-assigned this Jul 31, 2024

Merge branch 'develop/be' into feature/be/#167

f323ede

eunjungL added 2 commits July 31, 2024 19:22

fix: logginFilter에서 userId memberId로 수정

9539e88

Merge branch 'feature/be/#167' of https://github.com/woowacourse-team…

5d7c58f

…s/2024-touroot into feature/be/#167

Libienz approved these changes Jul 31, 2024

View reviewed changes

fix: HttpRequestInfo package 변경

0d0cc43

eunjungL commented Jul 31, 2024

View reviewed changes

fix: HttpRequestInfo package 변경

0038e7d

hangillee approved these changes Aug 1, 2024

View reviewed changes

fix: .gitignore EOL 추가

50ab22a

nak-honest requested changes Aug 1, 2024

View reviewed changes

fix: logging 로직 dofilter 이후로 변경

55c3bf8

eunjungL commented Aug 1, 2024

View reviewed changes

eunjungL requested a review from nak-honest August 1, 2024 02:36

Merge branch 'develop/be' into feature/be/#167

47b7f4d

eunjungL merged commit 6dd1b27 into develop/be Aug 1, 2024
3 checks passed

eunjungL deleted the feature/be/#167 branch August 1, 2024 03:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] - 로깅 프레임워크 적용 #177

[Feature] - 로깅 프레임워크 적용 #177

eunjungL commented Jul 31, 2024

github-actions bot commented Jul 31, 2024 •

edited

Loading

Libienz left a comment

Libienz Jul 31, 2024

eunjungL Jul 31, 2024

Libienz Jul 31, 2024

eunjungL Jul 31, 2024

eunjungL left a comment

eunjungL Jul 31, 2024

eunjungL Jul 31, 2024

hangillee left a comment

hangillee Aug 1, 2024

nak-honest Aug 1, 2024

eunjungL Aug 1, 2024

hangillee Aug 1, 2024

eunjungL Aug 1, 2024

nak-honest left a comment

nak-honest Aug 1, 2024

nak-honest Aug 1, 2024

nak-honest Aug 1, 2024

nak-honest Aug 1, 2024

nak-honest Aug 1, 2024

eunjungL Aug 1, 2024

eunjungL left a comment

eunjungL Aug 1, 2024

eunjungL Aug 1, 2024

eunjungL Aug 1, 2024

		request.setAttribute("memberId", memberId);
		request.setAttribute(MEMBER_ID_ATTRIBUTE, memberId);

		log.warn("UNAUTHORIZED_EXCEPTION :: message = {}", message);

[Feature] - 로깅 프레임워크 적용 #177

[Feature] - 로깅 프레임워크 적용 #177

Conversation

eunjungL commented Jul 31, 2024

✅ 작업 내용

github-actions bot commented Jul 31, 2024 • edited Loading

Test Results

Libienz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eunjungL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hangillee left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nak-honest left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eunjungL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jul 31, 2024 •

edited

Loading