ngx_healthcheck_module intro

8869 단어 nginxnginx-modulec
ngx-healthcheck-module
Health-checker for Nginx upstream servers (support http upstream && stream upstream)
이 모듈 은 Nginx 에 능 동적 백 엔 드 서버 건강 검진 기능 (4 층 과 7 층 백 엔 드 서버 건강 검진 지원) 을 제공 합 니 다.
Table of Contents
  • Status
  • Description
  • Installation
  • Usage
  • Synopsis && Directive
  • healthcheck
  • check

  • Bugs and Patches
  • Author
  • Copyright and License
  • See Also

  • Status
    This nginx module is still under development, you can help improve and it.
    이 프로젝트 는 아직 개발 중 입 니 다. 공헌 코드 를 환영 하거나 버그 를 보고 합 니 다.함께 그것 을 더욱 좋게 하 다.
    Description
    nginx 를 부하 이퀄 라이저 로 사용 할 때 nginx 원생 은 정상 적 인 백 엔 드 서버 에 접근 할 수 있 도록 기본 적 인 재 시도 방식 만 제공 합 니 다.
    이에 비해 이 nginx 제3자 모듈 은 백 엔 드 서버 에 주동 적 인 건강 상태 검 사 를 제공 할 수 있 습 니 다.새로운 요청 이 건강 한 백 엔 드 서버 로 직접 전 송 될 수 있 도록 백 엔 드 서버 목록 을 유지 합 니 다.
    주요 특성:
  • 4 층 과 7 층 백 엔 드 서버 의 건강 검진 을 동시에 지원 합 니 다
  • 4 층 에서 지원 하 는 검 측 유형: tcp / udp / http
  • 7 층 에서 지원 하 는 검 측 유형: http / fastcgi
  • 통 일 된 http 상태 조회 인 터 페 이 스 를 제공 합 니 다. 출력 형식: html / json / csv
  • Installation
    git clone https://github.com/nginx/nginx/nginx.git
    git clone https://github.com/zhouchangxun/ngx_healthcheck_module.git
    
    cd nginx/; 
    git apply ../ngx_healthcheck_module/nginx-stable-1.12+.patch
    
    ./auto/configure --with-stream --add-module=../ngx_healthcheck_module/
    make && make install

    Back to TOC
    Usage
    nginx.conf example
    user  root;
    worker_processes  1;
    error_log  logs/error.log  info;
    #pid        logs/nginx.pid;
    
    events {
        worker_connections  1024;
    }
    
    http {
        server {
            listen 80;
            # status interface
            location /status {
                healthcheck_status;
            }
            # http front
            location / { 
              proxy_pass http://http-cluster;
            }   
        }
        # as a backend server.
        server {
            listen 8080;
            location / {
              root html;
            }
        }
        
        upstream http-cluster {
            # simple round-robin
            server 127.0.0.1:8080;
            server 127.0.0.2:81;
    
            check interval=3000 rise=2 fall=5 timeout=5000 type=http;
            check_http_send "GET / HTTP/1.0\r
    \r
    "; check_http_expect_alive http_2xx http_3xx; } } stream { upstream tcp-cluster { # simple round-robin server 127.0.0.1:22; server 192.168.0.2:22; check interval=3000 rise=2 fall=5 timeout=5000 default_down=true type=tcp; } server { listen 522; proxy_pass tcp-cluster; } upstream udp-cluster { # simple round-robin server 127.0.0.1:53; server 8.8.8.8:53; check interval=3000 rise=2 fall=5 timeout=5000 default_down=true type=udp; } server { listen 53; proxy_pass udp-cluster; } }

    status interface
    One typical output is
    root@changxun-PC:~/nginx-dev/ngx_healthcheck_module# curl localhost/status
    {"servers": {
      "total": 6,
      "generation": 3,
      "http": [
        {"index": 0, "upstream": "http-cluster", "name": "127.0.0.1:8080", "status": "up", "rise": 119, "fall": 0, "type": "http", "port": 0},
        {"index": 1, "upstream": "http-cluster", "name": "127.0.0.2:81", "status": "down", "rise": 0, "fall": 120, "type": "http", "port": 0}
      ],
      "stream": [
        {"index": 0, "upstream": "tcp-cluster", "name": "127.0.0.1:22", "status": "up", "rise": 22, "fall": 0, "type": "tcp", "port": 0},
        {"index": 1, "upstream": "tcp-cluster", "name": "192.168.0.2:22", "status": "down", "rise": 0, "fall": 7, "type": "tcp", "port": 0},
        {"index": 2, "upstream": "udp-cluster", "name": "127.0.0.1:53", "status": "down", "rise": 0, "fall": 120, "type": "udp", "port": 0},
        {"index": 3, "upstream": "udp-cluster", "name": "8.8.8.8:53", "status": "up", "rise": 3, "fall": 0, "type": "udp", "port": 0}
      ]
    }}
    root@changxun-PC:~/nginx-dev/ngx_healthcheck_module# 

    Back to TOC
    Synopsis
    check Syntax :
    check interval=milliseconds
    [fall=count] [rise=count] [timeout=milliseconds]
    [default_down=true|false] [type=tcp|udp|http] [port=check_port] Default : interval=30000 fall=5 rise=2 timeout=1000 default_down=true type=tcp Context : http/upstream || stream/upstream
    이 명령 은 백 엔 드 서버 의 건강 검진 기능 을 열 수 있다.Detail :
  • interval: 백 엔 드 에 보 내 는 건강 검진 가방 의 간격.
  • fall (fall count): 연속 실패 횟수 가 fall 에 도달 하면count, 서버 는 다운 으로 여 겨 집 니 다.
  • rise (rise count): 연속 성공 횟수 가 rise 에 도달 하면count, 서버 는 up 으로 여 겨 집 니 다.
  • timeout: 백 엔 드 건강 요청 시간 초과.
  • default_down: 초기 서버 의 상 태 를 설정 합 니 다. true 라면 기본 값 은 다운 입 니 다. false 라면 up 입 니 다.기본 값 은 true 입 니 다. 즉, 처음에 서버 가 사용 할 수 없다 고 생각 했 기 때문에 건강 검진 가방 이 일정한 성공 횟수 에 이 르 러 야 건강 하 다 고 여 겨 집 니 다.
  • type: 건강 검진 가방 의 유형, 현재 다음 과 같은 다양한 유형 을 지원 합 니 다.
  • tcp: 간단 한 tcp 연결, 연결 이 성공 하면 백 엔 드 가 정상 임 을 설명 합 니 다.
  • udp: udp 메 시 지 를 간단하게 보 냅 니 다. icmp error (호스트 나 포트 에 도달 할 수 없 음) 를 받 으 면 백 엔 드 이상 을 설명 합 니 다.(stream 설정 블록 에서 만 udp 형식 검 사 를 지원 합 니 다)
  • http: HTTP 요청 을 보 내 고 백 엔 드 리 셋 패키지 의 상 태 를 통 해 백 엔 드 의 생존 여 부 를 판단 합 니 다.

  • port: 백 엔 드 서버 의 검사 포트 를 지정 합 니 다.실제 서비스 와 다른 백 엔 드 서버 의 포트 를 지정 할 수 있 습 니 다.
  • 예 를 들 어 백 엔 드 는 443 포트 의 응용 을 제공 합 니 다. 80 포트 의 상 태 를 검사 하여 백 엔 드 의 건강 상 태 를 판단 할 수 있 습 니 다.기본 값 은 0 입 니 다. 백 엔 드 서버 가 실제 서 비 스 를 제공 하 는 포트 와 같 습 니 다.
    A example as followed:
    stream {
        upstream tcp-cluster {
            # simple round-robin
            server 127.0.0.1:22;
            server 192.168.0.2:22;
            check interval=3000 rise=2 fall=5 timeout=5000 default_down=true type=tcp;
        }
        server {
            listen 522;
            proxy_pass tcp-cluster;
        }
        ...
    }

    healthcheck Syntax : healthcheck_status [html|csv|json] Default : healthcheck_status html Context : http/server/location
    A example as followed:
    http {
        server {
            listen 80;
            
            # status interface
            location /status {
                healthcheck_status;
            }
         ...
    }

    Back to TOC
    Todo List
  • 테스트 용례 증가
  • 정리, 최적화 코드
  • 규범 코드 중의 log 출력
  • Back to TOC
    Bugs and Patches
    Please report bugs
  • create GitHub Issue,

  • or submit patches by
  • new Pull request

  • Back to TOC
    Author
    최 찬 희 (주장 훈).
    Back to TOC
    Copyright and License
    The health check part is based on Yaoweibin's
    healthcheck module nginx_upstream_check_module
    ();
    

    This module is licensed under the BSD license.
    Copyright (C) 2017-, by Changxun Zhou
    Copyright (C) 2014 by Weibin Yao
    All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    Back to TOC
    See Also
  • nginx: http://nginx.org

  • Back to TOC

    좋은 웹페이지 즐겨찾기