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: Sentry 에러 모니터링 적용 #707

Merged
merged 8 commits into from
Aug 29, 2024

Conversation

uwoobeat
Copy link
Member

@uwoobeat uwoobeat commented Aug 28, 2024

🌱 관련 이슈

📌 작업 내용 및 특이사항

  • Sentry Spring Boot + Logback 적용했습니다.
  • 기본적으로 log.warn 같은 것들은 logback으로 캡쳐합니다.
  • 따로 GlobalExceptionHandler에서 500으로 잡히는 케이스도 역시 log.error 로 잡히기 떄문에 별도로 captureException을 호출해줄 필요가 없습니다.
  • 센트리로 릴리즈 정보를 포맷에 맞게 넘겨주기 위해 도커 이미지 태그 변환해주는 로직이 들어갔습니다.

릴리즈는 환경 에 배포되는 코드 버전입니다. Sentry에 릴리스에 대한 정보를 제공하면 다음을 수행할 수 있습니다.

  • 새 릴리스에서 도입된 문제 및 회귀를 확인합니다.
  • 어떤 커밋이 문제를 일으켰는지, 누가 책임이 있는지 예측합니다.
  • 커밋 메시지에 이슈 번호를 포함하여 문제를 해결하세요.
  • 코드가 배포되면 이메일 알림을 받으세요
  • 릴리즈를 넘겨주면 위와 같은 이점이 있습니다

📝 참고사항

📚 기타

Summary by CodeRabbit

  • New Features

    • Sentry 통합을 위한 새로운 설정을 추가하여 오류 추적 및 성능 모니터링 기능을 향상시켰습니다.
    • Docker 관련 속성을 관리할 수 있는 새로운 DockerProperty 클래스를 도입했습니다.
    • application-sentry.yml 파일을 추가하여 Sentry 설정을 구성할 수 있도록 하였습니다.
  • Bug Fixes

    • Docker 이미지 태그를 동적으로 설정할 수 있는 환경 변수를 추가하여 배포 유연성을 개선하였습니다.

@uwoobeat uwoobeat requested a review from a team as a code owner August 28, 2024 17:20
Copy link

coderabbitai bot commented Aug 28, 2024

Walkthrough

이 변경 사항은 Sentry 에러 모니터링을 애플리케이션에 통합하기 위해 여러 파일에서 수정이 이루어졌습니다. build.gradle 파일에 Sentry 의존성과 플러그인이 추가되었고, docker-compose.yml에서 Docker 이미지 태그를 동적으로 설정할 수 있는 환경 변수가 도입되었습니다. 또한, Docker 관련 속성을 관리하기 위한 새로운 클래스와 Sentry 설정을 위한 구성 파일이 추가되었습니다.

Changes

파일 경로 변경 요약
build.gradle Sentry Gradle 플러그인(4.11.0) 및 Logback 통합(sentry-logback:7.14.0) 추가
docker-compose.yml DOCKER_IMAGE_TAG 환경 변수 추가
src/main/java/com/gdschongik/gdsc/... PropertyConfigDockerProperty 추가, SentryConfig 클래스 및 관련 메서드 추가
src/main/java/com/gdschongik/gdsc/... DockerProperty 클래스 추가
src/main/resources/application-sentry.yml Sentry 설정을 위한 새로운 YAML 파일 추가
src/main/resources/application.yml spring 섹션에 Sentry 서비스 추가

Sequence Diagram(s)

sequenceDiagram
    participant App as Application
    participant Sentry as Sentry Service
    participant Docker as Docker Configuration

    App->>Docker: Retrieve Docker properties
    Docker-->>App: Provide Docker image tag
    App->>Sentry: Configure Sentry with Docker image tag
    Sentry-->>App: Setup error tracking and monitoring
Loading

Assessment against linked issues

