ngx_stream_core_module

Module ngx_stream_core_module

• 示例配置

• 指令

• 听

• preread_buffer_size

• preread_timeout

• proxy_protocol_timeout

• 解决

• resolver_timeout

• 服务器

• 流

• tcp_nodelay

• variables_hash_bucket_size

• variables_hash_max_size

• 嵌入式变量

该ngx_stream_core_module模块自1.9.0版开始可用。该模块不是默认生成的，它应该使用--with-stream配置参数启用。

示例配置

worker_processes auto;

error_log /var/log/nginx/error.log info;

events {
    worker_connections  1024;
}

stream {
    upstream backend {
        hash $remote_addr consistent;

        server backend1.example.com:12345 weight=5;
        server 127.0.0.1:12345            max_fails=3 fail_timeout=30s;
        server unix:/tmp/backend3;
    }

    upstream dns {
       server 192.168.0.1:53535;
       server dns.example.com:53;
    }

    server {
        listen 12345;
        proxy_connect_timeout 1s;
        proxy_timeout 3s;
        proxy_pass backend;
    }

    server {
        listen 127.0.0.1:53 udp;
        proxy_responses 1;
        proxy_timeout 20s;
        proxy_pass dns;
    }

    server {
        listen [::1]:12345;
        proxy_pass unix:/tmp/stream.socket;
    }
}

指令

设置address以及port对哪些服务器将接受连接插座。可以只指定端口。地址也可以是主机名，例如：

listen 127.0.0.1:12345;
listen *:12345;
listen 12345;     # same as *:12345
listen localhost:12345;

IPv6地址在方括号中指定：

listen [::1]:12345;
listen [::]:12345;

UNIX域套接字用“ unix:”前缀指定：

listen unix:/var/run/nginx.sock;

该ssl参数允许指定此端口上接受的所有连接都应该在SSL模式下工作。

该udp参数配置了一个用于处理数据报的监听套接字（1.9.13）。

的proxy_protocol参数（1.11.4）允许指定这个端口上接受的所有连接应使用代理服务器协议。

该listen指令可以具有特定于套接字相关系统调用的几个附加参数。

backlog= 在限制未决连接队列（1.9.2）队列的最大长度的调用中number设置backlog参数listen()。默认情况下，backlog在FreeBSD，DragonFly BSD和macOS上设置为-1，在其他平台上设置为511。rcvbuf= size设置SO_RCVBUF侦听套接字（1.11.13）的接收缓冲区大小（选项）。sndbuf= size设置SO_SNDBUF侦听套接字（1.11.13）的发送缓冲区大小（选项）。bind此参数指示bind()为给定地址：端口对进行单独调用。事实是，如果有几个listen指令具有相同的端口但地址不同，并且其中一个listen指令侦听给定端口的所有地址（*:port），nginx将bind()只会*:port。应该注意的getsockname()是，在这种情况下系统调用将确定接受连接的地址。如果使用ipv6only或so_keepalive参数，那么对于给定的address：port对bind()将始终进行单独的呼叫。ipv6only= on| off此参数确定（通过IPV6_V6ONLY套接字选项）侦听通配符地址的IPv6套接字是[::]仅接受IPv6连接还是接受IPv6和IPv4连接。该参数默认打开。它只能在启动时设置一次。reuseport这个参数（1.9.1）指示为每个工作进程创建一个单独的监听套接字（使用SO_REUSEPORT套接字选项），允许内核在工作进程之间分配传入连接。目前这只适用于Linux 3.9+和DragonFly BSD。

不恰当地使用此选项可能会产生其安全隐患。

so_keepalive= on| off| keepidle：keepintvl：keepcnt 此参数配置为监听套接字的“TCP保活”的行为。如果省略此参数，则操作系统的设置将对套接字有效。如果它被设置为值“ on”，则SO_KEEPALIVE该插座的选项被打开。如果它设置为值“ off”，SO_KEEPALIVE则关闭套接字选项。在每个插槽的基础使用的TCP保活参数某些操作系统支持设置TCP_KEEPIDLE，TCP_KEEPINTVL和TCP_KEEPCNT套接字选项。在这样的系统（目前，Linux的2.4 +，NetBSD的5+和FreeBSD 9.0-STABLE），它们可以使用配置的keepidle，keepintvl和keepcnt参数。一个或两个参数可以省略，在这种情况下，相应套接字选项的系统默认设置将生效。例如，

so_keepalive=30m::10

会将空闲超时（TCP_KEEPIDLE）设置为30分钟，将探测间隔（TCP_KEEPINTVL）保留在其系统默认值下，并将探测计数（TCP_KEEPCNT）设置为10个探测。

不同的服务器必须监听不同的address：port对。

指定一个size预读缓冲区。

指定timeout预读取阶段。

指定timeout用于读取PROXY协议头以完成。如果在这段时间内没有发送完整的报头，则连接关闭。

将用于解析上游服务器名称的名称服务器配置为地址，例如：

resolver 127.0.0.1 [::1]:5353;

地址可以指定为域名或IP地址，以及可选端口。如果未指定端口，则使用端口53。名称服务器以循环方式查询。

默认情况下，nginx会在解析时查找IPv4和IPv6地址。如果不想查找IPv6地址，则ipv6=off可以指定参数。

默认情况下，nginx使用响应的TTL值缓存答案。可选valid参数允许覆盖它：

resolver 127.0.0.1 [::1]:5353 valid=30s;

在版本1.11.3之前，该指令作为我们的商业订阅的一部分提供。

设置名称解析超时，例如：

resolver_timeout 5s;

在版本1.11.3之前，该指令作为我们的商业订阅的一部分提供。

设置服务器的配置。

提供指定流服务器指令的配置文件上下文。

启用或禁用该TCP_NODELAY选项的使用。该选项对客户端和代理服务器连接均启用。

设置变量哈希表的桶大小。设置散列表的细节在单独的文档中提供。

设置size变量哈希表的最大值。设置散列表的细节在单独的文档中提供。

嵌入式变量

该ngx_stream_core_module模块自1.11.2开始支持变量。

$binary_remote_addr客户端地址以二进制形式表示，值的长度始终为IPv4地址的4个字节或IPv6地址的16个$bytes_received字节从客户端接收的字节数（1.11.4）$bytes_sent发送到客户端$connection连接的字节数序列号$hostname主机名$msec当前时间（以秒为单位）以毫秒为单位解析用于与客户端通信的工作进程协议的$nginx_versionnginx版本$pidPID $protocol：TCP或UDP（1.11.4）$proxy_protocol_addr来自PROXY协议头的客户端地址，否则为空字符串（1.11.4）

通过proxy_protocol在listen指令中设置参数，必须先启用PROXY协议。

$proxy_protocol_port 来自PROXY协议头的客户端端口，否则为空字符串（1.11.4）

通过proxy_protocol在listen指令中设置参数，必须先启用PROXY协议。

$remote_addr客户端地址$remote_port客户端端口$server_addr接受连接的服务器的地址

计算此变量的值通常需要一次系统调用。为了避免系统调用，listen指令必须指定地址并使用bind参数。

$server_port$session_time以毫秒为单位的分辨率（1.11.4）以秒为单位接受连接会话持续时间的服务器的端口; $status会话状态（1.11.4），可以是下列之一：200会话成功完成400客户端数据不能被解析，例如，代理协议报头403接入禁止的，例如，当访问被限制为某些客户端的地址500内部服务器错误502坏网关，例如，如果无法选择或到达上游服务器。503服务不可用，例如，当访问受限于$time_iso8601本地时间的本地时间以ISO 8601标准格式的$time_local本地时间的通用日志格式