WebSocket 프록시로서의 NGINX

Rick Nelson솔루션 엔지니어링 지역 담당 부사장

The WebSocket 프로토콜은 클라이언트와 서버 간의 실시간 양방향 통신을 지원하는 웹 애플리케이션을 만들 수 있는 방법을 제공합니다. HTML5의 일부인 WebSocket을 사용하면 이전에 사용하던 방식보다 이러한 유형의 애플리케이션을 훨씬 쉽게 개발할 수 있습니다. Chrome, Firefox, Internet Explorer, Opera, Safari를 비롯한 대부분의 최신 브라우저가 WebSocket을 지원하며, WebSocket을 지원하는 서버 애플리케이션 프레임워크도 점점 늘어나고 있습니다.

성능과 고가용성을 위해 여러 WebSocket 서버가 필요한 엔터프라이즈 프로덕션 환경에서는 WebSocket 프로토콜을 이해하는 부하 분산 계층이 필요합니다. NGINX는 버전 1.3부터 WebSocket을 지원해 왔으며, 리버스 프록시 역할을 하고 WebSocket 애플리케이션의 부하 분산을 수행할 수 있습니다. (NGINX Plus의 모든 릴리스도 WebSocket을 지원합니다.)

최근 진행된 성능 테스트에서 NGINX가 WebSocket 연결을 로드 밸런싱할 때의 확장성을 확인해 보세요.

WebSocket 프로토콜은 HTTP 프로토콜과 다르지만, WebSocket 핸드셰이크는 HTTP와 호환되며 HTTP Upgrade 기능을 사용하여 연결을 HTTP에서 WebSocket으로 업그레이드합니다. 따라서 WebSocket 애플리케이션을 기존 인프라에 더 쉽게 통합할 수 있습니다. 예를 들어 WebSocket 애플리케이션은 표준 HTTP 포트인 80과 443을 사용할 수 있으므로 기존 방화벽 규칙을 그대로 적용할 수 있습니다.

WebSocket 애플리케이션은 클라이언트와 서버 간의 연결을 장시간 열린 상태로 유지하므로 실시간 애플리케이션을 쉽게 개발할 수 있습니다. HTTP 연결을 WebSocket으로 업그레이드하는 데 사용되는 HTTP Upgrade 메커니즘은 Upgrade 및 Connection 헤더를 사용합니다. 리버스 프록시 서버가 WebSocket을 지원할 때는 몇 가지 해결해야 할 문제가 있습니다. 그중 하나는 WebSocket이 홉별(hop-by-hop) 프로토콜이라는 점입니다. 따라서 프록시 서버가 클라이언트의 Upgrade 요청을 가로채면 적절한 헤더를 포함한 자체 Upgrade 요청을 백엔드 서버로 보내야 합니다. 또한 WebSocket 연결은 HTTP에서 일반적으로 사용하는 단기 연결과 달리 장시간 유지되므로, 리버스 프록시는 이러한 연결이 유휴 상태로 보인다는 이유로 종료하지 않고 열린 상태로 유지해야 합니다.

NGINX는 클라이언트와 백엔드 서버 간에 터널을 설정할 수 있도록 하여 WebSocket을 지원합니다. NGINX가 클라이언트의 Upgrade 요청을 백엔드 서버로 보내려면 다음 예와 같이 Upgrade 및 Connection 헤더를 명시적으로 설정해야 합니다:

location /wsapp/ {    proxy_pass http://wsbackend;
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "Upgrade";
    proxy_set_header Host $host;
}

이 작업이 완료되면 NGINX는 이를 WebSocket 연결로 처리합니다.

NGINX WebSocket 예제

다음은 NGINX가 WebSocket 프록시로 작동하는 모습을 보여 주는 실제 예제입니다. 이 예제에서는 ws라는 Node.js 기반 WebSocket 구현을 사용합니다. NGINX는 ws와 Node.js를 사용하는 간단한 WebSocket 애플리케이션의 리버스 프록시 역할을 합니다. 이 지침은 Ubuntu 13.10 및 CentOS 6.5에서 테스트되었지만, 다른 OS 및 버전에서는 조정이 필요할 수 있습니다. 이 예제에서 WebSocket 서버의 IP 주소는 192.168.100.10이고 NGINX 서버의 IP 주소는 192.168.100.20입니다.

1. Node.js와 npm이 아직 설치되어 있지 않다면 다음 명령을 실행합니다:
   • Debian 및 Ubuntu의 경우:

$ sudo apt-get install nodejs npm

• RHEL 및 CentOS의 경우:

$ sudo yum install nodejs npm

