Core functionality

优质

小牛编辑

133浏览

2023-12-01

指令

Syntax: force_exit exit_time; Default: — Context: main

强制worker进程在接受到QUIT信号后 exit_time 时间退出。

force_exit功能默认没有编译开启。需要编译时开启:

./configure --with-force-exit

注意：Tengine-2.3.0 版本后废弃force_exit指令,使用Nginx官方worker_shutdown_timeout指令替代，详细文档

Syntax: worker_processes [num | auto] Default: worker_processes auto Context: core

为worker_processes增加参数auto。当设置成auto，tengine将自动启动与cpu数量相同的worker进程。

Syntax: master_env variable[=value]; Default: - Context: core

当使用master_env指令设置NGX_DNS_RESOLVE_BACKUP_PATH环境变量后将会开启dns缓存容灾逻辑。即当dns服务器不可用时，使用上次dns缓存的A记录。比如设置master_env NGX_DNS_RESOLVE_BACKUP_PATH=/home/tengine/worker/dnscache/path; 将会把配置中的域名解析结果缓存到NGX_DNS_RESOLVE_BACKUP_PATH所设置的路径下。

Syntax: worker_cpu_affinity [mask1 mask2 mask3 ... | auto | off ] Default: worker_cpu_affinity off Context: core

为worker_cpu_affinity增加参数auto和off。当设置成auto时，tengine将根据worker的数量自动配置cpu绑定位图。绑定的顺序是按CPU编号从大到小。如果worker数量大于cpu数量，则剩余的worker进程将按照CPU编号从大到小的顺序从编号最大的CPU开始再次绑定。例如：某CPU有8核，

worker数量是4，则自动配置的绑定位图是10000000, 01000000, 00100000, 00010000
worker数量是8，则自动配置的绑定位图是10000000, 01000000, 00100000, 00010000, 00001000, 00000100, 00000010, 00000001
worker数量是10，则自动配置的绑定位图是10000000, 01000000, 00100000, 00010000, 00001000, 00000100, 00000010, 00000001, 10000000, 01000000

当设置成off时，tengine不会进行cpu绑定。

worker_cpu_affinity的error log最多显示64个CPU的绑定情况。

Syntax: error_page code ... [default] [=[response]] Default: - Context: http, server, location, if in location

该指令用于设置如果出现指定的HTTP错误状态码，返回给客户端显示的对应uri地址。

支持default，可以把上一级设置的error_page重新设定；
修正error_page不能发现重复的code的问题，不能正常继承上一级设置的问题。

举例：

http {
    error_page 404 /404.html;

    server {
        error_page 404 default;
    }
}

server中的"error_page"指令将404的页面还原成系统默认。

Syntax: msie_padding [on | off] Default: msie_padding off Context: http, server, location

此指令关闭或开启MSIE浏览器的msie_padding特性，若启用选项，nginx会为response头部填满512字节，这样就阻止了相关浏览器会激活友好错误界面，因此不会隐藏更多的错误信息。Tengine中默认关闭此功能。

Syntax: request_time_cache [on | off] Default: request_time_cache on Context: http, server, location

设置成'off'时，Tengine将不使用时间缓存，$request_time、$request_time_msec和$request_time_usec将会得到更精确的时间。

Syntax: log_empty_request [on | off] Default: log_empty_request on Context: http, server, location

设置成'off'时，Tengine将不会记录没有发送任何数据的访问日志。默认情况下，Tengine会在访问日志里面记录一条400状态的日志。

Syntax: server_admin admin Default: none Context: http, server, location

设置网站管理员信息，当打开server_info的时候，显示错误页面时会显示该信息。

Syntax: server_info on | off Default: server_info on Context: http, server, location

当打开server_info的时候，显示错误页面时会显示URL、服务器名称和出错时间。

Syntax: server_tag off | customized_tag Default: none Context: http, server, location

自定义设置HTTP响应的server头，‘off’可以禁止返回server头。如果什么都不设置，就是返回默认Nginx的标识。

Syntax: reuse_port on | off Default: reuse_port off Context: events

当打开reuse_port的时候，支持SO_REUSEPORT套接字参数，Linux从3.9开始支持。

注意：Tengine-2.3.0 版本后废弃reuse_port指令，使用Nginx官方的reuseport。升级方法：将events配置块里面的reuse_port on|off 释掉，在对应的监听端口后面加reuseport参数、详细参考文档。

测试报告

Syntax: pipe:rollback [logpath] interval=[interval] baknum=[baknum] maxsize=[maxsize] Default: none Context: http, server, location

日志pipe功能使用独立进程打印日志，不会阻塞worker进程，worker进程与独立日志进程间通过pipe进行通讯，rollback功能依赖日志pipe功能，提供基于tengine自身的日志回滚功能，支持，按照时间间隔、文件大小进行回滚，并支持配置，backup文件的个数。日志回滚模块会按照配置的条件将log文件rename成backup文件，然后重新写新日志文件

该功能配置集成在access_log和error_log指令中：类似如下配置

access_log "pipe:rollback [logpath] interval=[interval] baknum=[baknum] maxsize=[maxsize]" proxyformat;

error_log  "pipe:rollback [logpath] interval=[interval] baknum=[baknum] maxsize=[maxsize]" info;

logpath: 日志输出路径

interval：日志回滚间隔，默认0（永不回滚）

baknum：backup文件保留个数，默认1（保留1个）

maxsize：log文件最大size，默认0（永不回滚）

使用示例：

error_log  "pipe:rollback logs/error_log interval=60m baknum=5 maxsize=2048M" info;

http {
    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for"';
    access_log  "pipe:rollback logs/access_log interval=1h baknum=5 maxsize=2G"  main;
}

Syntax: server_name name; Default: — Context: server

在Stream模块中，server_name 可以用来允许多个server块监听同一个ip:port。Tengine会根据TLS的SNI来决定请求连接匹配到哪个server块。这意味着，Stream模块的server_name必须用在SSL卸载的情况下（即listen指令后面有ssl这个参数）。

Stream模块中的server_name 默认是不开启的. 你需要这么显示的编译:

./configure --with-stream_sni

注意: 这个特性是实验性的。如果Nginx官方有类似的功能和该功能有冲突，那么改功能将被废弃。

Syntax: ssl_sni_force on | off Default: ssl_sni_force off Context: stream, server

在Stream模块中，ssl_sni_force决定了如果TLS的SNI和配置的server_name不匹配，TLS握手是否被拒绝。

注意: 详见server_name的注意点.

Syntax: http2 on | off Default: http2 off Context: http

可针对域名开启或者关闭 http2。监听相同ip:port的server块默认都同时开启或者同时关闭HTTP2。该指令可以针对某一个server块开启HTTP2。

例子:

http {
    server {
        listen 443 http2;
        server_name www.taobao.com;
        ......
    }
 
    server {
        listen 443;
        server_name www.tmall.com;
        #针对"www.tmall.com"关闭HTTP2
        http2 off;
        ......
    }
}