사이냅 에디터 문서
Space shortcuts
Page tree
Skip to end of metadata
Go to start of metadata

실시간 협업을 위한 웹 소켓 노드 서버 실행 가이드입니다.
본 가이드는 웹 소켓 기반의 실시간 협업을 지원하는 서버 환경을 제공합니다. PM2를 사용하여 서버 환경을 구축하고 관리할 수 있습니다.

웹 소켓 서버의 설치 및 실행을 위해 필요한 js 파일은 별도의 요청을 통해 제공됩니다.
웹 소켓 서버 구축을 원하시는 경우, 기술지원팀으로 연락주시면 상세한 안내와 함께 필요한 파일(js)을 전달해 드립니다.

목차

실행환경

  • node: v16.13.1

웹 소켓 서버 & PM2

  • 웹 소켓 서버의 프로세스 상태 모니터링 및 관리를 위해 PM2를 사용하는 것을 권장합니다.

  • PM2는 Node.js 애플리케이션의 프로세스 관리 도구로, 애플리케이션의 실행 상태를 지속적으로 모니터링하고, 비정상 종료 시 자동으로 재 시작하는 기능을 제공합니다.

  • PM2로 서버 실행시 background로 프로세스를 관리 할 수 있습니다.

PM2 설치

# PM2를 전역으로 설치합니다.
npm install pm2 -g

웹 소켓 서버 실행

  • 웹 소켓 서버를 PM2로 실행합니다.

windows

# cmd(관리자 권한 실행)
set HOST=<호스트 주소>
set PORT=<포트 번호>
pm2 start collaboServer.js

# 예시
set HOST=58.161.1.23
set PORT=12000
pm2 start collaboServer.js

# powershell(관리자 권한 실행)
$env:HOST=<호스트 주소>
$env:PORT=<포트 번호>
pm2 start collaboServer.js

# 예시
$env:HOST=58.161.1.23
$env:PORT=12000
pm2 start collaboServer.js

linux

# 노드 서버 실행
# collaboServer.js가 있는 곳에서 실행하거나 [collaboServer.js가 있는 폴더 경로]/collaboServer.js를 호출해 주세요.
# HOST=<호스트 주소> PORT=<포트 번호> pm2 start collaboServer.js

# 예시
HOST=58.161.1.23 PORT=12000 pm2 start collaboServer.js
HOST=58.161.1.23 PORT=12000 pm2 start /home/abc/collaboServer/collaboServer.js
HOST=58.161.1.23 PORT=12000 pm2 start collaboServer/collaboServer.js

웹 소켓 서버 동작 확인

  • 실행중인 웹 소켓 서버를 확인합니다.
  • status가 online이면 서버가 동작 중입니다.

windows, linux

# 동작 중인 프로세스를 확인합니다.
pm2 list

웹 소켓 서버 종료

프로세스 종료 또는 삭제

  • 실행중인 웹 소켓 서버 프로세스를 종료하거나 삭제합니다.

windows, linux

# 웹 소켓 서버 프로세스 종료
pm2 kill <filename>

# 웹 소켓 서버 프로세스 삭제
pm2 delete <filename>

웹 소켓 서버 모니터링

프로세스 모니터링 및 관리

  • PM2에 실행중인 웹 소켓 서버 프로세스 상태를 모니터링 합니다.
  • 메모리와 CPU의 사용량을 모니터링하고 실시간 로그를 확인할 수 있습니다.

서버 로그는 다음과 같은 방법으로 확인할 수 있습니다.


1) PM2를 통해 실시간 로그 확인

PM2에서 제공하는 모니터링 기능을 통해 서버 상태와 함께 실시간 로그를 확인할 수 있습니다.

windows, linux

# 웹 소켓 서버 프로세스 모니터링
pm2 monit

2) 로그 파일 확인

  • 저장 경로: 서버 실행 경로 기준 ./logs 디렉토리에 파일 형태로 저장됩니다.

  • 일자별 로그 및 에러 로그가 분리되어 저장됩니다.


로그에서 확인 가능한 주요 정보:

  • 서버 시작 및 상태 정보

  • 문서 생성/삭제 및 사용자 접속 정보

  • WebSocket 및 Redis 관련 오류

  • 에러 및 예외 상황

  • No labels