Feature / EventLog #138

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

Open

20210815 wants to merge 5 commits into develop from feature/page-view-eventlog

build.gradle

-Original file line number
+Diff line change
@@ Expand Up / @@ -67,6 +67,10 @@ dependencies { @@
         annotationProcessor "jakarta.persistence:jakarta.persistence-api"
         annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+        // Jackson JSR310 (Java 8 Date and Time API) 지원
+        implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310"
+        testImplementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310"
         testImplementation 'org.springframework.boot:spring-boot-starter-test'
         testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
         testImplementation "org.springframework.boot:spring-boot-testcontainers"
@@ Expand Down @@

src/main/java/redot/redot_server/domain/eventlog/controller/EventLogController.java

-Original file line number
+Diff line change
@@ -0,0 +1,63 @@
+    package redot.redot_server.domain.eventlog.controller;
+    import jakarta.servlet.http.HttpServletRequest;
+    import jakarta.validation.Valid;
+    import lombok.AllArgsConstructor;
+    import org.springframework.http.ResponseEntity;
+    import org.springframework.security.core.annotation.AuthenticationPrincipal;
+    import org.springframework.web.bind.annotation.PostMapping;
+    import org.springframework.web.bind.annotation.RequestBody;
+    import org.springframework.web.bind.annotation.RequestMapping;
+    import org.springframework.web.bind.annotation.RestController;
+    import redot.redot_server.domain.eventlog.controller.docs.EventLogControllerDocs;
+    import redot.redot_server.domain.eventlog.dto.PageViewCommand;
+    import redot.redot_server.domain.eventlog.dto.PageViewRequest;
+    import redot.redot_server.domain.eventlog.service.EventLogIngestService;
+    import redot.redot_server.global.redotapp.resolver.annotation.CurrentRedotApp;
+    import redot.redot_server.global.security.principal.JwtPrincipal;
+    import java.time.Instant;
+    import java.util.UUID;
+    @RestController
+    @AllArgsConstructor
+    @RequestMapping("/api/v1/event-logs")
+    public class EventLogController implements EventLogControllerDocs {
+        private final EventLogIngestService ingestService;
+        /*
+            페이지 뷰 이벤트 수집 엔드포인트
+         */
+        @PostMapping("/page-view")
+        public ResponseEntity<Void> pageView(
+                @CurrentRedotApp Long redotAppId,
+                @Valid @RequestBody PageViewRequest req,
+                HttpServletRequest servletRequest,
+                @AuthenticationPrincipal JwtPrincipal jwtPrincipal // 없을 수도 있음(비회원)
+        ) {
+            String ip = extractClientIp(servletRequest);
+            PageViewCommand cmd = new PageViewCommand(
+                    UUID.randomUUID(),
+                    redotAppId,
+                    req.deviceType(),
+                    ip,
+                    Instant.now()
+            );
+            ingestService.ingestPageView(cmd);
+            return ResponseEntity.accepted().build();
+        }
+        /*
+            클라이언트 IP 추출
+         */
+        private String extractClientIp(HttpServletRequest request) {
+            String xff = request.getHeader("X-Forwarded-For");
+            if (xff != null && !xff.isBlank()) return xff.split(",")[0].trim();
+            String xri = request.getHeader("X-Real-IP");
+            if (xri != null && !xri.isBlank()) return xri.trim();
+            return request.getRemoteAddr();
+        }
+    }

src/main/java/redot/redot_server/domain/eventlog/controller/docs/EventLogControllerDocs.java

-Original file line number
+Diff line change
@@ -0,0 +1,26 @@
+    package redot.redot_server.domain.eventlog.controller.docs;
+    import io.swagger.v3.oas.annotations.Operation;
+    import io.swagger.v3.oas.annotations.Parameter;
+    import io.swagger.v3.oas.annotations.enums.ParameterIn;
+    import io.swagger.v3.oas.annotations.responses.ApiResponse;
+    import io.swagger.v3.oas.annotations.tags.Tag;
+    import jakarta.servlet.http.HttpServletRequest;
+    import org.springframework.http.ResponseEntity;
+    import redot.redot_server.domain.eventlog.dto.PageViewRequest;
+    import redot.redot_server.global.security.principal.JwtPrincipal;
+    @Tag(name = "EventLogs", description = "이벤트 로그 관리 API")
+    public interface EventLogControllerDocs {
+        @Parameter(name = "X-App-Subdomain", in = ParameterIn.HEADER, required = true,
+                description = "요청 대상 Redot 앱의 서브도메인")
+        @Operation(summary = "페이지 뷰 이벤트 수집",
+                description = "클라이언트로부터 페이지 뷰 이벤트를 수집합니다.")
+        @ApiResponse(responseCode = "202", description = "이벤트 수집 요청 접수 성공")
+        ResponseEntity<Void> pageView(
+                @Parameter(hidden = true) Long redotAppId,
+                @Parameter(hidden = true) PageViewRequest req,
+                @Parameter(hidden = true) HttpServletRequest servletRequest,
+                @Parameter(hidden = true) JwtPrincipal jwtPrincipal
+        );
+    }

src/main/java/redot/redot_server/domain/eventlog/dto/PageViewCommand.java

-Original file line number
+Diff line change
@@ -0,0 +1,17 @@
+    package redot.redot_server.domain.eventlog.dto;
+    import redot.redot_server.domain.eventlog.entity.DeviceType;
+    import java.time.Instant;
+    import java.util.UUID;
+    public record PageViewCommand(
+            UUID eventId,
+            Long redotAppId,
+    //        IdentityType actorType,
+    //        Long actorId,          // nullable
+    //        String anonymousId,    // nullable
+            DeviceType deviceType,
+            String ip,
+            Instant occurredAt
+    ) {}

src/main/java/redot/redot_server/domain/eventlog/dto/PageViewRequest.java

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    package redot.redot_server.domain.eventlog.dto;
+    import jakarta.validation.constraints.NotNull;
+    import redot.redot_server.domain.eventlog.entity.DeviceType;
+    public record PageViewRequest(
+            @NotNull DeviceType deviceType
+            //String anonymousId // 비회원이면 프론트에서 UUID 만들어서 넣어주면 좋음
+    ) {}

src/main/java/redot/redot_server/domain/eventlog/entity/DeviceType.java

-Original file line number
+Diff line change
@@ -0,0 +1,7 @@
+    package redot.redot_server.domain.eventlog.entity;
+    public enum DeviceType {
+        MOBILE,
+        DESKTOP,
+        TABLET
+    }

src/main/java/redot/redot_server/domain/eventlog/entity/EventLogEntity.java

-Original file line number
+Diff line change
@@ -0,0 +1,71 @@
+    package redot.redot_server.domain.eventlog.entity;
+    import jakarta.persistence.*;
+    import redot.redot_server.global.common.entity.BaseTimeEntity;
+    import java.time.Instant;
+    import java.util.UUID;
+    @Entity
+    @Table(name = "event_logs",
+            indexes = {
+                    @Index(name = "idx_event_logs_app_time", columnList = "redot_app_id, occurred_at"),
+                    @Index(name = "idx_event_logs_type_time", columnList = "type, occurred_at")
+            },
+            uniqueConstraints = {
+                    @UniqueConstraint(name = "uk_event_logs_event_id", columnNames = "event_id")
+            }
+    )
+    public class EventLogEntity extends BaseTimeEntity {
+        @Id
+        @GeneratedValue(strategy = GenerationType.IDENTITY)
+        private Long id; // PK
+        // UUID를 varchar로 저장 (중복 방지 위함)
+        @Column(name = "event_id", nullable = false, updatable = false, length = 36)
+        private String eventId; // 이벤트 고유 ID
+        @Enumerated(EnumType.STRING)
+        @Column(nullable = false, length = 32)
+        private EventType type; // 이벤트 유형
+        @Column(name = "redot_app_id", nullable = false)
+        private Long redotAppId; // 리닷 앱 ID
+    //    @Enumerated(EnumType.STRING)
+    //    @Column(name = "actor_type", nullable = false, length = 32)
+    //    private IdentityType actorType;
+    //
+    //    @Column(name = "actor_id")
+    //    private Long actorId;
+    //
+    //    @Column(name = "anonymous_id", length = 64)
+    //    private String anonymousId;
+        @Enumerated(EnumType.STRING)
+        @Column(name = "device_type", nullable = false, length = 16)
+        private DeviceType deviceType; // 디바이스 유형
+        @Column(nullable = false, length = 64)
+        private String ip; // IP 주소
+        @Column(name = "occurred_at", nullable = false)
+        private Instant occurredAt; // 이벤트 발생 시각
+        protected EventLogEntity() {}
+        public static EventLogEntity pageView(UUID eventId, Long redotAppId, DeviceType deviceType, String ip, Instant occurredAt) {
+            EventLogEntity e = new EventLogEntity();
+            e.eventId = eventId.toString();
+            e.type = EventType.PAGE_VIEW;
+            e.redotAppId = redotAppId;
+    //        e.actorType = actorType;
+    //        e.actorId = actorId;
+    //        e.anonymousId = anonymousId;
+            e.deviceType = deviceType;
+            e.ip = ip;
+            e.occurredAt = occurredAt;
+            return e;
+        }
+    }

src/main/java/redot/redot_server/domain/eventlog/entity/EventType.java

-Original file line number
+Diff line change
@@ -0,0 +1,6 @@
+    package redot.redot_server.domain.eventlog.entity;
+    public enum EventType {
+        PAGE_VIEW, CTA_CLICK, PURCHASE
+        // 조회, 클릭, 구매
+    }

src/main/java/redot/redot_server/domain/eventlog/entity/IdentityType.java

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    package redot.redot_server.domain.eventlog.entity;
+    public enum IdentityType {
+        MEMBER, GUEST
+    }

src/main/java/redot/redot_server/domain/eventlog/repository/EventLogRepository.java

-Original file line number
+Diff line change
@@ -0,0 +1,9 @@
+    package redot.redot_server.domain.eventlog.repository;
+    import org.springframework.data.jpa.repository.JpaRepository;
+    import org.springframework.stereotype.Repository;
+    import redot.redot_server.domain.eventlog.entity.EventLogEntity;
+    @Repository
+    public interface EventLogRepository extends JpaRepository<EventLogEntity, Long> {
+    }

src/main/java/redot/redot_server/domain/eventlog/service/EventLogFlushScheduler.java

-Original file line number
+Diff line change
@@ -0,0 +1,135 @@
+    package redot.redot_server.domain.eventlog.service;
+    import com.fasterxml.jackson.databind.ObjectMapper;
+    import lombok.RequiredArgsConstructor;
+    import org.springframework.data.redis.core.StringRedisTemplate;
+    import org.springframework.scheduling.annotation.Scheduled;
+    import org.springframework.stereotype.Component;
+    import redot.redot_server.domain.eventlog.dto.PageViewCommand;
+    import redot.redot_server.domain.eventlog.entity.EventLogEntity;
+    import redot.redot_server.domain.eventlog.repository.EventLogRepository;
+    import java.util.ArrayList;
+    import java.util.List;
+    @Component
+    @RequiredArgsConstructor
+    public class EventLogFlushScheduler {
+        private final StringRedisTemplate stringRedisTemplate;
+        private final EventLogStore eventLogStore;
+        private final ObjectMapper objectMapper;
+        private final EventLogRepository repo;
+        // 한번에 최대 몇 개 flush할지
+        private static final int BATCH_SIZE = 2000;
+        /*
+            등록된 모든 redotAppId에 대해 Redis 버퍼에서 이벤트를 읽어와 DB에 저장
+         */
+        @Scheduled(cron = "0 */10 * * * *")
+        public void flushAllApps() {
+            List<Long> apps = eventLogStore.getRegisteredApps();
+            for (Long appId : apps) {
+                flushApp(appId);
+            }
+        }
+        /*
+            한 앱에 대해 Redis 버퍼에서 이벤트를 읽어와 DB에 저장
+        */
+        public void flushApp(Long redotAppId) {
+            String key = eventLogStore.bufferKey(redotAppId);
+            List<String> items = readBatch(key);
+            if (items.isEmpty()) {
+                eventLogStore.unregisterApp(redotAppId);
+                return;
+            }
+            List<EventLogEntity> entities = parseToEntities(redotAppId, items);
+            saveWithDlqFallback(redotAppId, entities);
+            trimProcessed(key, items.size());
+        }
+        /*
+            Redis에서 한 번에 BATCH_SIZE만큼 항목 읽기
+         */
+        private List<String> readBatch(String key) {
+            List<String> items = stringRedisTemplate.opsForList().range(key, 0, BATCH_SIZE - 1);
+            return (items == null) ? List.of() : items;
+        }
+        /*
+            JSON 문자열 목록을 EventLogEntity 목록으로 변환
+         */
+        private List<EventLogEntity> parseToEntities(Long redotAppId, List<String> items) {
+            List<EventLogEntity> entities = new ArrayList<>(items.size());
+            for (String json : items) {
+                try {
+                    PageViewCommand cmd = objectMapper.readValue(json, PageViewCommand.class);
+                    entities.add(EventLogEntity.pageView(
+                            cmd.eventId(),
+                            cmd.redotAppId(),
+                            cmd.deviceType(),
+                            cmd.ip(),
+                            cmd.occurredAt()
+                    ));
+                } catch (Exception e) {
+                    eventLogStore.pushDeadLetter(redotAppId, json, "PARSE_FAIL: " + e.getMessage());
+                }
+            }
+            return entities;
+        }
+        /*
+            여러 엔티티를 개별 저장하며 실패 시 DLQ로 이동
+         */
+        private void saveWithDlqFallback(Long redotAppId, List<EventLogEntity> entities) {
+            if (entities.isEmpty()) return;
+            try {
+                repo.saveAll(entities);
+            } catch (Exception e) {
+                saveIndividuallyWithDlq(redotAppId, entities);
+            }
+        }
+        /*
+            여러 엔티티를 개별 저장하며 실패 시 DLQ로 이동
+         */
+        private void saveIndividuallyWithDlq(Long redotAppId, List<EventLogEntity> entities) {
+            for (EventLogEntity entity : entities) {
+                try {
+                    repo.save(entity);
+                } catch (Exception ex) {
+                    eventLogStore.pushDeadLetter(
+                            redotAppId,
+                            safeToJson(entity),
+                            "DB_SAVE_FAIL: " + ex.getMessage()
+                    );
+                }
+            }
+        }
+        /*
+            Redis 리스트에서 앞의 processedCount개 항목 제거
+         */
+        private void trimProcessed(String key, int processedCount) {
+            stringRedisTemplate.opsForList().trim(key, processedCount, -1);
+        }
+        /*
+            EventLogEntity를 안전하게 JSON 문자열로 변환
+         */
+        private String safeToJson(EventLogEntity entity) {
+            try {
+                return objectMapper.writeValueAsString(entity);
+            } catch (Exception ignored) {
+                return String.valueOf(entity);
+            }
+        }
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature / EventLog #138

Uh oh!

Diff view

Diff view

There are no files selected for viewing

ryxxn Jan 19, 2026

Uh oh!

Uh oh!

Uh oh!

Feature / EventLog #138

Are you sure you want to change the base?

Uh oh!

Feature / EventLog #138

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

ryxxn Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!