[Spring Boot Actuator 추가] build.gradle에 Spring Boot Actuator 의존성 추가 및 README.md에 시스템 모니터링 관련 문서화. application.properties에 Actuator 설정 추가.
This commit is contained in:
25
README.md
25
README.md
@@ -163,6 +163,21 @@ public enum ApiResponseCode {
|
||||
- **URL**: `http://localhost:8080/service/swagger-ui.html`
|
||||
- **API Docs**: `http://localhost:8080/service/api-docs`
|
||||
|
||||
### 5. 시스템 모니터링 (Actuator)
|
||||
|
||||
#### Health 체크
|
||||
|
||||
- **기본 Health**: `http://localhost:8080/service/actuator/health`
|
||||
- **Readiness Probe**: `http://localhost:8080/service/actuator/health/readiness`
|
||||
- **Liveness Probe**: `http://localhost:8080/service/actuator/health/liveness`
|
||||
|
||||
#### 시스템 정보
|
||||
|
||||
- **애플리케이션 정보**: `http://localhost:8080/service/actuator/info`
|
||||
- **환경 설정**: `http://localhost:8080/service/actuator/env`
|
||||
- **설정 속성**: `http://localhost:8080/service/actuator/configprops`
|
||||
- **메트릭**: `http://localhost:8080/service/actuator/metrics`
|
||||
|
||||
#### 주요 어노테이션
|
||||
|
||||
```java
|
||||
@@ -182,7 +197,7 @@ public enum ApiResponseCode {
|
||||
- **SwaggerConfig.java**: OpenAPI 기본 정보 설정
|
||||
- **application.properties**: Swagger UI 커스터마이징
|
||||
|
||||
### 5. 트랜잭션 관리
|
||||
### 6. 트랜잭션 관리
|
||||
|
||||
#### 기본 설정
|
||||
|
||||
@@ -206,7 +221,7 @@ public class MemberServiceImpl {
|
||||
- **메서드별**: 데이터 수정 시에만 `@Transactional` 개별 적용
|
||||
- **설정**: `spring.jpa.open-in-view=false` (성능 최적화)
|
||||
|
||||
### 6. 오류 등록 및 사용
|
||||
### 7. 오류 등록 및 사용
|
||||
|
||||
#### 오류 코드 등록
|
||||
|
||||
@@ -233,7 +248,7 @@ throw new ApiException(ApiResponseCode.USER_ID_DUPLICATE);
|
||||
- **예외 클래스**: `ApiException`으로 비즈니스 로직 예외 처리
|
||||
- **자동 처리**: `GlobalExceptionHandler`가 일관된 응답 형태로 변환
|
||||
|
||||
### 7. 로깅 시스템
|
||||
### 8. 로깅 시스템
|
||||
|
||||
#### @LogExecution 어노테이션 사용법
|
||||
|
||||
@@ -287,7 +302,7 @@ public OrderDto processOrder() { }
|
||||
|
||||
**중요**: `@LogExecution` 어노테이션이 없으면 메서드 실행 로그가 출력되지 않습니다
|
||||
|
||||
### 8. MapStruct
|
||||
### 9. MapStruct
|
||||
|
||||
**매퍼 인터페이스**
|
||||
|
||||
@@ -311,7 +326,7 @@ Member entity = memberMapper.toEntity(dto);
|
||||
|
||||
**자동 생성**: 컴파일 시 `MemberMapperImpl` 구현체 생성
|
||||
|
||||
### 9. BaseEntity 상속
|
||||
### 10. BaseEntity 상속
|
||||
|
||||
**모든 엔티티는 `BaseEntity` 상속을 원칙으로 합니다.**
|
||||
|
||||
|
Reference in New Issue
Block a user