Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: log level info 로 변경 및 stack trace 제거 #838

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

kckc0608
Copy link
Member

@kckc0608 kckc0608 commented Jan 7, 2025

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • 에러 로그 출력 부분에서 stack trace 제거
  • 의도된 에러에 대한 로깅 레벨을 info 로 처리

📝 참고사항

  • 로깅과 sentry 에 대해 이것 저것 알아보고 테스트 해보느라 시간이 걸렸습니다..
    예상가능한 에러에 대해서는 info 레벨로 로깅하는 것이 일반적이라고 하여 로깅 레벨을 변경하고 센트리는 기존대로 erorr 레벨에 대해 알림을 받도록 하였습니다. internal server error 에 대해서만 error 레벨을 유지했는데, 여기에서도 스택 트레이스를 제거하면 정보를 센트리에서 확인하지 못할까 싶어서 찾아보고 테스트해봤는데, stack trace 에 대한 출력 없이도 sentry 에서 stack trace 조회가 가능하여 error 레벨에서도 스택 트레이스 출력을 제거 했습니다.

📚 기타

Summary by CodeRabbit

  • 스타일
    • 예외 처리 로깅 레벨을 오류(error)에서 정보(info)로 변경
    • 다양한 예외 핸들러의 로그 심각도 수준 조정

@kckc0608 kckc0608 added the ⚙️ chore 빌드 및 CI/CD label Jan 7, 2025
@kckc0608 kckc0608 self-assigned this Jan 7, 2025
@kckc0608 kckc0608 requested a review from a team as a code owner January 7, 2025 12:39
Copy link

coderabbitai bot commented Jan 7, 2025

Walkthrough

글로벌 예외 처리 핸들러에서 로깅 수준을 log.error에서 log.info로 변경했습니다. 이는 다양한 예외 유형(CustomException, CustomPaymentException, 일반 Exception)에 대한 로깅 심각도를 낮추는 작업을 포함합니다. 예외 처리 메서드의 기본 구조와 기능은 변경되지 않았습니다.

Changes

파일 변경 요약
src/main/java/com/gdschongik/gdsc/global/exception/GlobalExceptionHandler.java 예외 처리 메서드의 로깅 레벨을 log.error에서 log.info로 변경

Assessment against linked issues

목표 해결 여부 설명
스택 트레이스 제거 [#823] 로깅 레벨 변경은 있었으나, 스택 트레이스 완전 제거 여부 불명확
예외 정보 로깅 [#823] 로깅 레벨 변경으로 예외 정보 유지

🐰 코드의 에러 로그,
조용히 낮은 목소리로
정보를 속삭이네
에러는 작아졌지만
의미는 여전히 크다! 🚨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

github-actions bot commented Jan 7, 2025

Job Summary for Gradle

Check Style and Test to Develop :: build-test
Gradle Root Project Requested Tasks Gradle Version Build Outcome Build Scan®
gdsc check 8.5 Build Scan published

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
src/main/java/com/gdschongik/gdsc/global/exception/GlobalExceptionHandler.java (1)

40-40: 검증 오류 메시지 개선 제안

검증 오류를 info 레벨로 변경한 것은 적절하나, 디버깅을 위해 더 자세한 정보를 로그에 포함하는 것이 좋을 것 같습니다.

다음과 같이 필드명과 오류 내용을 함께 로깅하는 것을 제안드립니다:

- log.info("METHOD_ARGUMENT_NOT_VALID : {}", e.getMessage());
+ log.info("METHOD_ARGUMENT_NOT_VALID - Field: {}, Error: {}", 
+     e.getBindingResult().getFieldError().getField(),
+     e.getBindingResult().getFieldError().getDefaultMessage());
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 26ec006 and 5fed433.

📒 Files selected for processing (1)
  • src/main/java/com/gdschongik/gdsc/global/exception/GlobalExceptionHandler.java (1 hunks)
🔇 Additional comments (3)
src/main/java/com/gdschongik/gdsc/global/exception/GlobalExceptionHandler.java (3)

20-20: 로그 레벨 변경이 적절합니다

CustomException은 예측 가능한 비즈니스 예외이므로 info 레벨로 로깅하는 것이 적절합니다.


26-26: 결제 관련 예외 처리 확인 필요

결제 관련 예외를 info 레벨로 변경한 것이 적절해 보이나, 중요한 결제 실패 케이스를 놓치지 않도록 Sentry에서 모니터링이 잘 되고 있는지 확인해주세요.


32-32: 내부 서버 오류는 error 레벨 유지가 적절합니다

예측하지 못한 내부 서버 오류의 경우 error 레벨을 유지한 것이 적절합니다.

Copy link
Member

@Sangwook02 Sangwook02 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚙️ chore 빌드 및 CI/CD
Projects
None yet
Development

Successfully merging this pull request may close these issues.

⚙️ 에러 로그 포맷 통일화 및 stack trace 제거
2 participants