nginx upstream_check_module模块的使用

文章介绍了Nginx的上游检查模块upstream_check_module在服务治理中的作用,包括TCP和HTTP层的默认健康检查方案,以及如何通过自定义配置实现更精确的服务节点健康检查。重点解析了配置参数,如`check`,`interval`,`fall`,`rise`,`timeout`等,并提供了完整的配置示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

nginx_upstream_check_module模块使用
服务治理的一个重要任务是感知服务节点变更,完成服务自动注册及异常节点的自动摘除。这就需要服务治理平台能够:及时、准确的感知service节点的健康状况。

方案概述

Nginx 提供了三种HTTP服务健康检查方案供用户选择:

TCP层默认检查方案:

        定时与后端服务建立一条tcp连接,链接建立成功则认为服务节点是健康的。

HTTP层默认检查方案:

        TCP层检查有一定的局限性:

        很多HTTP服务是带状态的,端口处于listen状态并不能代表服务已经完成预热;

        不能真实反映服务内部处理逻辑是否产生拥堵。

        这时可以选择http层健康检查,会向服务发送一个http请求GET / HTTP/1.0\r\n\r\n,返回状态是2xx或3xx时认为后端服务正常。

自定义方案:(nginx_upstream_check_module模块)

        可根据下文描述自定义检查方案。

配置参数详解

一个常用的健康检查配置如下:

check fall=3 interval=3000 rise=2 timeout=2000 type=http;
check_http_expect_alive http_2xx http_3xx ;
check_http_send "GET /checkAlive HTTP/1.0\r\n\r\n" ;
下面针对每个配置参数,进行详细介绍。

 
check:

check 字段参数如下:

Syntax: check interval=milliseconds [fall=count] [rise=count] [timeout=milliseconds] [default_down=true|false] [type=tcp|http|ssl_hello|mysql|ajp] [port=check_port]
Default: 如果没有配置参数,默认值是:interval=30000 fall=5 rise=2 timeout=1000 default_down=true type=tcp
check 字段各个参数含义如下:

interval:向后端发送的健康检查包的间隔,单位为毫秒。

fall(fall_count): 如果连续失败次数达到fall_count,服务器就被认为是down。

rise(rise_count): 如果连续成功次数达到rise_count,服务器就被认为是up。

timeout: 后端健康请求的超时时间。

default_down: 设定初始时服务器的状态,如果是true,就说明默认是down的,如果是false,就是up的。

默认值是true,也就是一开始服务器认为是不可用,要等健康检查包达到一定成功次数以后才会被认为是健康的。

type:健康检查包的类型,现在支持以下多种类型    

tcp:

简单的tcp连接,如果连接成功,就说明后端正常。

ssl_hello:

发送一个初始的SSL hello包并接受服务器的SSL hello包。

http:

发送HTTP请求,通过后端的回复包的状态来判断后端是否存活。

mysql: 向mysql服务器连接,通过接收服务器的greeting包来判断后端是否存活。

ajp:

向后端发送AJP协议的Cping包,通过接收Cpong包来判断后端是否存活。

port: 指定后端服务器的检查端口。

可以指定不同于真实服务的后端服务器的端口,比如后端提供的是443端口的应用,你可以去检查80端口的状态来判断后端健康状况。

默认是0,表示跟后端server提供真实服务的端口一样。

check_http_expect_alive:

check_http_expect_alive 指定主动健康检查时HTTP回复的成功状态:

Syntax: check_http_expect_alive [ http_2xx | http_3xx | http_4xx | http_5xx ]
Default: http_2xx | http_3xx
check_http_send:

check_http_send 配置http健康检查包发送的请求内容

为了减少传输数据量,推荐采用”HEAD”方法。当采用长连接进行健康检查时,需在该指令中添加keep-alive请求头,如:”HEAD / HTTP/1.1\r\nConnection: keep-alive\r\n\r\n”。同时,在采用”GET”方法的情况下,请求uri的size不宜过大,确保可以在1个interval内传输完成,否则会被健康检查模块视为后端服务器或网络异常。

Syntax: check_http_send http_packet
Default: "GET / HTTP/1.0\r\n\r\n"
 

完整示例

完整示例,如下:

