github.com/dms-sms/v1-api-gateway

DMS-SMS/V1

API Gateway 이외의 서비스들에 대한 Repository는 서비스 분해 부분에서 확인하실 수 있습니다!

---

INDEX

1. DMS-SMS란?

2. 서비스 기능

3. 서비스 분해

4. API Gateway 기능

5. 배포 방식

6. 버전별 개요

7. 데이터 시각화

---

DMS-SMS란?

• SMS는 School Management System의 약어로, 실제로 학생들을 대상으로 운영중인 학교 관리 시스템을 의미합니다

• 대덕소프트웨어마이스터고등학교의 기숙사 관리 시스템(DMS, Dormitory Management System)을 개발하는 동아리인 DMS에서 5기 부원들(현 2021년 기준 3학년)이 개발하는 새로운 서비스입니다.

• 서버 개발에는 현재 README.md를 작성중인 박진홍(PM)과 손민기 학생이 참여해 주었고, MSA 기반의 서버를 개발하였고 현재 운영중입니다.

---

서비스 기능

1. 외출증 서비스

   • 저희 서비스의 주기능으로, 오프라인 형식이였던 기존의 외출 프로세스를 온라인 형식으로 만든 것 입니다.
   • 학생이 신청하고 선생님 및 학부모가 승인 및 조회를 할 수 있습니다.

2. 학사 일정 서비스

   • 학사 일정 관련 정보들을 관리하는 서비스로, 세부적으로는 시간표와 캘린더 관리 기능이 있습니다.
   • 학생이 볼 수 있고, 또한 캘린더는 선생님이 일정을 관리할 수도 있습니다.

3. 동아리 서비스

   • 1학년 친구들 대상의 서비스로, 동아리 정보 및 동아리 모집 공고를 관리하는 서비스입니다.
   • 동아리 관리자(부장) 가 관리하고 학생이 조회할 수 있습니다.

4. 공지 서비스

   • 마지막으로 선생님 및 동아리 관리자(부장) 가 관리하고 학생이 확인할 수 있는 공지 서비스가 있습니다.
   • 참고로 선생님이 올리시는 학교 공지에는 대상(학년 반)을 설정할 수 있습니다.

---

서비스 분해

API Gateway에 대한 HTTP API 및 gRPC 서비스들에 대한 RPC API에 대해 설계한 내용들은 HTTP API 설계와 RPC API(Proto) 설계에서 추가로 확인하실 수 있습니다.

참고로, protocol-buffer 관련 파일들을 모와둔 레포지토리에서도 참고하실 수 있습니다.

1. API Gateway (개발 완료)

   • 이름 -> DMS.SMS.v1.api.gateway
   • 설명 -> 적절한 서비스에 사용자 요청 라우팅 서비스
   • 개발 -> 박진홍

2. Health Checker (개발 완료)

   • 이름 -> DMS.SMS.v1.api.health-checker
   • 기능 -> Consul을 이용한 서비스 및 엔드포인트를 이용한 API 상태 체크 및 기록 관리
   • 개발 -> 박진홍

3. Outing Service (개발 완료)

   • 이름 -> DMS.SMS.v1.service.outing
   • 기능 -> 외출증 관리 서비스
   • 개발 -> 손민기

4. Auth Service (개발 완료)

   • 이름 -> DMS.SMS.v1.service.auth
   • 설명 -> 학생, 선생님, 부모님 계정 및 정보 관리 서비스
   • 개발 -> 박진홍

5. Announement Service (개발 완료)

   • 이름 -> DMS.SMS.v1.service.announcement
   • 기능 -> 공지(학교, 동아리) 관리 서비스
   • 개발 -> 손민기

6. Schedule Service (개발 완료)

   • 이름 -> DMS.SMS.v1.service.schedule
   • 기능 -> 학사 일정(시간표, 캘린더) 관리 서비스
   • 개발 -> 손민기

7. Club Service (개발 완료)

   • 이름 -> DMS.SMS.v1.service.club
   • 기능 -> 동아리(정보, 모집) 관리 서비스
   • 개발 -> 박진홍

---

API Gateway 기능

1. 요청 유효성 검사

   • 서버에 전송한 payload에 꼭 필요한 데이터가 다 존재하는지, 데이터 제약조건은 다 만족했는지 확인 (x -> 400 Bad Request)

2. 인증 처리

   • 토큰이 헤더에 존재하고 유효한지, 해당 토큰의 payload의 형식이 옳바른지 확인 (X -> 401 Unauthorized)
   • 호출한 서비스가 본인 계정의 권한으로 접근이 가능한 서비스인지 확인 (X -> 403 Forbidden)

3. 서비스 탐색 및 부하 분산

   참고로 서비스의 장애를 방지하고 크기를 동적으로 조정하기 위해 이 Service Discovery를 유연하게 사용할 줄 알아야 함!

   • 서비스들이 동적 IP 주소에 호스팅되는 특성상 특정 서비스에 요청을 넣을 때 마다 해당 서비스의 IP 주소를 알아야하기 때문에 Service Discovery(consul 사용)에서 조회 (조회 결과 X -> 503 Service Unavailable)
   • 또한 서비스 조회 결과가 여러 개일 경우, 그 중 요청을 보낼 서비스를 정해야 하므로 Load Balancing이 필요함 (Round Robin 알고리즘 사용)

4. 계단식 오류 방지

   특정 서비스에 동기 통신을 할 경우, 해당 서비스의 응답이 무기한 연기가 된다면 이는 곧 업스트림 서비스의 메모리까지 잡아먹게 되어 계단식 오류가 발생하기 때문에 이에 대한 대책이 필요함!

   • 응답을 최대로 대기할 수 있는 시간 설정 (시간 만료 -> 408 Request Timeout)
   • 위와 같이 특정 서비스가 불능 상태가 되었을 경우, 해당 서비스로 요청이 가는 것을 차단하기 위해 Circuit Breaker 패턴 적용
     • 차단기 열림 -> Service Discovery의 Health Check을 Fatal로 변경 (조회 X)
     • 차단기 닫힘 -> Service Discovery의 Health Check을 Pass로 변경 (조회 O)

