[ECS] 환경변수 - Neo4j 드라이버 URI 설정 문제 해결

Neo4j 드라이버 URI 설정 문제 해결

AS-IS

문제 상황

Django 애플리케이션에서 Neo4j 드라이버를 초기화하는 과정에서 다음과 같은 문제가 발생했습니다:

• 환경 변수 NEO4J_BOLT_URI에 잘못된 값이 전달되어 neo4j.exceptions.ConfigurationError 발생.
• 환경 변수 값에 불필요한 따옴표(" 또는 ')가 포함되어 URI 값이 올바르게 파싱되지 않음.

주요 증상

• Neo4j 드라이버가 URI를 인식하지 못하고 에러 로그를 출력.
• URI 스킴 유효성 검사 실패.

예시

환경 변수 파일에 다음과 같이 잘못 정의되어 있었습니다:

NEO4J_BOLT_URI="bolt://URI:7687"

Challenge

문제 원인

1. 환경 변수 정의 오류

   • URI 값을 감싸는 불필요한 따옴표가 포함됨.
   • bolt://URI:7687 대신 "bolt://URI:7687" 형식으로 전달.

2. Neo4j 드라이버의 스킴 유효성 검사 실패

   • 드라이버가 URI의 스킴을 bolt://로 확인하지 못함.

3. 환경 변수 검증 로직 부재

   • 환경 변수를 불러올 때 값의 정합성을 검증하지 않음.

TO-BE

해결 방법

1. 환경 변수 수정

   • ECS 환경 파일에서 NEO4J_BOLT_URI 환경 변수를 수정:

     NEO4J_BOLT_URI=bolt://URI:7687

2. 애플리케이션 실행 및 검증

   • 수정 후 echo $NEO4J_BOLT_URI 명령어로 환경 변수 값 확인.
   • 애플리케이션 정상 실행 확인.

기대 결과

• NEO4J_BOLT_URI가 올바른 값으로 설정되어 Neo4j 드라이버가 정상적으로 동작.
• 환경 변수 값 검증 로직이 추가되어 유사한 문제가 발생하지 않음.

교훈 및 베스트 프랙티스

1. 환경 변수 정의 시 불필요한 따옴표를 피하자

   • 환경 변수는 기본적으로 문자열로 처리되므로, 따옴표를 추가할 필요가 없습니다.

2. 코드에서 환경 변수 값을 검증하자

   • 유틸리티 함수를 활용해 환경 변수 값을 정제하면 오류를 방지할 수 있습니다.

3. 문제 발생 시 로그와 환경을 세밀히 점검하자

   • 로그 분석과 환경 변수 값 확인은 문제 해결의 첫걸음입니다.

---

이 해결 사례를 통해 환경 변수 정의 및 검증의 중요성을 인식하고, 안정적인 애플리케이션 운영을 위한 방안을 마련하세요! 🚀