http {
    upstream cluster1 {
     # simple round-robin
     server 192.168.0.1:80;
     server 192.168.0.2:80;
     check interval=3000 rise=2 fall=5 timeout=1000 type=http;
     check_http_send "HEAD / HTTP/1.0\r\n\r\n";
     check_http_expect_alive http_2xx http_3xx;
   }
    upstream cluster2 {
     # simple round-robin
     server 192.168.0.3:80;
     server 192.168.0.4:80;
     check interval=3000 rise=2 fall=5 timeout=1000 type=http;
     check_keepalive_requests 100;
     check_http_send "HEAD / HTTP/1.1\r\nConnection: keep-alive\r\n\r\n";
     check_http_expect_alive http_2xx http_3xx;
  }
    server { 
      listen 80;
      location /1 {
       proxy_pass http://cluster1;
      }
      location /2 {
       proxy_pass http://cluster2;
      }
     location /status {
       check_status;
       access_log   off;
       allow SOME.IP.ADD.RESS;
       deny all;
     }
   }
}

### 构建带有 `nginx_upstream_check_module` 模块Nginx Docker 镜像 为了创建一个包含 `nginx_upstream_check_module` 的自定义 Nginx Docker 镜像,可以按照以下方法操作: #### 准备工作环境 首先,在本地环境中准备必要的文件和脚本。这包括编写用于构建镜像的Dockerfile以及任何所需的shell脚本来简化模块的安装过程。 #### 编写 Dockerfile 下面是一个简单的 Dockerfile 示例,它展示了如何从源码编译并集成 `nginx_upstream_check_module` 到官方 Nginx 容器中: ```dockerfile FROM nginx:latest as builder # 设置环境变量以避免交互提示 ENV DEBIAN_FRONTEND noninteractive RUN apt-get update && \ apt-get install -y build-essential libpcre3-dev zlib1g-dev libssl-dev git wget unzip WORKDIR /usr/src # 下载指定版本的Nginx源码 (这里假设使用最新的稳定版) ARG NGINX_VERSION=1.21.6 RUN wget http://nginx.org/download/nginx-$NGINX_VERSION.tar.gz && \ tar zxvf nginx-$NGINX_VERSION.tar.gz # 获取第三方模块源码 RUN wget https://codeload.github.com/yaoweibin/nginx_upstream_check_module/zip/master.zip && \ unzip master.zip WORKDIR /usr/src/nginx-$NGINX_VERSION # 使用原始配置加上新添加的模块选项重新编译Nginx RUN ./configure --prefix=/etc/nginx \ --sbin-path=/usr/sbin/nginx \ --modules-path=/usr/lib/nginx/modules \ --conf-path=/etc/nginx/nginx.conf \ --error-log-path=/var/log/nginx/error.log \ --http-log-path=/var/log/nginx/access.log \ --pid-path=/var/run/nginx.pid \ --lock-path=/var/run/nginx.lock \ --http-client-body-temp-path=/var/cache/nginx/client_temp \ --http-proxy-temp-path=/var/cache/nginx/proxy_temp \ --http-fastcgi-temp-path=/var/cache/nginx/fastcgi_temp \ --http-uwsgi-temp-path=/var/cache/nginx/uwsgi_temp \ --http-scgi-temp-path=/var/cache/nginx/scgi_temp \ --user=nginx \ --group=nginx \ --with-compat \ --with-file-aio \ --with-threads \ --with-http_addition_module \ --with-http_auth_request_module \ --with-http_dav_module \ --with-http_flv_module \ --with-http_gunzip_module \ --with-http_gzip_static_module \ --with-http_mp4_module \ --with-http_random_index_module \ --with-http_realip_module \ --with-http_secure_link_module \ --with-http_slice_module \ --with-http_ssl_module \ --with-http_stub_status_module \ --with-http_sub_module \ --with-mail \ --with-stream \ --add-dynamic-module=../nginx_upstream_check_module-master && \ make modules # 创建最终运行时容器的基础层 FROM nginx:alpine COPY --from=builder /usr/src/nginx-$NGINX_VERSION/objs/ngx_http_upstream_check_module.so /etc/nginx/modules/ # 修改默认配置文件来加载动态模块和支持健康检查功能 RUN echo 'load_module modules/ngx_http_upstream_check_module.so;' >> /etc/nginx/conf.d/default.conf # 将应用特定的配置复制到容器内 COPY conf.d/* /etc/nginx/conf.d/ ``` 此 Dockerfile 中的关键部分在于通过 `--add-dynamic-module` 参数指定了要加入的新模块路径,并且最后一步是确保新的 `.so` 文件被正确放置以便于后续由 Nginx 加载[^1]。 请注意上述命令中的具体路径可能依据实际环境有所变化;此外还需要根据实际情况调整所使用的依赖包列表及其版本号。 完成以上步骤之后就可以利用这个 Dockerfile 来构建自己的 Docker 镜像了。记得在执行 docker build 前先确认所有外部资源都可以正常访问并且能够成功下载下来。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值