Objective Addressed Explanation
⚙️ Sentry 에러 모니터링 적용 ( #286 )

🐰 변화의 숲 속에서 뛰어놀며,
Sentry와 함께하는 새로운 꿈을 꿉니다.
에러를 잡고, 성능을 살피며,
로그의 소리를 귀 기울여 듣지요.
이제는 Docker와 함께 손을 잡고,
우리 애플리케이션 더욱 빛나리라!
🌟✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8b779f8 and e95c4d8.

Files selected for processing (7)
  • build.gradle (2 hunks)
  • docker-compose.yml (1 hunks)
  • src/main/java/com/gdschongik/gdsc/global/config/PropertyConfig.java (2 hunks)
  • src/main/java/com/gdschongik/gdsc/global/config/SentryConfig.java (1 hunks)
  • src/main/java/com/gdschongik/gdsc/global/property/DockerProperty.java (1 hunks)
  • src/main/resources/application-sentry.yml (1 hunks)
  • src/main/resources/application.yml (1 hunks)
Files skipped from review due to trivial changes (1)
  • src/main/resources/application.yml
Additional comments not posted (7)
src/main/java/com/gdschongik/gdsc/global/property/DockerProperty.java (1)

1-12: Spring 빈 등록 확인 필요

DockerProperty 클래스가 Spring 빈으로 등록되었는지 확인하는 것이 좋습니다. 이를 위해 @ConfigurationPropertiesScan 또는 @EnableConfigurationProperties 어노테이션을 사용하여 해당 클래스를 스캔하도록 설정해야 합니다.

src/main/resources/application-sentry.yml (1)

1-17: Sentry DSN 환경 변수 설정 확인 필요

Sentry DSN이 환경 변수에 올바르게 설정되었는지 확인하는 것이 좋습니다. 설정되지 않은 경우 Sentry 에러 모니터링이 제대로 작동하지 않을 수 있습니다.

docker-compose.yml (1)

13-13: 환경 변수 설정 확인 필요

IMAGE_FULL_URL 환경 변수가 올바르게 설정되었는지 확인하는 것이 좋습니다. 설정되지 않은 경우 Docker 이미지 태그가 제대로 적용되지 않을 수 있습니다.

src/main/java/com/gdschongik/gdsc/global/config/PropertyConfig.java (2)

5-5: LGTM!

DockerProperty를 가져오는 것은 올바르며 추가된 기능에 필요합니다.

코드 변경 사항이 승인되었습니다.


21-22: LGTM!

DockerProperty@EnableConfigurationProperties에 추가하는 것은 Docker 관련 속성을 관리할 수 있도록 합니다.

코드 변경 사항이 승인되었습니다.

build.gradle (2)

7-7: LGTM!

Sentry Gradle 플러그인이 올바르게 추가되었습니다.

코드 변경 사항이 승인되었습니다.


101-101: LGTM!

Sentry Logback 의존성이 올바르게 추가되었습니다.

코드 변경 사항이 승인되었습니다.

Comment on lines 1 to 40
package com.gdschongik.gdsc.global.config;

import com.gdschongik.gdsc.global.property.DockerProperty;
import io.sentry.Sentry;
import io.sentry.SentryOptions;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@RequiredArgsConstructor
public class SentryConfig {

private final DockerProperty dockerProperty;

@Bean
Sentry.OptionsConfiguration<SentryOptions> customOptionsConfiguration() {
return options -> {
options.setRelease(convertTagToVersion(dockerProperty.getTag()));
};
}

// gdscrepo/gdsc-server:v1.0.0 -> [email protected]
// gdscrepo/gdsc-server:ffffff -> gdsc-server@ffffff
private String convertTagToVersion(String tag) {
if (tag.isBlank()) {
return "gdsc-server";
}

String imageWithVersion = tag.split("/")[1]; // gdsc-server:v1.0.0
String[] split = imageWithVersion.split(":"); // [gdsc-server, v1.0.0]
String version = split[1]; // v1.0.0 or ffffff (commit hash)
if (version.startsWith("v")) {
version = version.substring(1); // 1.0.0
}
String s = split[0] + "@" + version; // [email protected]
System.out.println("s = " + s);
return s;
}
}
Copy link

Choose a reason for hiding this comment

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

LGTM!

Sentry 설정 파일이 올바르게 구현되었습니다. 그러나 몇 가지 개선 사항을 제안합니다.

  1. convertTagToVersion 메서드에서 System.out.println 대신 로깅 프레임워크를 사용하세요.
  2. convertTagToVersion 메서드의 split 사용을 더 안전하게 처리할 수 있습니다.
- System.out.println("s = " + s);
+ log.info("Converted tag to version: {}", s);
+ if (split.length < 2) {
+     throw new IllegalArgumentException("Invalid tag format");
+ }

Copy link

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e95c4d8 and 3b1bf2a.

Files selected for processing (1)
  • src/main/java/com/gdschongik/gdsc/global/config/SentryConfig.java (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/main/java/com/gdschongik/gdsc/global/config/SentryConfig.java

@uwoobeat uwoobeat changed the title chore: Sentry 에러 모니터링 적용 chore: Sentry 에러 모니터링 적용 Aug 28, 2024
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

Copy link
Member

@AlmondBreez3 AlmondBreez3 left a comment

Choose a reason for hiding this comment

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

lgtm

@uwoobeat uwoobeat self-assigned this Aug 29, 2024
@uwoobeat uwoobeat merged commit 9723ee0 into develop Aug 29, 2024
1 check passed
@uwoobeat uwoobeat deleted the chore/286-sentry-monitoring branch August 29, 2024 03:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

⚙️ Sentry 에러 모니터링 적용
3 participants