DOC: Add ready, shutdown command

namsic commented 5 months ago

신규 명령어에 대한 문서를 추가합니다. 미리보기
기존 문서의 표현 양식과는 약간의 차이가 있습니다.
- lqdetect command는 아래와 같다. => ### Syntax
- show 명령은 저장된 명령어 샘플을 출력하고 그 결과는 아래와 같다. => ### Response
- 각 응답을 별개의 코드 블럭으로 구분하고, 각 응답에 대한 설명을 하단에 추가

jhpark816 commented 5 months ago

아래와 같은 기존 형식을 그대로 따르는 것이 좋을 것 같습니다.

아니면, 이 참에 문서 형식을 정리하는 단계로 넘어가도 될 것 같구요.

namsic commented 5 months ago

문서 형식 정리가 완료된 뒤에 문서를 추가하려면 시간이 많이 소요될 것 같아서, 우선은 기존 형식에 맞추어 재작성했습니다.

jhpark816 commented 5 months ago

@namsic 수정 본을 적어 봅니다. 아래 예시를 참고하여 보다 정확하게 나타내 봅시다.

ready

ARCUS Cache Server가 요청을 처리할 수 있는 상태인지 확인한다.

ready\r\n

Response string과 그 의미는 아래와 같다. (표 표현이 어려워 itemize 방식으로 표현하였음)

"READY" : 요청 처리 가능한 상태
- 독립 실행(standalone) 모드로 구동(-z 옵션 생략)하면, 즉시 READY 상태가 된다.
- 클러스터 모드로 구동(-z 옵션 사용)한 경우는 요청 처리가 준비되어 ZooKeeper에 자신의 캐시 노드 정보를 등록하고 나면 READY 상태가 된다.
"NOT_READY" : 요청 처리가 준비되지 않은 상태
- 클러스터 모드로 구동한 경우이고 요청 처리가 아직 준비되지 않은 상태

ARCUS Cache Server를 우아하게 종료한다.

아래는 설명하려는 부분인 데 완성하지 못한 상태임.

ZooKeeper에서 자신의 캐시 노드 정보를 제거한 후 연결까지 끊고 Listen 소켓을 닫은 후에 기존 클라이언트 연결들이 모두 닫힐 때까지 대기한다.

ZooKeeper로 부터 캐시 노드 정보를 획득하여 연결한 클라이언트는 현재 캐시 노드 정보가 제거되었다는 ZooKeeper 이벤트를 수신하면 해당 캐시 노드로의 연결을 닫게 된다.
ZooKeeper에 의존하지 않고 현재 캐시 노드로 직접 연결한 경우가 있다면 이러한 연결은 그대로 남는다.

shutdown [<seconds>]\r\n

<seconds> - 프로세스 종료 전 대기 시간을 설정한다. 지정하지 않으면 최대 2초동안 대기하되, 200ms동안 클라이언트 연결 수가 감소하지 않으면 즉시 종료한다.
- seconds의 최솟값은 0, 최댓값은 600이다.

Response string과 그 의미는 아래와 같다.

Resposne String	설명
"OK"	성공
"DENIED"	거부됨
"CLIENT_ERROR bad command line format"	protocol syntax 틀림
"CLIENT_ERROR invalid arguments"	유효하지 않은 인자

아래 조건을 모두 만족하는 경우 새로운 shutdown 요청이 거부되고, DENIED 응답을 반환한다.
- 이미 shutdown 요청 수신하여 종료 대기 중
- 기존 shutdown 요청에 의한 종료 시간이 1초 이내로 남은 상태

jhpark816 commented 5 months ago

@namsic shutdown 명령만 재정리해 보았습니다. 참고하여 반영 바랍니다.

ARCUS Cache Server를 우아하게 종료한다.

ZooKeeper 연결을 종료하여 자신의 캐시 노드 정보를 제거하고 Listen socket을 닫는다.
ZooKeeper에 연결된 클라이언트는 캐시 노드 정보가 제거된 event를 받아 캐시 서버와 연결을 종료하므로, 클라이언트 연결이 자연스럽게 종료될 때까지 대기한다.
클라이언트 연결 수가 줄어들지 않거나, 정해진 시간이 지나고 나면 프로세스를 종료한다.

shutdown [<seconds>]\r\n

<seconds> - 프로세스 종료 전 대기 시간을 설정한다.
- 생략하면, 200ms 단위로 클라이언트 연결 수 감소를 확인하며 감소가 없으면 즉시 종료한다. 최대 2초 동안에 연결 수 감소가 완료되지 않으면 강제 종료한다.
- 지정하면, 지정된 기간까지 대기 후에 종료한다. 지정된 기간이 짧으면 클라이언트 연결이 끊어지기 전에 강제 종료할 수 있다.
- seconds의 최솟값은 0, 최댓값은 600이다.

나머지 부분은 OK