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.

Sign up for GitHub

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

[IDLE-456] prometheus, grafana 설정을 위한 monitoring.yml 설정 #250

Merged
merged 1 commit into from
Nov 22, 2024
Merged

[IDLE-456] prometheus, grafana 설정을 위한 monitoring.yml 설정 #250

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 1 addition & 14 deletions idle-infrastructure/monitoring/src/main/resources/application-monitoring.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,5 @@
management:
endpoints:
health:
enabled: true
prometheus:
enabled: true
metrics:
enabled: true

web:
exposure:
include: health, prometheus, metrics
base-path: ${ACTUATOR_BASE_PATH}
jmx:
exposure:
exclude: "*"
server:
port: 9900
include: "*"
Copy link

@coderabbitai coderabbitai bot Nov 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

💡 Codebase verification

⚠️ Potential issue

보안 위험: 모니터링 엔드포인트 설정 재검토 필요

검증 결과, 현재 설정에서 다음과 같은 중요한 보안 문제가 확인되었습니다:

  1. application-monitoring.yml에서 "*" 와일드카드를 사용하여 모든 액추에이터 엔드포인트가 노출되어 있습니다.
  2. 프로젝트에서 Prometheus 메트릭(micrometer-registry-prometheus) 의존성만 확인되었으므로, 실제로 필요한 엔드포인트는 제한적입니다.

다음과 같이 수정하는 것을 강력히 권장드립니다:

management:
  endpoints:
    web:
      exposure:
        include: "health,prometheus,metrics,info"

이는 모니터링에 필수적인 엔드포인트만 노출하여 보안 위험을 최소화합니다.

🔗 Analysis chain

보안 위험: 모든 액추에이터 엔드포인트 노출 검토 필요

와일드카드("*")를 사용하여 모든 액추에이터 엔드포인트를 노출하는 것은 잠재적인 보안 위험을 초래할 수 있습니다. /env, /heapdump와 같은 민감한 엔드포인트가 노출될 수 있습니다.

Prometheus와 Grafana 모니터링에 실제로 필요한 엔드포인트만 명시적으로 나열하는 것을 권장드립니다:

-        include: "*"
+        include: "health,prometheus,metrics"

현재 설정된 엔드포인트 목록을 확인하기 위해 다음 스크립트를 실행하세요:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: 현재 프로젝트에서 사용 중인 액추에이터 엔드포인트 확인

# application.yml 또는 application-*.yml 파일에서 actuator 관련 설정 검색
echo "액추에이터 관련 설정 확인:"
rg -l "management.endpoints" 

# 프로메테우스 메트릭 수집 관련 코드 검색
echo -e "\n프로메테우스 메트릭 사용 코드 확인:"
rg "@Timed|@Counted|@Gauge"

Length of output: 156

Script:

#!/bin/bash
# 모니터링 관련 설정 파일들을 검색
echo "모니터링 설정 파일 확인:"
fd -e yml -e yaml -e properties | xargs cat

# Spring Boot Actuator 관련 의존성 확인
echo -e "\nActuator 의존성 확인:"
fd pom.xml | xargs grep -l "spring-boot-starter-actuator"

# 메트릭 수집 관련 코드 검색 (다른 어노테이션 포함)
echo -e "\n메트릭 관련 코드 확인:"
rg "io\.micrometer|io\.prometheus"

Length of output: 6111

Copy link
Contributor Author

Choose a reason for hiding this comment

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

우선 연결 테스트 후에 다시 조정할게! 코멘트 고마워

Copy link

Choose a reason for hiding this comment

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

@wonjunYou, 네, 알겠습니다. 연결 테스트 후에 조정하시면 됩니다! 도움이 되셨다니 기쁩니다.

(\( ˆ‿ˆ )/)

Loading