feat: Sentry와 SpringBoot 로깅 프레임워크(log4j2) 연동 (#115)

* [BOOK-295] chore: buildSrc - Sentry 관련 의존성 추가

* [BOOK-295] feat: apis, infra - InfraConfig에 센트리 활성화 및 환경변수 주입 클래스 구현

* [BOOK-295] feat: infra - log4j2-spring.xml에 SentryAppender 추가

* [BOOK-295] chore: yml 파일에 관련 환경변수 세팅 및 모듈 별로 센트리 에러를 감지하도록 구현

* [BOOK-295] refactor: RollingFile 옵션 제거

* [BOOK-295] chore: Sentry Appender에 level 옵션 제거

* [BOOK-295] refactor: 코드레빗 리뷰 반영

Author: move-hoon

admin/src/main/resources/application.yml

@@ -34,6 +34,9 @@ springdoc:
     enabled: true
   override-with-generic-response: false
 
+app:
+  module-name: admin
+
 ---
 spring:
   config:

apis/src/main/kotlin/org/yapp/apis/config/InfraConfig.kt

@@ -13,7 +13,8 @@ import org.yapp.infra.InfraBaseConfigGroup
         InfraBaseConfigGroup.REST_CLIENT,
         InfraBaseConfigGroup.QUERY_DSL,
         InfraBaseConfigGroup.PAGE,
-        InfraBaseConfigGroup.AOP
+        InfraBaseConfigGroup.AOP,
+        InfraBaseConfigGroup.SENTRY
     ]
 )
 class InfraConfig

apis/src/main/resources/application.yml

@@ -42,6 +42,9 @@ springdoc:
     enabled: true
   override-with-generic-response: false
 
+app:
+  module-name: apis
+
 ---
 spring:
   config:

batch/src/main/resources/application.yml

@@ -23,6 +23,9 @@ spring:
       max-file-size: 10MB
       max-request-size: 30MB
 
+app:
+  module-name: batch
+
 ---
 spring:
   config:

buildSrc/src/main/kotlin/Dependencies.kt

@@ -70,4 +70,9 @@ object Dependencies {
     object Prometheus {
         const val MICROMETER_PROMETHEUS_REGISTRY = "io.micrometer:micrometer-registry-prometheus"
     }
+
+    object Sentry {
+        const val SPRING_BOOT_STARTER = "io.sentry:sentry-spring-boot-starter-jakarta:8.22.0"
+        const val LOG4J2 = "io.sentry:sentry-log4j2:8.22.0"
+    }
 }

infra/build.gradle.kts

@@ -17,6 +17,9 @@ dependencies {
 
     implementation(Dependencies.QueryDsl.JPA)
 
+    implementation(Dependencies.Sentry.SPRING_BOOT_STARTER)
+    implementation(Dependencies.Sentry.LOG4J2)
+
     kapt(Dependencies.QueryDsl.APT)
 
     testImplementation(Dependencies.Spring.BOOT_STARTER_TEST)

infra/src/main/kotlin/org/yapp/infra/InfraBaseConfigGroup.kt

@@ -7,6 +7,7 @@ import org.yapp.infra.config.internal.async.AsyncConfig
 import org.yapp.infra.config.internal.jpa.JpaConfig
 import org.yapp.infra.config.internal.page.PageConfig
 import org.yapp.infra.config.internal.querydsl.QuerydslConfig
+import org.yapp.infra.config.external.sentry.SentryConfig
 
 enum class InfraBaseConfigGroup(
     val configClass: Class<out InfraBaseConfig>
@@ -17,5 +18,6 @@ enum class InfraBaseConfigGroup(
     REDIS(RedisConfig::class.java),
     REST_CLIENT(RestClientConfig::class.java),
     QUERY_DSL(QuerydslConfig::class.java),
-    AOP(AopConfig::class.java)
+    AOP(AopConfig::class.java),
+    SENTRY(SentryConfig::class.java)
 }

infra/src/main/kotlin/org/yapp/infra/config/external/sentry/SentryConfig.kt

@@ -0,0 +1,35 @@
+package org.yapp.infra.config.external.sentry
+
+import io.sentry.Sentry
+import io.sentry.SentryOptions
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.boot.context.properties.EnableConfigurationProperties
+import org.springframework.context.annotation.Bean
+import org.springframework.context.annotation.Configuration
+import org.yapp.infra.InfraBaseConfig
+
+@Configuration
+@EnableConfigurationProperties(SentryProperties::class)
+class SentryConfig(
+    private val sentryProperties: SentryProperties,
+    @Value("\${app.module-name}")
+    private val moduleName: String
+) : InfraBaseConfig {
+
+    @Bean
+    fun sentryOptionsCustomizer(): Sentry.OptionsConfiguration<SentryOptions> {
+        return Sentry.OptionsConfiguration { options: SentryOptions ->
+            if (sentryProperties.dsn.isBlank()) {
+                options.isEnabled = false
+                return@OptionsConfiguration
+            }
+
+            options.dsn = sentryProperties.dsn
+            options.environment = sentryProperties.environment
+            options.serverName = sentryProperties.serverName
+            options.setTag("module", moduleName)
+        }
+    }
+}
+
+

infra/src/main/kotlin/org/yapp/infra/config/external/sentry/SentryProperties.kt

@@ -0,0 +1,10 @@
+package org.yapp.infra.config.external.sentry
+
+import org.springframework.boot.context.properties.ConfigurationProperties
+
+@ConfigurationProperties(prefix = "sentry")
+data class SentryProperties(
+    val dsn: String,
+    val environment: String,
+    val serverName: String,
+)

infra/src/main/resources/application-crosscutting.yml

@@ -10,6 +10,18 @@ logging:
     controller:
       enabled: true
 
+sentry:
+  dsn: ${SENTRY_DSN}
+  environment: ${SENTRY_ENVIRONMENT}
+  server-name: ${SENTRY_SERVER_NAME}
+  traces-sample-rate: 1.0
+  send-default-pii: true
+  logs:
+    enabled: true
+  logging:
+    minimum-event-level: error
+    minimum-breadcrumb-level: info
+
 ---
 spring:
   config:
@@ -25,3 +37,15 @@ logging:
       max-log-length: 500
     controller:
       enabled: true
+
+sentry:
+  dsn:
+  environment: test
+  server-name: reed-test
+  traces-sample-rate: 1.0
+  send-default-pii: true
+  logs:
+    enabled: true
+  logging:
+    minimum-event-level: error
+    minimum-breadcrumb-level: info