模块 ngx_http_memcached_module

ngx_http_memcached_module 模块用于从 memcached 服务器获取响应。键通过 $memcached_key 变量设置。响应应预先通过 Nginx 外部的方式放入 memcached 中。

server {
    location / {
        set            $memcached_key "$uri?$args";
        memcached_pass host:11211;
        error_page     404 502 504 = @fallback;
    }

    location @fallback {
        proxy_pass     http://backend;
    }
}

使出站连接到 memcached 服务器时源自指定的本地 IP 地址，可选用端口 (1.11.2)。参数值可以包含变量 (1.3.12)。特殊值 off (1.3.12) 取消继承自上一配置级别的 memcached_bind 指令的效果，这允许系统自动分配本地 IP 地址和端口。

transparent 参数 (1.11.0) 允许出站连接到 memcached 服务器时源自非本地 IP 地址，例如，源自客户端的真实 IP 地址

memcached_bind $remote_addr transparent;

为了使此参数生效，通常需要以 超级用户 权限运行 Nginx worker 进程。在 Linux 上则不需要 (1.13.8)，因为如果指定了 transparent 参数，worker 进程会从主进程继承 CAP_NET_RAW 能力。还需要配置内核路由表来截获来自 memcached 服务器的网络流量。

memcached_buffer_size 4k|8k;

设置用于读取从 memcached 服务器接收到的响应的缓冲区 size。响应一旦接收到就会同步传递给客户端。

memcached_connect_timeout 60s;

定义与 memcached 服务器建立连接的超时时间。需要注意的是，此超时时间通常不能超过 75 秒。

启用对 memcached 服务器响应中是否存在 flag 的测试，如果设置了该标志，则将响应头字段 “Content-Encoding” 设置为 “gzip”。

memcached_next_upstream error timeout;

指定在哪些情况下请求应该传递给下一个服务器

error

在与服务器建立连接、传递请求或读取响应头时发生错误；

timeout

在与服务器建立连接、传递请求或读取响应头时发生超时；

invalid_response

服务器返回空响应或无效响应；

not_found

在服务器上未找到响应；

off

禁用将请求传递给下一个服务器。

应该记住，只有在尚未向客户端发送任何内容的情况下，才可以将请求传递给下一个服务器。也就是说，如果在传输响应过程中发生错误或超时，则无法修复。

此指令还定义了与服务器通信的何种情况被视为失败尝试。error、timeout 和 invalid_response 情况总是被视为失败尝试，即使指令中未指定它们。not_found 情况从不被视为失败尝试。

将请求传递给下一个服务器可以受到 尝试次数 和 时间 的限制。

memcached_next_upstream_timeout 0;

限制请求可以传递给下一个服务器的时间。0 值表示关闭此限制。

memcached_next_upstream_tries 0;

限制将请求传递给下一个服务器的可能尝试次数。0 值表示关闭此限制。

设置 memcached 服务器地址。地址可以指定为域名、IP 地址及端口

memcached_pass localhost:11211;

或 UNIX 域套接字路径

memcached_pass unix:/tmp/memcached.socket;

如果域名解析为多个地址，它们将全部以轮询方式使用。此外，地址还可以指定为服务器组。

memcached_read_timeout 60s;

定义从 memcached 服务器读取响应的超时时间。此超时时间仅设置在两次连续的读取操作之间，而不是针对整个响应的传输。如果 memcached 服务器在此时间内没有传输任何内容，则连接将关闭。

memcached_send_timeout 60s;

设置向 memcached 服务器传输请求的超时时间。此超时时间仅设置在两次连续的写入操作之间，而不是针对整个请求的传输。如果 memcached 服务器在此时间内没有收到任何内容，则连接将关闭。

memcached_socket_keepalive off;

配置出站连接到 memcached 服务器的“TCP keepalive”行为。默认情况下，套接字使用操作系统的设置。如果指令设置为值 “on”，则套接字将启用 SO_KEEPALIVE 套接字选项。

$memcached_key

定义用于从 memcached 服务器获取响应的键。