Opened 2 weeks ago

Closed 2 weeks ago

#2174 closed defect (invalid)

Confusion Around Time Units for Directives like proxy_read_timeout

Reported by: stephen.m.wick@… Owned by:
Priority: minor Milestone:
Component: documentation Version: 1.19.x
Keywords: Cc:
uname -a: Darwin KCALHML45JQLVDQ 18.7.0 Darwin Kernel Version 18.7.0: Tue Jan 12 22:04:47 PST 2021; root:xnu-4903.278.56~1/RELEASE_X86_64 x86_64
nginx -V: nginx version: nginx/1.19.5
built by gcc 8.3.0 (Debian 8.3.0-6)
built with OpenSSL 1.1.1d 10 Sep 2019
TLS SNI support enabled
configure arguments: --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-http_v2_module --with-mail --with-mail_ssl_module --with-stream --with-stream_realip_module --with-stream_ssl_module --with-stream_ssl_preread_module --with-cc-opt='-g -O2 -fdebug-prefix-map=/data/builder/debuild/nginx-1.19.5/debian/debuild-base/nginx-1.19.5=. -fstack-protector-strong -Wformat -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -fPIC' --with-ld-opt='-Wl,-z,relro -Wl,-z,now -Wl,--as-needed -pie'

Description

The documentation for proxy_read_timeout is a little vague when it comes to the time parameter.

See http://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_read_timeout

Examples in this web page indicate that time can be specified as a number followed by a letter. 60s in this example. The reader must assume that 's' means seconds. It is not described anywhere.

Then in another example of a configuration file, proxy_read_timeout is set to 90 with no letter specifying what units 90 represents.

See http://nginx.org/en/docs/example.html

It would be really nice if the documentation for proxy_read_timeout spelled out that "s" means seconds, "m" means minutes, and that if you don't specify the units, then they default to seconds. I'm guessing of course, even now. I wonder if the default units is actually milliseconds.

Thanks for all of your great work!

Change History (1)

comment:1 by Maxim Dounin, 2 weeks ago

Resolution: invalid
Status: newclosed

Units used in various configuration directives, including the proxy_read_timeout directive, are documented in the Configuration file measurement units article.

Note: See TracTickets for help on using tickets.