1. Node.js는 Ubuntu에서는 nodejs로, CentOS에서는 node로 설치됩니다. 이 예제에서는 node를 사용하므로 Ubuntu에서는 nodejs에서 node로 연결되는 심볼릭 링크를 만들어야 합니다:

$ ln -s /usr/bin/nodejs /usr/local/bin/node

1. 설치하려면 ws 다음 명령어를 실행하세요:

$ sudo npm install ws

1. 참고: “Error: failed to fetch from registry: ws”라는 오류 메시지가 표시되면 다음 명령어를 실행하여 문제를 해결하세요:

$ sudo npm config set registry http://registry.npmjs.org/

1. 그런 다음 sudo npm install ws 명령을 다시 실행합니다.
2. ws에는 클라이언트로 사용할 프로그램인 /root/node_modules/ws/bin/wscat이 포함되어 있지만, 서버 역할을 할 프로그램은 직접 만들어야 합니다. 다음 내용으로 server.js 파일을 만드세요:

console.log("Server started");
var Msg = '';
var WebSocketServer = require('ws').Server
    , wss = new WebSocketServer({port: 8010});
    wss.on('connection', function(ws) {
        ws.on('message', function(message) {
        console.log('Received from client: %s', message);
        ws.send('Server received from client: ' + message);
    });
 });

1. 서버 프로그램을 실행하려면 다음 명령어를 실행하세요:

$ node server.js

1. 서버는 먼저 "Server started" 메시지를 출력한 다음 포트 8010에서 수신 대기하며 클라이언트가 연결되기를 기다립니다. 클라이언트 요청을 받으면 해당 요청을 그대로 출력하고, 수신한 메시지가 포함된 응답 메시지를 클라이언트에 보냅니다. NGINX가 이러한 요청을 프록시하도록 다음 구성을 만듭니다. 요청의 map 블록을 추가하여 요청의 Upgrade 헤더가 ''로 설정된 경우 Connection 헤더가 close로 올바르게 설정되도록 합니다.

http {
    map $http_upgrade $connection_upgrade {
        default upgrade;
        '' close;
    }
 
    upstream websocket {
        server 192.168.100.10:8010;
    }
 
    server {
        listen 8020;
        location / {
            proxy_pass http://websocket;
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection $connection_upgrade;
            proxy_set_header Host $host;
        }
    }
}

1. NGINX는 8020 포트에서 수신 대기하며 요청을 백엔드 WebSocket 서버로 프록시합니다. proxy_set_header 지시어를 사용하면 NGINX가 WebSocket 프로토콜을 올바르게 처리할 수 있습니다.
2. 서버를 테스트하기 위해 wscat을 클라이언트로 실행합니다:

$ /root/node_modules/ws/bin/wscat --connect ws://192.168.100.20:8020

1. wscat은 NGINX 프록시를 통해 WebSocket 서버에 연결됩니다. wscat이 서버로 보낼 메시지를 입력하면 해당 메시지가 서버에 표시된 후 서버에서 보낸 메시지가 클라이언트에 나타납니다. 다음은 상호 작용의 예입니다. 서버: 클라이언트: $node server.js
서버 시작됨 
 

wscat --connect ws://192.168.100.20:8020
연결됨(종료하려면 CTRL+C를 누르세요)
> Hello 클라이언트로부터 수신: Hello < 서버가 클라이언트로부터 수신함: Hello 여기에서 클라이언트와 서버가 프록시 역할을 하는 NGINX를 통해 통신할 수 있으며, 클라이언트나 서버 중 하나가 연결을 끊을 때까지 메시지를 계속 주고받을 수 있음을 확인할 수 있습니다. NGINX가 WebSocket을 올바르게 처리하도록 하려면 HTTP 연결을 WebSocket으로 전환하는 Upgrade 요청을 처리할 수 있도록 헤더를 올바르게 설정하기만 하면 됩니다.

추가 자료

• WebSocket 프록시(nginx.org)
• NGINX와 NGINX Plus 기능 비교
• NGINX Plus 기술 사양
• WebSocket 트래픽 프록시 구성 참조:
  • NGINX Open Source 및 NGINX Plus를 사용한 Apache Tomcat 서버 부하 분산
  • NGINX Open Source 및 NGINX Plus를 사용한 Node.js 애플리케이션 서버 부하 분산
  • NGINX Open Source 및 NGINX Plus를 사용한 Oracle WebLogic Server 부하 분산
  • NGINX Open Source 및 NGINX Plus를 사용한 Wildfly 및 JBoss 애플리케이션 서버의 부하 분산

작성자 소개

Rick Nelson솔루션 엔지니어링 지역 담당 부사장

Rick Nelson의 다른 블로그 게시물