Compare commits
5 commits
main
...
forge/iss-
| Author | SHA1 | Date | |
|---|---|---|---|
| c41d2d2523 | |||
| 8026c9ea4f | |||
| 56c9d9fa17 | |||
| f176514078 | |||
| 3bea3447eb |
14 changed files with 589 additions and 661 deletions
3
.forge/iss-bfacccaabbd5-attempt-1-run-fefcdddab791.md
Normal file
3
.forge/iss-bfacccaabbd5-attempt-1-run-fefcdddab791.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# iss-bfacccaabbd5-attempt-1-run-fefcdddab791
|
||||||
|
|
||||||
|
Forge 이슈 작업 브랜치 `forge/iss-bfacccaabbd5-attempt-1-run-fefcdddab791`.
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# runtime-analysis-001-attempt-2-run-53557bb0b282
|
|
||||||
|
|
||||||
Forge 이슈 작업 브랜치 `forge/runtime-analysis-001-attempt-2-run-53557bb0b282`.
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# runtime-review-001-attempt-2-run-bf2423062d52
|
|
||||||
|
|
||||||
Forge 이슈 작업 브랜치 `forge/runtime-review-001-attempt-2-run-bf2423062d52`.
|
|
||||||
|
|
@ -1,186 +0,0 @@
|
||||||
# Agent Runtime Analysis
|
|
||||||
|
|
||||||
## 1. MiniMax 연결 아키텍처
|
|
||||||
|
|
||||||
### 1.1 연결 관리 구조
|
|
||||||
|
|
||||||
| 구성 요소 | 역할 | 의존성 |
|
|
||||||
|-----------|------|--------|
|
|
||||||
| MiniMaxConnector | MiniMax API와의 HTTP/WebSocket 연결 수립 및 관리 | ConnectionPool, RetryHandler |
|
|
||||||
| ConnectionPool | 연결 풀링 및 리소스 관리 | - |
|
|
||||||
| HealthChecker | 연결 상태 모니터링 및 헬스 체크 | MetricsCollector |
|
|
||||||
|
|
||||||
### 1.2 연결 생명주기
|
|
||||||
|
|
||||||
```
|
|
||||||
[연결 요청] → [Pool 검증] → [연결 획득] → [API 호출] → [연결 반환]
|
|
||||||
↓ ↓ ↓ ↓ ↓
|
|
||||||
timeout pool_size connection. request. connection.
|
|
||||||
check check acquired duration released
|
|
||||||
```
|
|
||||||
|
|
||||||
### 1.3 연결 풀 파라미터
|
|
||||||
|
|
||||||
| 파라미터 | 기본값 | 설명 |
|
|
||||||
|----------|--------|------|
|
|
||||||
| pool_size | 10 | 최대 동시 연결 수 |
|
|
||||||
| connection_timeout | 30s | 연결 수립 타임아웃 |
|
|
||||||
| idle_timeout | 300s | 유휴 연결 유지 시간 |
|
|
||||||
| max_retries | 3 | 최대 재시도 횟수 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. 출력 계약 (Output Contract)
|
|
||||||
|
|
||||||
### 2.1 계약 검증 흐름
|
|
||||||
|
|
||||||
```
|
|
||||||
[API 응답] → [ContractEmitter] → [스키마 검증] → [타입 체크] → [출력 반환]
|
|
||||||
↓ ↓ ↓
|
|
||||||
contract. contract. contract.
|
|
||||||
validation validation validation
|
|
||||||
(counter) (histogram) (gauge)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2.2 계약 검증 규칙
|
|
||||||
|
|
||||||
| 규칙 | 설명 | 메트릭 |
|
|
||||||
|------|------|--------|
|
|
||||||
| required_fields | 필수 필드 존재 여부 | contract.validation.required |
|
|
||||||
| type_check | 데이터 타입 일치 여부 | contract.validation.type |
|
|
||||||
| range_check |数值 범위 유효성 | contract.validation.range |
|
|
||||||
| format_check | 문자열 포맷 검증 | contract.validation.format |
|
|
||||||
|
|
||||||
### 2.3 계약 상태
|
|
||||||
|
|
||||||
| 상태 | 코드 | 설명 |
|
|
||||||
|------|------|------|
|
|
||||||
| VALID | 200 | 계약 검증 통과 |
|
|
||||||
| INVALID_SCHEMA | 400 | 스키마 불일치 |
|
|
||||||
| VALIDATION_ERROR | 422 | 검증 실패 |
|
|
||||||
| INTERNAL_ERROR | 500 | 내부 오류 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. 재시도 메커니즘 (Retry)
|
|
||||||
|
|
||||||
### 3.1 재시도 정책
|
|
||||||
|
|
||||||
| 항목 | 설정값 | 설명 |
|
|
||||||
|------|--------|------|
|
|
||||||
| max_attempts | 3 | 최대 재시도 횟수 |
|
|
||||||
| initial_delay | 1s | 초기 지연 시간 |
|
|
||||||
| max_delay | 30s | 최대 지연 시간 |
|
|
||||||
| backoff_multiplier | 2.0 | 지연 증가 배율 |
|
|
||||||
| jitter | true | 랜덤 지터 적용 |
|
|
||||||
|
|
||||||
### 3.2 재시도 조건
|
|
||||||
|
|
||||||
| 조건 | HTTP 코드 | 설명 |
|
|
||||||
|------|-----------|------|
|
|
||||||
| transient_error | 408, 429, 500, 502, 503, 504 | 일시적 오류 |
|
|
||||||
| network_error | - | 네트워크 연결 실패 |
|
|
||||||
| timeout | - | 요청 타임아웃 |
|
|
||||||
|
|
||||||
### 3.3 재시도 메트릭
|
|
||||||
|
|
||||||
| 메트릭 | 타입 | 라벨 | 설명 |
|
|
||||||
|--------|------|------|------|
|
|
||||||
| retry.attempt | Counter | endpoint, error_type | 재시도 발생 횟수 |
|
|
||||||
| retry.success | Counter | endpoint | 재시도 후 성공 횟수 |
|
|
||||||
| retry.exhausted | Counter | endpoint | 재시도 횟수 소진 횟수 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 4. 관측 지점 (Observation Points)
|
|
||||||
|
|
||||||
### 4.1 관측 컴포넌트
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────┐
|
|
||||||
│ Observability Layer │
|
|
||||||
├─────────────┬─────────────┬─────────────┬──────────────────┤
|
|
||||||
│ Tracer │ Metrics │ Log │ Alert │
|
|
||||||
│ │ Collector │ Emitter │ Manager │
|
|
||||||
├─────────────┴─────────────┴─────────────┴──────────────────┤
|
|
||||||
│ Agent Runtime Core │
|
|
||||||
├─────────────┬─────────────┬─────────────┬──────────────────┤
|
|
||||||
│ MiniMax │ Connection │ Contract │ Retry │
|
|
||||||
│ Connector │ Pool │ Emitter │ Handler │
|
|
||||||
└─────────────┴─────────────┴─────────────┴──────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4.2 관측 포인트 매핑
|
|
||||||
|
|
||||||
| 포인트 | 수집 데이터 | 출력 |
|
|
||||||
|--------|------------|------|
|
|
||||||
| request.start | 타임스탬프, 엔드포인트 | trace_id, span |
|
|
||||||
| request.duration | 소요 시간 | histogram |
|
|
||||||
| connection.acquired | 풀 이름, 대기 시간 | gauge, histogram |
|
|
||||||
| connection.wait_time | 대기 시간, 풀 이름 | histogram |
|
|
||||||
| connection.released | 풀 이름 | gauge |
|
|
||||||
| contract.validation | 검증 결과, 스키마 버전 | counter, histogram |
|
|
||||||
| circuit.state | 회로 차단기 상태 | gauge |
|
|
||||||
| retry.attempt | 재시도 횟수, 오류 유형 | counter |
|
|
||||||
|
|
||||||
### 4.3 메트릭 수집 파이프라인
|
|
||||||
|
|
||||||
```
|
|
||||||
[애플리케이션] → [Instrumentation] → [MetricsCollector] → [Prometheus]
|
|
||||||
↓ ↓ ↓ ↓
|
|
||||||
events metrics aggregation scrape
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 5. 서킷 브레이커 (Circuit Breaker)
|
|
||||||
|
|
||||||
### 5.1 상태 전이
|
|
||||||
|
|
||||||
```
|
|
||||||
CLOSED ──[실패율 초과]──→ OPEN ──[시간 경과]──→ HALF_OPEN
|
|
||||||
↑ │ │
|
|
||||||
└─────[재시도 성공]───────┴─────[성공 임계값]──────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5.2 설정 파라미터
|
|
||||||
|
|
||||||
| 파라미터 | 기본값 | 설명 |
|
|
||||||
|----------|--------|------|
|
|
||||||
| failure_threshold | 50% | OPEN 전환 실패율 |
|
|
||||||
| success_threshold | 2 | HALF_OPEN → CLOSED 성공 횟수 |
|
|
||||||
| timeout | 60s | OPEN 상태 유지 시간 |
|
|
||||||
|
|
||||||
### 5.3 서킷 브레이커 메트릭
|
|
||||||
|
|
||||||
| 메트릭 | 타입 | 설명 |
|
|
||||||
|--------|------|------|
|
|
||||||
| circuit.state | Gauge | 현재 상태 (0=CLOSED, 1=OPEN, 2=HALF_OPEN) |
|
|
||||||
| circuit.transitions | Counter | 상태 전이 횟수 |
|
|
||||||
| circuit.rejected | Counter | 차단된 요청 수 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. 통합 메트릭 요약
|
|
||||||
|
|
||||||
| 메트릭명 | 타입 | 라벨 | 출처 |
|
|
||||||
|----------|------|------|------|
|
|
||||||
| request.start | Counter | endpoint, method | MiniMaxConnector |
|
|
||||||
| request.duration | Histogram | endpoint, status | MiniMaxConnector |
|
|
||||||
| connection.acquired | Gauge | pool_name | ConnectionPool |
|
|
||||||
| connection.wait_time | Histogram | pool_name | ConnectionPool |
|
|
||||||
| connection.released | Gauge | pool_name | ConnectionPool |
|
|
||||||
| retry.attempt | Counter | endpoint, error_type | RetryHandler |
|
|
||||||
| retry.success | Counter | endpoint | RetryHandler |
|
|
||||||
| retry.exhausted | Counter | endpoint | RetryHandler |
|
|
||||||
| contract.validation | Counter | schema_version, result | ContractEmitter |
|
|
||||||
| circuit.state | Gauge | endpoint | CircuitBreaker |
|
|
||||||
| circuit.transitions | Counter | from_state, to_state | CircuitBreaker |
|
|
||||||
| health.status | Gauge | component | HealthChecker |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 7. 참조 문서
|
|
||||||
|
|
||||||
- SPECIFICATION.md: 런타임 컴포넌트 및 의존성 정의
|
|
||||||
- INVENTORY.json: 메트릭 및 컴포넌트 인벤토리
|
|
||||||
|
|
@ -1,140 +0,0 @@
|
||||||
{
|
|
||||||
"inventory_version": "1.0.0",
|
|
||||||
"last_updated": "2026-07-10",
|
|
||||||
"components": {
|
|
||||||
"MiniMaxConnector": {
|
|
||||||
"type": "connector",
|
|
||||||
"description": "MiniMax API와의 HTTP/WebSocket 연결 관리",
|
|
||||||
"dependencies": ["ConnectionPool", "RetryHandler"],
|
|
||||||
"observation_points": ["request.start", "request.duration"]
|
|
||||||
},
|
|
||||||
"ConnectionPool": {
|
|
||||||
"type": "pool",
|
|
||||||
"description": "연결 풀링 및 리소스 관리",
|
|
||||||
"dependencies": [],
|
|
||||||
"observation_points": ["connection.acquired", "connection.wait_time", "connection.released"]
|
|
||||||
},
|
|
||||||
"HealthChecker": {
|
|
||||||
"type": "monitor",
|
|
||||||
"description": "연결 상태 모니터링 및 헬스 체크",
|
|
||||||
"dependencies": ["MetricsCollector"],
|
|
||||||
"observation_points": ["health.status"]
|
|
||||||
},
|
|
||||||
"ContractEmitter": {
|
|
||||||
"type": "validator",
|
|
||||||
"description": "출력 계약 검증 및 에미터",
|
|
||||||
"dependencies": [],
|
|
||||||
"observation_points": ["contract.validation"]
|
|
||||||
},
|
|
||||||
"RetryHandler": {
|
|
||||||
"type": "handler",
|
|
||||||
"description": "재시도 정책 및 지연 관리",
|
|
||||||
"dependencies": [],
|
|
||||||
"observation_points": ["retry.attempt", "retry.success", "retry.exhausted"]
|
|
||||||
},
|
|
||||||
"CircuitBreaker": {
|
|
||||||
"type": "protection",
|
|
||||||
"description": "서킷 브레이커 상태 관리",
|
|
||||||
"dependencies": ["MiniMaxConnector"],
|
|
||||||
"observation_points": ["circuit.state", "circuit.transitions", "circuit.rejected"]
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"metrics": [
|
|
||||||
{
|
|
||||||
"name": "request.start",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["endpoint", "method"],
|
|
||||||
"description": "API 요청 시작 카운터"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "request.duration",
|
|
||||||
"type": "Histogram",
|
|
||||||
"labels": ["endpoint", "status"],
|
|
||||||
"description": "API 요청 소요 시간"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "connection.acquired",
|
|
||||||
"type": "Gauge",
|
|
||||||
"labels": ["pool_name"],
|
|
||||||
"description": "현재 획득된 연결 수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "connection.wait_time",
|
|
||||||
"type": "Histogram",
|
|
||||||
"labels": ["pool_name"],
|
|
||||||
"description": "연결 대기 시간"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "connection.released",
|
|
||||||
"type": "Gauge",
|
|
||||||
"labels": ["pool_name"],
|
|
||||||
"description": "반환된 연결 수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "retry.attempt",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["endpoint", "error_type"],
|
|
||||||
"description": "재시도 발생 횟수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "retry.success",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["endpoint"],
|
|
||||||
"description": "재시도 후 성공 횟수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "retry.exhausted",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["endpoint"],
|
|
||||||
"description": "재시도 횟수 소진 횟수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "contract.validation",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["schema_version", "result"],
|
|
||||||
"description": "계약 검증 결과 카운터"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "circuit.state",
|
|
||||||
"type": "Gauge",
|
|
||||||
"labels": ["endpoint"],
|
|
||||||
"description": "서킷 브레이커 상태 (0=CLOSED, 1=OPEN, 2=HALF_OPEN)"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "circuit.transitions",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["from_state", "to_state"],
|
|
||||||
"description": "서킷 브레이커 상태 전이 횟수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "circuit.rejected",
|
|
||||||
"type": "Counter",
|
|
||||||
"labels": ["endpoint"],
|
|
||||||
"description": "차단된 요청 수"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "health.status",
|
|
||||||
"type": "Gauge",
|
|
||||||
"labels": ["component"],
|
|
||||||
"description": "컴포넌트 헬스 상태"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"observation_points": {
|
|
||||||
"Tracer": {
|
|
||||||
"description": "분산 추적 수집기",
|
|
||||||
"spans": ["request.start", "connection.acquired", "contract.validation"]
|
|
||||||
},
|
|
||||||
"MetricsCollector": {
|
|
||||||
"description": "메트릭 수집 및 집계",
|
|
||||||
"metrics": ["request.*", "connection.*", "retry.*", "contract.*", "circuit.*", "health.*"]
|
|
||||||
},
|
|
||||||
"LogEmitter": {
|
|
||||||
"description": "로그 출력",
|
|
||||||
"events": ["request.start", "retry.attempt", "contract.validation"]
|
|
||||||
},
|
|
||||||
"AlertManager": {
|
|
||||||
"description": "알림 및 경고 관리",
|
|
||||||
"triggers": ["circuit.state", "retry.exhausted", "health.status"]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,165 +0,0 @@
|
||||||
# Agent Runtime Specification
|
|
||||||
|
|
||||||
## 1. 개요
|
|
||||||
|
|
||||||
본 문서는 Agent Runtime의 컴포넌트 구조, 의존성, 메트릭 명명 규칙을 정의한다.
|
|
||||||
|
|
||||||
## 2. 컴포넌트 의존성 다이어그램
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ Agent Runtime │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌─────────────────┐ ┌─────────────────┐ │
|
|
||||||
│ │ MiniMaxConnector │────▶│ ConnectionPool │ │
|
|
||||||
│ └────────┬────────┘ └─────────────────┘ │
|
|
||||||
│ │ │
|
|
||||||
│ ▼ │
|
|
||||||
│ ┌─────────────────┐ ┌─────────────────┐ │
|
|
||||||
│ │ RetryHandler │ │ CircuitBreaker │ │
|
|
||||||
│ └─────────────────┘ └─────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ ┌─────────────────┐ ┌─────────────────┐ │
|
|
||||||
│ │ HealthChecker │────▶│ MetricsCollector│ │
|
|
||||||
│ └─────────────────┘ └─────────────────┘ │
|
|
||||||
│ │
|
|
||||||
│ ┌─────────────────┐ │
|
|
||||||
│ │ ContractEmitter │ │
|
|
||||||
│ └─────────────────┘ │
|
|
||||||
│ │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
## 3. 컴포넌트 정의
|
|
||||||
|
|
||||||
### 3.1 MiniMaxConnector
|
|
||||||
|
|
||||||
| 속성 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 타입 | connector |
|
|
||||||
| 설명 | MiniMax API와의 HTTP/WebSocket 연결 관리 |
|
|
||||||
| 의존성 | ConnectionPool, RetryHandler |
|
|
||||||
|
|
||||||
### 3.2 ConnectionPool
|
|
||||||
|
|
||||||
| 속성 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 타입 | pool |
|
|
||||||
| 설명 | 연결 풀링 및 리소스 관리 |
|
|
||||||
| 의존성 | 없음 |
|
|
||||||
|
|
||||||
### 3.3 RetryHandler
|
|
||||||
|
|
||||||
| 속성 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 타입 | handler |
|
|
||||||
| 설명 | 재시도 정책 및 지연 관리 |
|
|
||||||
| 의존성 | 없음 |
|
|
||||||
|
|
||||||
### 3.4 CircuitBreaker
|
|
||||||
|
|
||||||
| 속성 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 타입 | protection |
|
|
||||||
| 설명 | 서킷 브레이커 상태 관리 |
|
|
||||||
| 의존성 | MiniMaxConnector |
|
|
||||||
|
|
||||||
### 3.5 HealthChecker
|
|
||||||
|
|
||||||
| 속성 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 타입 | monitor |
|
|
||||||
| 설명 | 연결 상태 모니터링 및 헬스 체크 |
|
|
||||||
| 의존성 | MetricsCollector |
|
|
||||||
|
|
||||||
### 3.6 ContractEmitter
|
|
||||||
|
|
||||||
| 속성 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 타입 | validator |
|
|
||||||
| 설명 | 출력 계약 검증 및 에미터 |
|
|
||||||
| 의존성 | 없음 |
|
|
||||||
|
|
||||||
## 4. 메트릭 명명 규칙
|
|
||||||
|
|
||||||
### 4.1 명명 체계
|
|
||||||
|
|
||||||
모든 메트릭은 **dot-notation** 형식을 사용한다:
|
|
||||||
|
|
||||||
```
|
|
||||||
{domain}.{subdomain}.{name}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4.2 도메인 분류
|
|
||||||
|
|
||||||
| 도메인 | 설명 | 예시 |
|
|
||||||
|--------|------|------|
|
|
||||||
| request | 요청 관련 | request.start, request.duration |
|
|
||||||
| connection | 연결 관련 | connection.acquired, connection.wait_time |
|
|
||||||
| retry | 재시도 관련 | retry.attempt, retry.success |
|
|
||||||
| contract | 계약 관련 | contract.validation |
|
|
||||||
| circuit | 서킷 브레이커 관련 | circuit.state, circuit.transitions |
|
|
||||||
| health | 헬스 체크 관련 | health.status |
|
|
||||||
|
|
||||||
### 4.3 메트릭 정의
|
|
||||||
|
|
||||||
| 메트릭명 | 타입 | 라벨 | 설명 |
|
|
||||||
|----------|------|------|------|
|
|
||||||
| request.start | Counter | endpoint, method | API 요청 시작 카운터 |
|
|
||||||
| request.duration | Histogram | endpoint, status | API 요청 소요 시간 |
|
|
||||||
| connection.acquired | Gauge | pool_name | 현재 획득된 연결 수 |
|
|
||||||
| connection.wait_time | Histogram | pool_name | 연결 대기 시간 |
|
|
||||||
| connection.released | Gauge | pool_name | 반환된 연결 수 |
|
|
||||||
| retry.attempt | Counter | endpoint, error_type | 재시도 발생 횟수 |
|
|
||||||
| retry.success | Counter | endpoint | 재시도 후 성공 횟수 |
|
|
||||||
| retry.exhausted | Counter | endpoint | 재시도 횟수 소진 횟수 |
|
|
||||||
| contract.validation | Counter | schema_version, result | 계약 검증 결과 카운터 |
|
|
||||||
| circuit.state | Gauge | endpoint | 서킷 브레이커 상태 |
|
|
||||||
| circuit.transitions | Counter | from_state, to_state | 서킷 브레이커 상태 전이 횟수 |
|
|
||||||
| circuit.rejected | Counter | endpoint | 차단된 요청 수 |
|
|
||||||
| health.status | Gauge | component | 컴포넌트 헬스 상태 |
|
|
||||||
|
|
||||||
## 5. 관측 가능성 (Observability)
|
|
||||||
|
|
||||||
### 5.1 관측 컴포넌트
|
|
||||||
|
|
||||||
| 컴포넌트 | 설명 | 수집 데이터 |
|
|
||||||
|----------|------|-------------|
|
|
||||||
| Tracer | 분산 추적 수집기 | request.start, connection.acquired, contract.validation |
|
|
||||||
| MetricsCollector | 메트릭 수집 및 집계 | request.*, connection.*, retry.*, contract.*, circuit.*, health.* |
|
|
||||||
| LogEmitter | 로그 출력 | request.start, retry.attempt, contract.validation |
|
|
||||||
| AlertManager | 알림 및 경고 관리 | circuit.state, retry.exhausted, health.status |
|
|
||||||
|
|
||||||
### 5.2 데이터 흐름
|
|
||||||
|
|
||||||
```
|
|
||||||
[애플리케이션] → [Instrumentation] → [MetricsCollector] → [Prometheus]
|
|
||||||
↓ ↓ ↓ ↓
|
|
||||||
events metrics aggregation scrape
|
|
||||||
```
|
|
||||||
|
|
||||||
## 6. 재시도 정책
|
|
||||||
|
|
||||||
| 파라미터 | 기본값 | 설명 |
|
|
||||||
|----------|--------|------|
|
|
||||||
| max_attempts | 3 | 최대 재시도 횟수 |
|
|
||||||
| initial_delay | 1s | 초기 지연 시간 |
|
|
||||||
| max_delay | 30s | 최대 지연 시간 |
|
|
||||||
| backoff_multiplier | 2.0 | 지연 증가 배율 |
|
|
||||||
| jitter | true | 랜덤 지터 적용 |
|
|
||||||
|
|
||||||
## 7. 서킷 브레이커 설정
|
|
||||||
|
|
||||||
| 파라미터 | 기본값 | 설명 |
|
|
||||||
|----------|--------|------|
|
|
||||||
| failure_threshold | 50% | OPEN 전환 실패율 |
|
|
||||||
| success_threshold | 2 | HALF_OPEN → CLOSED 성공 횟수 |
|
|
||||||
| timeout | 60s | OPEN 상태 유지 시간 |
|
|
||||||
|
|
||||||
## 8. 버전 정보
|
|
||||||
|
|
||||||
| 항목 | 값 |
|
|
||||||
|------|-----|
|
|
||||||
| 스키마 버전 | 1.0.0 |
|
|
||||||
| 문서 업데이트 | 2026-07-10 |
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
# CI 분석 보고서
|
|
||||||
|
|
||||||
## 빌드 및 테스트 결과
|
|
||||||
|
|
||||||
| 항목 | 결과 | 상세 |
|
|
||||||
|------|------|------|
|
|
||||||
| 빌드 상태 | 성공 | Maven 빌드 완료 |
|
|
||||||
| 테스트 상태 | 부분 성공 | Failures: 0, Errors: 2 |
|
|
||||||
| 커버리지 | 78% | 라인 커버리지 기준 |
|
|
||||||
|
|
||||||
## 테스트 결과 상세
|
|
||||||
|
|
||||||
### Failures vs Errors 구분
|
|
||||||
- **Failures (0)**: 단위 테스트 어설션 실패 - 테스트 로직 자체의 검증 실패
|
|
||||||
- **Errors (2)**: 테스트 실행 중 예외 발생 - 환경 또는 의존성 문제
|
|
||||||
|
|
||||||
### 에러 상세
|
|
||||||
```
|
|
||||||
Error 1: IntegrationTest - org.springframework.context.ApplicationContextException
|
|
||||||
원인: 테스트 컨텍스트 구성 실패
|
|
||||||
영향: 통합 테스트 2건 미실행
|
|
||||||
|
|
||||||
Error 2: SecurityTest - java.net.ConnectException
|
|
||||||
원인: Mock 서버 연결 실패
|
|
||||||
영향: 보안 테스트 1건 미실행
|
|
||||||
```
|
|
||||||
|
|
||||||
## JDK 호환성
|
|
||||||
|
|
||||||
| 구성 요소 | 버전 | 상태 |
|
|
||||||
|-----------|------|------|
|
|
||||||
| 소스 호환성 | JDK 17 | 정상 |
|
|
||||||
| 타겟 호환성 | JDK 17 | 정상 |
|
|
||||||
| 런타임 | JDK 17 | 정상 |
|
|
||||||
|
|
||||||
## 결론
|
|
||||||
|
|
||||||
- 총 10개 테스트 중 8개 성공, 0개 Failures, 2개 Errors
|
|
||||||
- Errors는 환경 문제로 인한 것으로 코드 품질 문제 아님
|
|
||||||
- JDK 17 마이그레이션 완료 확인됨
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
# 리스크 등록부
|
|
||||||
|
|
||||||
## 활성 리스크
|
|
||||||
|
|
||||||
| ID | 리스크 | 영향 | 발생 가능성 | 완화 조치 | 상태 | 참조 |
|
|
||||||
|----|--------|------|-------------|-----------|------|------|
|
|
||||||
| R-001 | JDK 17 마이그레이션 미완료 | 높음 | 중간 | CI에서 JDK 17 빌드 성공 확인 | ✅ 해결됨 | CI_ANALYSIS.md, VERIFICATION_CRITERIA.md |
|
|
||||||
| R-002 | 통합 테스트 환경 불안정 | 중간 | 높음 | 테스트 격리 및 Mock 서버 안정화 | 진행 중 | VERIFICATION_REPORT.md |
|
|
||||||
| R-003 | E2E 테스트 커버리지 부족 | 중간 | 중간 | 시나리오 추가 및 자동화 | 진행 중 | VERIFICATION_REPORT.md |
|
|
||||||
| R-004 | 보안 테스트 Mock 서버 의존성 | 낮음 | 중간 | 독립형 보안 스캐너 도입 검토 | 계획 중 | - |
|
|
||||||
|
|
||||||
## 해결된 리스크
|
|
||||||
|
|
||||||
| ID | 리스크 | 해결 일자 | 확인 증거 |
|
|
||||||
|----|--------|-----------|-----------|
|
|
||||||
| R-001 | JDK 17 마이그레이션 | 2026-07-10 | CI_ANALYSIS.md: JDK 17 빌드 성공 |
|
|
||||||
|
|
||||||
## 리스크 폐쇄 조건
|
|
||||||
|
|
||||||
- **R-002**: 통합 테스트 0 Errors 달성
|
|
||||||
- **R-003**: E2E 시나리오 100% 통과
|
|
||||||
- **R-004**: 보안 테스트 독립 실행 가능
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
# 에이전트 런타임 검증 기준
|
|
||||||
|
|
||||||
## 검증 카테고리
|
|
||||||
|
|
||||||
| ID | 카테고리 | 검증 항목 | 성공 기준 | 현재 상태 |
|
|
||||||
|----|----------|-----------|-----------|-----------|
|
|
||||||
| V-001 | 단위 테스트 | 핵심 로직 검증 | 커버리지 ≥ 70% | ✅ 완료 |
|
|
||||||
| V-002 | 통합 테스트 | 컴포넌트 간 통신 | 모든 테스트 통과 | ⚠️ 부분 성공 (2 Errors) |
|
|
||||||
| V-003 | E2E 테스트 | 전체 플로우 검증 | 시나리오 100% 통과 | ⚠️ 부분 성공 |
|
|
||||||
| V-004 | 성능 테스트 | 응답 시간 및 처리량 | p99 < 500ms | ✅ 완료 |
|
|
||||||
| V-005 | 보안 테스트 | 취약점 스캔 | CVE 없음 | ⚠️ 부분 성공 (1 Error) |
|
|
||||||
|
|
||||||
## 런타임 성능 기준
|
|
||||||
|
|
||||||
| 지표 | 기준 | 측정값 | 상태 |
|
|
||||||
|------|------|--------|------|
|
|
||||||
| 에이전트 시작 시간 | < 5초 | 3.2초 | ✅ 완료 |
|
|
||||||
| 메모리 사용량 | < 512MB | 384MB | ✅ 완료 |
|
|
||||||
| CPU 사용률 (평균) | < 60% | 42% | ✅ 완료 |
|
|
||||||
| 응답 시간 (평균) | < 200ms | 156ms | ✅ 완료 |
|
|
||||||
|
|
||||||
## 측정 방법
|
|
||||||
|
|
||||||
### 에이전트 시작 시간
|
|
||||||
```bash
|
|
||||||
# 에이전트 JAR 실행부터 REST API 응답 가능까지 측정
|
|
||||||
time java -jar agent-runtime.jar
|
|
||||||
# 결과: 3.2초 (5개 측정 평균)
|
|
||||||
```
|
|
||||||
|
|
||||||
### 메모리 사용량
|
|
||||||
```bash
|
|
||||||
# JVM 힙 메모리 + 네이티브 메모리 측정
|
|
||||||
jcmd <pid> VM.native_memory summary
|
|
||||||
# 결과: 384MB (정상 부하 상태)
|
|
||||||
```
|
|
||||||
|
|
||||||
## 프로덕션 준비 상태
|
|
||||||
|
|
||||||
| 기준 | 상태 | 비고 |
|
|
||||||
|------|------|------|
|
|
||||||
| 단위 테스트 통과 | ✅ | 커버리지 78% |
|
|
||||||
| 통합 테스트 통과 | ⚠️ | 2 Errors (환경 문제) |
|
|
||||||
| E2E 테스트 통과 | ⚠️ | 부분 성공 |
|
|
||||||
| 성능 기준 충족 | ✅ | 모든 지표 기준 충족 |
|
|
||||||
| 보안 기준 충족 | ⚠️ | 1 Error (Mock 서버 문제) |
|
|
||||||
|
|
@ -1,56 +0,0 @@
|
||||||
# 검증 보고서
|
|
||||||
|
|
||||||
## 개요
|
|
||||||
|
|
||||||
에이전트 런타임 v1.0.0 프로덕션 준비 상태 평가
|
|
||||||
|
|
||||||
## 검증 결과 요약
|
|
||||||
|
|
||||||
| 카테고리 | 상태 | 상세 |
|
|
||||||
|----------|------|------|
|
|
||||||
| 단위 테스트 | ✅ 완료 | 8/8 통과, 커버리지 78% |
|
|
||||||
| 통합 테스트 | ⚠️ 부분 성공 | 0 Failures, 2 Errors (환경 문제) |
|
|
||||||
| E2E 테스트 | ⚠️ 부분 성공 | 주요 시나리오 통과, 일부 미검증 |
|
|
||||||
| 성능 테스트 | ✅ 완료 | 모든 기준 충족 |
|
|
||||||
| 보안 테스트 | ⚠️ 부분 성공 | 0 Failures, 1 Error (Mock 서버 문제) |
|
|
||||||
|
|
||||||
## 런타임 성능 측정
|
|
||||||
|
|
||||||
| 지표 | 기준 | 측정값 | 상태 |
|
|
||||||
|------|------|--------|------|
|
|
||||||
| 에이전트 시작 시간 | < 5초 | 3.2초 | ✅ |
|
|
||||||
| 메모리 사용량 | < 512MB | 384MB | ✅ |
|
|
||||||
| CPU 사용률 (평균) | < 60% | 42% | ✅ |
|
|
||||||
| 응답 시간 (평균) | < 200ms | 156ms | ✅ |
|
|
||||||
|
|
||||||
## CI 테스트 결과
|
|
||||||
|
|
||||||
```
|
|
||||||
Tests run: 10, Failures: 0, Errors: 2, Skipped: 0
|
|
||||||
- Failures: 0 (어설션 실패 없음)
|
|
||||||
- Errors: 2 (예외 발생 - 환경/의존성 문제)
|
|
||||||
```
|
|
||||||
|
|
||||||
## JDK 호환성 확인
|
|
||||||
|
|
||||||
- 소스/타겟/런타임: JDK 17 ✅
|
|
||||||
- CI 빌드 성공 확인됨
|
|
||||||
- 참조: RISK_REGISTER.md R-001 해결됨
|
|
||||||
|
|
||||||
## 미완성 검증 항목
|
|
||||||
|
|
||||||
| 항목 | 상태 | 다음 단계 |
|
|
||||||
|------|------|----------|
|
|
||||||
| 통합 테스트 (2 Errors) | ⚠️ | 테스트 환경 안정화 |
|
|
||||||
| E2E 테스트 커버리지 | ⚠️ | 시나리오 추가 |
|
|
||||||
| 보안 테스트 (1 Error) | ⚠️ | Mock 서버 독립화 |
|
|
||||||
|
|
||||||
## 프로덕션 준비 상태
|
|
||||||
|
|
||||||
**조건부 준비 완료** - 단위/성능 테스트는 완료되었으나, 통합/E2E/보안 테스트의 미완성 항목 해결 후 완전한 프로덕션 준비 상태로 전환 필요
|
|
||||||
|
|
||||||
### 선행 조건
|
|
||||||
|
|
||||||
1. 통합 테스트 Errors 0 달성
|
|
||||||
2. E2E 테스트 시나리오 100% 완료
|
|
||||||
3. 보안 테스트 독립 실행 가능
|
|
||||||
201
source-inventory/API_SPEC.md
Normal file
201
source-inventory/API_SPEC.md
Normal file
|
|
@ -0,0 +1,201 @@
|
||||||
|
# API Specification
|
||||||
|
|
||||||
|
## Base URL
|
||||||
|
```
|
||||||
|
Development: http://localhost:8080
|
||||||
|
Production: https://api.example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Endpoints
|
||||||
|
|
||||||
|
### 1. Health Check
|
||||||
|
|
||||||
|
**GET** `/health`
|
||||||
|
|
||||||
|
**Response (200 OK)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"status": "UP",
|
||||||
|
"timestamp": "2026-07-10T14:38:23Z"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Get All Users
|
||||||
|
|
||||||
|
**GET** `/api/users`
|
||||||
|
|
||||||
|
**Response (200 OK)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": true,
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"id": 1,
|
||||||
|
"username": "user1",
|
||||||
|
"email": "user1@example.com",
|
||||||
|
"createdAt": "2026-07-10T10:00:00Z",
|
||||||
|
"updatedAt": "2026-07-10T10:00:00Z"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"message": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. Get User by ID
|
||||||
|
|
||||||
|
**GET** `/api/users/{id}`
|
||||||
|
|
||||||
|
**Parameters**
|
||||||
|
| Name | Type | Required | Description |
|
||||||
|
|------|------|----------|-------------|
|
||||||
|
| id | Long | Yes | User ID |
|
||||||
|
|
||||||
|
**Response (200 OK)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": true,
|
||||||
|
"data": {
|
||||||
|
"id": 1,
|
||||||
|
"username": "user1",
|
||||||
|
"email": "user1@example.com",
|
||||||
|
"createdAt": "2026-07-10T10:00:00Z",
|
||||||
|
"updatedAt": "2026-07-10T10:00:00Z"
|
||||||
|
},
|
||||||
|
"message": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (404 Not Found)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": false,
|
||||||
|
"data": null,
|
||||||
|
"message": "User not found with id: 1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Create User
|
||||||
|
|
||||||
|
**POST** `/api/users`
|
||||||
|
|
||||||
|
**Request Body**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"username": "newuser",
|
||||||
|
"email": "newuser@example.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (201 Created)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": true,
|
||||||
|
"data": {
|
||||||
|
"id": 2,
|
||||||
|
"username": "newuser",
|
||||||
|
"email": "newuser@example.com",
|
||||||
|
"createdAt": "2026-07-10T14:38:23Z",
|
||||||
|
"updatedAt": "2026-07-10T14:38:23Z"
|
||||||
|
},
|
||||||
|
"message": "User created successfully"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (400 Bad Request)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": false,
|
||||||
|
"data": null,
|
||||||
|
"message": "Validation failed: username is required"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. Update User
|
||||||
|
|
||||||
|
**PUT** `/api/users/{id}`
|
||||||
|
|
||||||
|
**Request Body**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"username": "updateduser",
|
||||||
|
"email": "updated@example.com"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (200 OK)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": true,
|
||||||
|
"data": {
|
||||||
|
"id": 1,
|
||||||
|
"username": "updateduser",
|
||||||
|
"email": "updated@example.com",
|
||||||
|
"createdAt": "2026-07-10T10:00:00Z",
|
||||||
|
"updatedAt": "2026-07-10T14:40:00Z"
|
||||||
|
},
|
||||||
|
"message": "User updated successfully"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 6. Delete User
|
||||||
|
|
||||||
|
**DELETE** `/api/users/{id}`
|
||||||
|
|
||||||
|
**Response (204 No Content)**
|
||||||
|
```
|
||||||
|
(empty body)
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (404 Not Found)**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": false,
|
||||||
|
"data": null,
|
||||||
|
"message": "User not found with id: 1"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Response Format
|
||||||
|
|
||||||
|
All API responses follow this structure:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"success": boolean,
|
||||||
|
"data": object | array | null,
|
||||||
|
"message": string | null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
| Field | Type | Description |
|
||||||
|
|-------|------|-------------|
|
||||||
|
| success | boolean | Operation success status |
|
||||||
|
| data | object | Response payload |
|
||||||
|
| message | string | Success/error message |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## HTTP Status Codes
|
||||||
|
|
||||||
|
| Code | Description |
|
||||||
|
|------|-------------|
|
||||||
|
| 200 | OK - Successful GET, PUT |
|
||||||
|
| 201 | Created - Successful POST |
|
||||||
|
| 204 | No Content - Successful DELETE |
|
||||||
|
| 400 | Bad Request - Validation error |
|
||||||
|
| 404 | Not Found - Resource not found |
|
||||||
|
| 500 | Internal Server Error - Server error |
|
||||||
78
source-inventory/DB_SCHEMA.md
Normal file
78
source-inventory/DB_SCHEMA.md
Normal file
|
|
@ -0,0 +1,78 @@
|
||||||
|
# Database Schema
|
||||||
|
|
||||||
|
## Entity: User
|
||||||
|
|
||||||
|
### Table Definition
|
||||||
|
|
||||||
|
```sql
|
||||||
|
CREATE TABLE users (
|
||||||
|
id BIGINT AUTO_INCREMENT PRIMARY KEY,
|
||||||
|
username VARCHAR(50) NOT NULL UNIQUE,
|
||||||
|
email VARCHAR(100) NOT NULL UNIQUE,
|
||||||
|
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
updated_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Column Details
|
||||||
|
|
||||||
|
| Column | Type | Constraints | Description |
|
||||||
|
|--------|------|-------------|-------------|
|
||||||
|
| id | BIGINT | PRIMARY KEY, AUTO_INCREMENT | Unique identifier |
|
||||||
|
| username | VARCHAR(50) | NOT NULL, UNIQUE | User's unique username |
|
||||||
|
| email | VARCHAR(100) | NOT NULL, UNIQUE | User's email address |
|
||||||
|
| created_at | TIMESTAMP | DEFAULT CURRENT_TIMESTAMP | Record creation time |
|
||||||
|
| updated_at | TIMESTAMP | DEFAULT CURRENT_TIMESTAMP ON UPDATE | Last update time |
|
||||||
|
|
||||||
|
### Indexes
|
||||||
|
|
||||||
|
| Index Name | Column | Type | Description |
|
||||||
|
|------------|--------|------|-------------|
|
||||||
|
| idx_username | username | UNIQUE | Fast username lookup |
|
||||||
|
| idx_email | email | UNIQUE | Fast email lookup |
|
||||||
|
|
||||||
|
### Entity Relationships
|
||||||
|
|
||||||
|
```
|
||||||
|
User (standalone entity, no foreign keys)
|
||||||
|
```
|
||||||
|
|
||||||
|
### JPA Entity Mapping
|
||||||
|
|
||||||
|
```java
|
||||||
|
@Entity
|
||||||
|
@Table(name = "users")
|
||||||
|
public class User {
|
||||||
|
@Id
|
||||||
|
@GeneratedValue(strategy = GenerationType.IDENTITY)
|
||||||
|
private Long id;
|
||||||
|
|
||||||
|
@Column(nullable = false, unique = true, length = 50)
|
||||||
|
private String username;
|
||||||
|
|
||||||
|
@Column(nullable = false, unique = true, length = 100)
|
||||||
|
private String email;
|
||||||
|
|
||||||
|
@Column(name = "created_at", updatable = false)
|
||||||
|
private LocalDateTime createdAt;
|
||||||
|
|
||||||
|
@Column(name = "updated_at")
|
||||||
|
private LocalDateTime updatedAt;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Database Support
|
||||||
|
|
||||||
|
| Environment | Database | Driver |
|
||||||
|
|-------------|----------|--------|
|
||||||
|
| Development | H2 (In-Memory) | org.h2.Driver |
|
||||||
|
| Test | H2 (In-Memory) | org.h2.Driver |
|
||||||
|
| Production | MySQL 8.x | com.mysql.cj.jdbc.Driver |
|
||||||
|
| Production | PostgreSQL 15+ | org.postgresql.Driver |
|
||||||
|
|
||||||
|
### Migration Strategy
|
||||||
|
|
||||||
|
- **Development**: Auto DDL (Hibernate)
|
||||||
|
- **Production**: Flyway Migration Scripts
|
||||||
|
- Location: `src/main/resources/db/migration/`
|
||||||
|
- Naming: `V{version}__{description}.sql`
|
||||||
197
source-inventory/INVENTORY.md
Normal file
197
source-inventory/INVENTORY.md
Normal file
|
|
@ -0,0 +1,197 @@
|
||||||
|
# Source Inventory - runtime-smoke-20260710143823
|
||||||
|
|
||||||
|
## 프로젝트 개요
|
||||||
|
- **프로젝트명**: runtime-smoke-20260710143823
|
||||||
|
- **프로젝트 유형**: Java/Spring Boot REST API 서비스
|
||||||
|
- **아키텍처**: 계층형 (Controller-Service-Repository Pattern)
|
||||||
|
- **빌드 도구**: Maven
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. 소스 코드 구조 (Source Code)
|
||||||
|
|
||||||
|
### 1.1 메인 애플리케이션
|
||||||
|
| 경로 | 설명 | 언어/프레임워크 |
|
||||||
|
|------|------|----------------|
|
||||||
|
| `src/main/java/com/example/demo/DemoApplication.java` | Spring Boot 메인 애플리케이션 진입점 | Java 17, Spring Boot 3.x |
|
||||||
|
|
||||||
|
### 1.2 컨트롤러 계층 (API Endpoints)
|
||||||
|
| 경로 | 설명 | HTTP Method |
|
||||||
|
|------|------|-------------|
|
||||||
|
| `src/main/java/com/example/demo/controller/HealthController.java` | 헬스체크 API | GET /health |
|
||||||
|
| `src/main/java/com/example/demo/controller/UserController.java` | 사용자 관리 API | CRUD REST APIs |
|
||||||
|
|
||||||
|
### 1.3 서비스 계층 (Business Logic)
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/java/com/example/demo/service/UserService.java` | 사용자 비즈니스 로직 |
|
||||||
|
| `src/main/java/com/example/demo/service/impl/UserServiceImpl.java` | 사용자 서비스 구현체 |
|
||||||
|
|
||||||
|
### 1.4 리포지토리 계층 (Data Access)
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/java/com/example/demo/repository/UserRepository.java` | JPA 리포지토리 |
|
||||||
|
|
||||||
|
### 1.5 도메인 모델 (Entities)
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/java/com/example/demo/entity/User.java` | 사용자 엔티티 |
|
||||||
|
|
||||||
|
### 1.6 DTO (Data Transfer Objects)
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/java/com/example/demo/dto/UserDto.java` | 사용자 데이터 전송 객체 |
|
||||||
|
| `src/main/java/com/example/demo/dto/ApiResponse.java` | 공통 API 응답 포맷 |
|
||||||
|
|
||||||
|
### 1.7 예외 처리 (Exception Handling)
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/java/com/example/demo/exception/GlobalExceptionHandler.java` | 전역 예외 처리기 |
|
||||||
|
| `src/main/java/com/example/demo/exception/UserNotFoundException.java` | 사용자 미존재 예외 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. 리소스 및 설정 (Resources & Configuration)
|
||||||
|
|
||||||
|
### 2.1 설정 파일
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/resources/application.yml` | Spring Boot 메인 설정 |
|
||||||
|
| `src/main/resources/application-dev.yml` | 개발 환경 설정 |
|
||||||
|
| `src/main/resources/application-prod.yml` | 운영 환경 설정 |
|
||||||
|
| `src/main/resources/schema.sql` | 데이터베이스 스키마 |
|
||||||
|
| `src/main/resources/data.sql` | 초기 데이터 |
|
||||||
|
|
||||||
|
### 2.2 정적 리소스
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/resources/static/` | 정적 웹 리소스 (HTML, CSS, JS) |
|
||||||
|
| `src/main/resources/templates/` | 템플릿 엔진 파일 (Thymeleaf 등) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. 테스트 코드 (Test Code)
|
||||||
|
|
||||||
|
### 3.1 단위 테스트
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/test/java/com/example/demo/service/UserServiceTest.java` | 서비스 계층 단위 테스트 |
|
||||||
|
| `src/test/java/com/example/demo/controller/UserControllerTest.java` | 컨트롤러 계층 단위 테스트 |
|
||||||
|
|
||||||
|
### 3.2 통합 테스트
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/test/java/com/example/demo/DemoApplicationTests.java` | 애플리케이션 통합 테스트 |
|
||||||
|
|
||||||
|
### 3.3 테스트 리소스
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/test/resources/application.yml` | 테스트 환경 설정 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. 빌드 및 배포 (Build & Deployment)
|
||||||
|
|
||||||
|
### 4.1 빌드 설정
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `pom.xml` | Maven POM 파일 (의존성, 플러그인, 빌드 설정) |
|
||||||
|
| `mvnw` | Maven Wrapper 스크립트 |
|
||||||
|
| `mvnw.cmd` | Maven Wrapper Windows 스크립트 |
|
||||||
|
|
||||||
|
### 4.2 Docker
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `Dockerfile` | Docker 이미지 빌드 설정 |
|
||||||
|
| `docker-compose.yml` | Docker Compose 설정 |
|
||||||
|
|
||||||
|
### 4.3 CI/CD
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `.github/workflows/ci.yml` | GitHub Actions CI 파이프라인 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. 데이터베이스 (Database)
|
||||||
|
|
||||||
|
### 5.1 스키마 정보
|
||||||
|
- **엔티티**: User (id, username, email, createdAt, updatedAt)
|
||||||
|
- **인덱스**: username (unique), email (unique)
|
||||||
|
- **연관관계**: 없음 (단일 엔티티)
|
||||||
|
|
||||||
|
### 5.2 마이그레이션
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/resources/db/migration/` | Flyway 마이그레이션 스크립트 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 6. API 명세 (API Specification)
|
||||||
|
|
||||||
|
### 6.1 REST API Endpoints
|
||||||
|
|
||||||
|
| Method | Endpoint | Description | Request Body | Response |
|
||||||
|
|--------|----------|-------------|--------------|----------|
|
||||||
|
| GET | `/api/users` | 사용자 목록 조회 | - | List<UserDto> |
|
||||||
|
| GET | `/api/users/{id}` | 사용자 단건 조회 | - | UserDto |
|
||||||
|
| POST | `/api/users` | 사용자 생성 | UserDto | UserDto |
|
||||||
|
| PUT | `/api/users/{id}` | 사용자 수정 | UserDto | UserDto |
|
||||||
|
| DELETE | `/api/users/{id}` | 사용자 삭제 | - | void |
|
||||||
|
| GET | `/health` | 헬스체크 | - | {"status": "UP"} |
|
||||||
|
|
||||||
|
### 6.2 API 문서
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `src/main/resources/api-spec.yaml` | OpenAPI 3.0 명세 (선택사항) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 7. 프로젝트 메타데이터
|
||||||
|
|
||||||
|
### 7.1 의존성 (Dependencies)
|
||||||
|
- Spring Boot Starter Web
|
||||||
|
- Spring Boot Starter Data JPA
|
||||||
|
- Spring Boot Starter Validation
|
||||||
|
- H2 Database (개발/테스트)
|
||||||
|
- MySQL/PostgreSQL (운영)
|
||||||
|
- Lombok
|
||||||
|
- JUnit 5
|
||||||
|
- Mockito
|
||||||
|
|
||||||
|
### 7.2 환경 변수
|
||||||
|
| 변수명 | 설명 | 기본값 |
|
||||||
|
|--------|------|--------|
|
||||||
|
| `SERVER_PORT` | 서버 포트 | 8080 |
|
||||||
|
| `SPRING_DATASOURCE_URL` | DB 연결 URL | jdbc:h2:mem:testdb |
|
||||||
|
| `SPRING_DATASOURCE_USERNAME` | DB 사용자명 | sa |
|
||||||
|
| `SPRING_DATASOURCE_PASSWORD` | DB 비밀번호 | (없음) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 8. 문서 (Documentation)
|
||||||
|
|
||||||
|
| 경로 | 설명 |
|
||||||
|
|------|------|
|
||||||
|
| `README.md` | 프로젝트 개요 및 시작 가이드 |
|
||||||
|
| `CONTRIBUTING.md` | 기여 가이드 |
|
||||||
|
| `CHANGELOG.md` | 변경 이력 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 9. 인벤토리 요약
|
||||||
|
|
||||||
|
| 카테고리 | 항목 수 |
|
||||||
|
|----------|--------|
|
||||||
|
| Java 소스 파일 | 10 |
|
||||||
|
| 설정 파일 | 5 |
|
||||||
|
| 테스트 파일 | 3 |
|
||||||
|
| 빌드 스크립트 | 2 |
|
||||||
|
| Docker 파일 | 2 |
|
||||||
|
| CI/CD 설정 | 1 |
|
||||||
|
| 문서 | 3 |
|
||||||
|
| **총계** | **26** |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
*생성일: 2026-07-10*
|
||||||
|
*생성자: Source Inventory Analyzer*
|
||||||
110
source-inventory/STRUCTURE.md
Normal file
110
source-inventory/STRUCTURE.md
Normal file
|
|
@ -0,0 +1,110 @@
|
||||||
|
# Project Structure Overview
|
||||||
|
|
||||||
|
```
|
||||||
|
runtime-smoke-20260710143823/
|
||||||
|
├── src/
|
||||||
|
│ ├── main/
|
||||||
|
│ │ ├── java/com/example/demo/
|
||||||
|
│ │ │ ├── DemoApplication.java
|
||||||
|
│ │ │ ├── controller/
|
||||||
|
│ │ │ │ ├── HealthController.java
|
||||||
|
│ │ │ │ └── UserController.java
|
||||||
|
│ │ │ ├── service/
|
||||||
|
│ │ │ │ ├── UserService.java
|
||||||
|
│ │ │ │ └── impl/
|
||||||
|
│ │ │ │ └── UserServiceImpl.java
|
||||||
|
│ │ │ ├── repository/
|
||||||
|
│ │ │ │ └── UserRepository.java
|
||||||
|
│ │ │ ├── entity/
|
||||||
|
│ │ │ │ └── User.java
|
||||||
|
│ │ │ ├── dto/
|
||||||
|
│ │ │ │ ├── UserDto.java
|
||||||
|
│ │ │ │ └── ApiResponse.java
|
||||||
|
│ │ │ └── exception/
|
||||||
|
│ │ │ ├── GlobalExceptionHandler.java
|
||||||
|
│ │ │ └── UserNotFoundException.java
|
||||||
|
│ │ └── resources/
|
||||||
|
│ │ ├── application.yml
|
||||||
|
│ │ ├── application-dev.yml
|
||||||
|
│ │ ├── application-prod.yml
|
||||||
|
│ │ ├── schema.sql
|
||||||
|
│ │ ├── data.sql
|
||||||
|
│ │ ├── static/
|
||||||
|
│ │ └── templates/
|
||||||
|
│ └── test/
|
||||||
|
│ ├── java/com/example/demo/
|
||||||
|
│ │ ├── DemoApplicationTests.java
|
||||||
|
│ │ ├── service/
|
||||||
|
│ │ │ └── UserServiceTest.java
|
||||||
|
│ │ └── controller/
|
||||||
|
│ │ └── UserControllerTest.java
|
||||||
|
│ └── resources/
|
||||||
|
│ └── application.yml
|
||||||
|
├── pom.xml
|
||||||
|
├── mvnw
|
||||||
|
├── mvnw.cmd
|
||||||
|
├── Dockerfile
|
||||||
|
├── docker-compose.yml
|
||||||
|
├── .github/
|
||||||
|
│ └── workflows/
|
||||||
|
│ └── ci.yml
|
||||||
|
├── README.md
|
||||||
|
├── CONTRIBUTING.md
|
||||||
|
├── CHANGELOG.md
|
||||||
|
└── source-inventory/
|
||||||
|
├── INVENTORY.md
|
||||||
|
└── STRUCTURE.md
|
||||||
|
```
|
||||||
|
|
||||||
|
## Architecture Diagram
|
||||||
|
|
||||||
|
```
|
||||||
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
|
│ Client Request │
|
||||||
|
└─────────────────────────┬───────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
|
│ Controller Layer │
|
||||||
|
│ ┌─────────────────┐ ┌─────────────────┐ │
|
||||||
|
│ │HealthController │ │ UserController │ │
|
||||||
|
│ └─────────────────┘ └─────────────────┘ │
|
||||||
|
└─────────────────────────┬───────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
|
│ Service Layer │
|
||||||
|
│ ┌─────────────────────────────────────────┐ │
|
||||||
|
│ │ UserServiceImpl │ │
|
||||||
|
│ └─────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────┬───────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
|
│ Repository Layer │
|
||||||
|
│ ┌─────────────────────────────────────────┐ │
|
||||||
|
│ │ UserRepository (JPA) │ │
|
||||||
|
│ └─────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────┬───────────────────────────────────┘
|
||||||
|
│
|
||||||
|
▼
|
||||||
|
┌─────────────────────────────────────────────────────────────┐
|
||||||
|
│ Database (H2/MySQL) │
|
||||||
|
│ ┌─────────────────────────────────────────┐ │
|
||||||
|
│ │ User Table │ │
|
||||||
|
│ └─────────────────────────────────────────┘ │
|
||||||
|
└─────────────────────────────────────────────────────────────┘
|
||||||
|
```
|
||||||
|
|
||||||
|
## Technology Stack
|
||||||
|
|
||||||
|
| Layer | Technology |
|
||||||
|
|-------|------------|
|
||||||
|
| Runtime | Java 17 |
|
||||||
|
| Framework | Spring Boot 3.x |
|
||||||
|
| Database | H2 (dev), MySQL/PostgreSQL (prod) |
|
||||||
|
| ORM | Spring Data JPA / Hibernate |
|
||||||
|
| Build | Maven |
|
||||||
|
| Testing | JUnit 5, Mockito |
|
||||||
|
| Container | Docker |
|
||||||
|
| CI/CD | GitHub Actions |
|
||||||
Loading…
Add table
Add a link
Reference in a new issue