5. Dos 공격 대비

   • 동일한 IP의 요청이 1초에 특정 횟수 이상 들어올 경우, 해당 IP 차단 및 앞으로의 요청 403 Forbidden 반환 (특정 횟수 이상 시점 이후의 요청 -> 429 Too Many Request)

6. 관측성 패턴 적용

   • ELK Stack(Elasticsearch + Logstash + Kibana + Filebeat)로 구성된 로그 시스템에 로그 작성
   • 외부 API에 대한 지연 시간 및 응답 결과를 작성하기 위한 Distributed Trace(jaeger 사용)를 시작하기 위해 Span 생성 및 Metadata로 다음 서비스에 Span-Context 전달

7. 속도 제한

   • 서비스별로 1초간 수용될 수 있는 요청의 최대 횟수 설정 (해당 횟수 초과 -> 429 Too Many Request)

8. HTTP API 응답 캐싱

   • 리소스가 비교적 많이 소모되는 API들의 성능 향상을 위해 응답 redis에 저장 (만료 시간 -> 1분)
   • 응답 캐시가 존재하면 해당 캐시를 반환하고, 특정 캐시의 변경이 감지되면 해당 캐시 삭제

---

배포 방식

(2020-09-19)

• 각각의 서비스들은 AWS EKS 클러스터의 노드마다 하나씩 Public Subnet및 Private Subnet에 알맞게 배치되어 실행중입니다.
• 배포 서비스 업데이트 방식은 새로운 버전의 서비스 실행 파일이 담긴 Docker Image를 Docker Hub에 올린 후 AWS EKS 클러스터에 연결된 kubectl 명령어를 이용해서 deployment 객체의 이미지 버전을 변경합니다.

(2020-11-24)

• AWS EKS 비용 지원 문제로 인해 EC2에서 직접 k8s 클러스터를 실행시켜서 운영하고 있습니다.

(2020-12-29)

• 리소스(메모리) 용량 문제로 k8s에서 docker swarm로 컨테이너 관리 프레임워크를 바꿔서 운영중입니다.

---

버전별 개요

v.1.0.0

• 배포 날짜 -> 2020.11.21
• 버전 개요 -> Auth, Club Service 연결
• PR link -> github.com/DMS-SMS/v1-api-gateway/pull/25
• Docker -> jinhong0719/dms-sms-api-gateway:1.0.0.RELEASE
• 변경 내용
  • Auth & Club Service의 gRPC 기반 API로 요청을 스트림하는 HTTP API 추가

v.1.0.1

• 배포 날짜 -> 2020.12.12
• 버전 개요 -> Outing, Schedule, Announcement Service 연결
• PR link -> github.com/DMS-SMS/v1-api-gateway/pull/28
• Docker -> jinhong0719/dms-sms-api-gateway:1.0.1.RELEASE
• 변경 내용
  • Outing & Schedule & Announcement Service의 gRPC 기반 API로 요청을 스트림하는 HTTP API 추가

v.1.0.2

• 배포 날짜 -> 2021.01.27
• 버전 개요 -> 성능 향상을 위한 전체적인 consul 서비스 노드 조회 방식 변경
• PR link -> github.com/DMS-SMS/v1-api-gateway/pull/34
• Docker -> jinhong0719/dms-sms-api-gateway:1.0.2.RELEASE
• 변경 내용
  • Consul에서 변경 이벤트 감지 시, Gateway 포함 각각의 서비스에 연결되어 있는 AWS SNS에 메시지 발행
  • 서비스 별로 AWS SQS Pulling을 통해 메시지를 받으면, 해당 시점에 consul 서비스 노드 전체 조회 후 저장
  • 그 후, 위에서 로컬에 저장한 노드 목록을 기준으로 요청을 스트림할 서비스 노드 선택
  • 요악 - '요청 발생 시 마다 매번 조회 -> consul 변경 시점에만 조회 후 저장'

v.1.0.3

• 배포 날짜 -> 2021.02.06
• 버전 개요 -> API 별로 중복되는 기능들 middleware로 묶은 후 router에 등록
• PR link -> github.com/DMS-SMS/v1-api-gateway/pull/35
• Docker -> jinhong0719/dms-sms-api-gateway:1.0.3.RELEASE
• 변경 내용
  • tracer span 관리(시작, 종료 및 로그 기록), 인증 처리, 요청 바인딩 기능들 middleware로 따로 빼서 처리

v.1.0.4

• 배포 날짜 -> 2021.02.15
• 버전 개요 -> 성능 향상을 위한 API 응답 캐싱 핸들링 기능 추가 (in redis)
• PR link -> github.com/DMS-SMS/v1-api-gateway/pull/38
• Docker -> jinhong0719/dms-sms-api-gateway:1.0.4.RELEASE
• 변경 내용
  • Outing, Schedule, Announcement 서비스의 조회 관련 API 응답 redis에 저장
  • 응답 캐시가 redis에 존재할 경우, 따로 요청을 보내지 않고 json으로 변환 후 빈환
  • 특정 리소스에 대한 변경 감지 시(상태 코드로 판별), 해당 리소스와 관련된 캐시 삭제
  • consul change event 전달 방식 변경 (AWS SNS & SQS -> gRPC)

---

데이터 시각화

아래 같이 Kibana를 이용해 서비스별 요청 횟수 및 평균 처리 시간을 원형 도표와 선 도표를 이용하여 표현하였습니다.