Nginx之数据流代理stream模块简介和使用

一、stream模块简介

  stream模块一般用于TCP/UDP数据流的代理和负载均衡，通过stream模块我们可以代理转发tcp报文。ngx_stream_core_module模块从1.9.0版开始提供。默认情况下，此模块不是构建的，应该使用–with stream配置参数启用它，即我们需要使用./configure --with-stream的方式在编译的时候将stream模块添加进去。stream模块用法和http模块差不多，语法也基本相同。

二、使用场景说明

  stream主要有两个可用场景。一是实现流量的代理转发，这里所说的代理转发是只某些端口服务是有源IP地址限制的，例如mysql账户一般是限制了源地址为应用服务器，nginx可能同时是WEB应用服务器，开发人员需要验证一些数据库数据问题，但是账户源地址有限制，此时通过nginx进行数据流转发就可以实现开发终端到mysql的访问。二是实现流量的负载均衡，我们有多个tcp或者udp端口服务（比如DNS），通过stream模块我们可以实现数据流的负载均衡，支持负载均衡算法包括轮询、最小连接数、ip_hash等。

三、配置示例

0、stream块配置

stream块配置与http块并列，在nginx.conf中配置，可以用include方式将我们配置实例单独配置，方便管理。

stream {
    log_format proxy '$remote_addr [$time_local] ' '$protocol $status $bytes_sent $bytes_received ' '$session_time "$upstream_addr" ' '"$upstream_bytes_sent" "$upstream_bytes_received" "$upstream_connect_time"';
    access_log /var/log/nginx/tcp-access.log proxy ;
    open_log_file_cache off;
    include /etc/nginx/conf.d/*.stream;
}

1、tcp端口数据流代理

#cat tcp_3306.stream

############################################################################
### 这是一个tcp 3306端口代理的配置示例
############################################################################
server {
    listen 3306; #需要监听的端口
    proxy_connect_timeout 5s;
    proxy_timeout 30s;
    proxy_pass 192.168.10.151:3306; #需要代理的端口
}

2、负载均衡配置

#cat load_udp_53.stream

############################################################################
### 这是一个udp 53端口负载均衡的配置示例
############################################################################
upstream mydns {
    hash $remote_addr consistent; #配置ip_hash方式，默认轮询
    server 192.168.10.10:53; #这里配置成要访问的地址和端口
    server 192.168.10.20:53;
    server 192.168.10.30:53; 
}
server {
    listen 53 udp reuseport; #需要监听的端口，因为udp非可靠传输协议，使用reuseport保证请求分配到统一会话中
    proxy_connect_timeout 5s;
    proxy_timeout 20s;
    proxy_pass mydns;
}

四、QA

1、配置检查时报错unknown directive “stream”

• 报错信息
  nginx: [emerg] unknown directive “stream” in /etc/nginx/nginx.conf:77
  nginx: configuration file /etc/nginx/nginx.conf test failed
• 报错原因：未找到stream模块
• 解决方案：
  在nginx.conf配置文件首行添加如下内容：
  load_module /usr/lib64/nginx/modules/ngx_stream_module.so;

2、添加ngx_stream_module.so模块时报错

• 报错信息：
  ls: cannot access /usr/lib/nginx/modules: No such file or directory
• 报错原因：
  ngx_stream_module.so模块路径错误
• 解决方案：
  使用nginx -V命令查看nginx的模块安装路径，