动手复现http错误码场景:499,500,502,504
关注微信公众号:nginx,一起交流后端技术知识。
Status Code 499、500、502、504
也是后端Http
服务经常返回的状态码,试想一下,对于每个状态码,如果你能通过一些修改或配置来人为复现它,是不是会更利于你去掌握它呢?本文就是通过动手复现的方式来学习它们。
502,504
在超时的场景下会比较像,经常有人不能区分它们。499
产生的原因也常常会和504
会有内在的关联,你都了解吗?本文不光复现它们,而且会循序渐进,在对比之中复现它们。
下面所有复现的场景,修改nginx或者php-fpm的配置后,记得要重新启动。
一、复现环境说明
系统环境和软件环境为:Linux,Nginx,php-fpm
。
再来介绍一下本文复现会用到的Nginx
和php-fpm
的几个配置。
#nginx超时相关配置:
fastcgi_connect_timeout 5; # nginx连接fastcgi的超时时间
fastcgi_send_timeout 10; #nginx往fastcgi发送参数的超时时间
fastcgi_read_timeout 10; #nginx从fastcig获取数据的超时时间
php-fpm配置:
; The timeout for serving a single request after which the worker process will
; be killed. This option should be used when the 'max_execution_time' ini option
; does not stop script execution for some reason. A value of '0' means 'off'.
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
; Default Value: 0
; 翻译过来就是指一次请求的最长执行时间
request_terminate_timeout = 30s
所有复现场景都是在nginx
根目录下创建一个hello.php
文件,然后通过访问http://127.0.0.1/hello.php
来查看http
响应code
,hello.php
代码如下:
<?php
sleep(7); // 通过调整sleep秒数,来达成不同的复现
echo 'hello world';
?>
下面来逐一复现这些状态码的产生场景。
二、502
定义
502
,Bad Gateway
,网关错误,它往往表示网关从上游服务器中接收到的响应是无效的。
先来了解一下网关是什么含义,从宏观定义上来说只要连接两个不同的网络的设备都可以叫网关,其实具体到应用层Http
请求这一领域,网关就是指是转发其他服务器通信数据的服务器,对于本文的复现环境而言,当客户端请求数据到达nginx
,nginx
负责把请求转交给fastcgi
(即php-fpm
)进行处理,那么在这个场景中Nginx
就是网关。
502
并不是指网关本身出了问题,而是从上游接收响应出了问题,比如由于上游服务自身超时导致不能产生响应数据,或者上游不按照协议约定来返回数据导致网关不能正常解析。
复现路径1
关闭php-fpm
进程,返回502
。
这个比较容易理解,参照上面的定义,因为php-fpm
进程关闭,nginx
连接不上php-fpm
,即nginx
不能收从上层接收到响应数据。
nginx
错误日志如下:
connect() to unix:/home/work/server/php-cgi.sock failed (2: No such file or directory) while connecting to upstream
复现路径2
启动php-fpm
进程,修改php-fpm.conf
的request_terminate_timeout
和php
代码的sleep
时间来复现。
php代码:
<?php
sleep(7);
echo 'hello world';
?>
php-fpm.conf配置:
request_terminate_timeout=5
nginx配置:
fastcgi_read_timeout 10;
php-fpm.conf
设置的最大执行时间是5s,但是php
脚本需要的执行时间大于7s,所以php-fpm
进程执行5s时就回退出,此时php
脚本没有正常执行完成,所以返回给网关Nginx
的数据异常,于是导致502
。
php-fpm
错误日志如下:
script '/home/work/webroot/hello.php' (request: "GET /hello.php") execution timed out (5.161544 sec), terminating
nginx
错误日志如下:
recv() failed (104: Connection reset by peer) while reading response header from upstream
504
定义
504
,Gateway Timeout
,网关超时。
它表示网关没有从上游及时获取响应数据。注意它和502
在超时场景下的区别,502
是指上游php-fpm
因为超过自身允许的执行时间而不能正常生成响应数据,而504
是指在php-fpm
还未执行完成的某一时刻,由于超过了nginx
自身的超时时间,nginx
则以为上游php-fpm
没有按照设置时间返回响应数据就会返回504
, 此时对于php-fpm
而言还会继续执行下去,直到执行完成。
复现路径
php
代码
<?php
sleep(7);
echo 'hello world';
error_log("hello", 3, "/tmp/hello.log");
?>
php-fpm.conf
配置:
request_terminate_timeout=30
nginx
配置:
fastcgi_read_timeout 5;
hello.php
脚本执行时间需要7s,远小于php-fpm
的一次请求的最大请求时间30s,所以php
脚本可以正常完成执行,这个可以查看/tmp/hello.log
文件内容来得到证明。
由于nginx
从php-fpm
读取数据的超时时间为5s,所以在5s的时科,nginx
还未从php-fpm
获取到响应数据,于是返回504
。
nginx
错误日志如下:
upstream timed out (110: Connection timed out) while reading response header from upstream
499
定义
499
, Client Closed Request
, 客户端主动断开连接。
是指一次http请求在客户端指定的时间内没有返回响应,此时,客户端会主动断开连接,此时表象为客户端无响应返回,而nginx
的日志中会status code
为499
。
此状态码在浏览器请求时几乎不可见,因为浏览器默认的超时时间会很长。多见于服务之间的调用,在业务架构中常常会分层设计,拆分为不同的子系统或者微服务,这样系统之间就会常常通过http
方式来请求,并且会设置每次请求的超时时间,当请求在请求时间内所调用的上游服务无返回,则会主动关闭连接,上游服务日志中会记录一条499
。
复现路径
我们用上面504
复现时相同的代码和配置。
php
代码
<?php
sleep(7);
echo 'hello world';
error_log("hello", 3, "/tmp/hello.log");
?>
php-fpm.conf
配置:
request_terminate_timeout=30
nginx
配置:
fastcgi_read_timeout 5;
我们在linux
终端使用curl
命令来请求,-m
表示超时时间,单位为秒
curl -i -m 3 http://127.0.0.1/hello.php
返回为:
curl: (28) Operation timed out after 3004 milliseconds with 0 bytes received
nginx
的access
日志的code
为499
,如下:
"HEAD /hello.php HTTP/1.1" 499 0
500
定义
500
, Internal Server Error
, 服务器内部错误,服务器遇到了一个未曾预料的状况,导致了它无法完成对请求的处理。
日常开发中500
错误几乎都是由于php
脚本语法出现错误导致php-fpm
无法正常执行。
复现路径
php
代码:
<?php
echo 'hello '
echo ' world';
?>
由于php
代码语法错误,php-fpm
执行失败,然后告诉nginx
这一结果,nginx
则返回500
。
php
错误日志:
PHP Parse error: syntax error, unexpected 'echo' (T_ECHO), expecting ',' or ';' in /home/work/webroot/hello.php on line 3
总结
-
499
是由于超过客户端设置的请求超时时间,客户端主动关闭连接,服务器code
为499
。 -
500
多是由于代码语法错误,导致CGI
执行错误并且会把错误结果通知服务器,服务器则报500
。 -
502
是由于CGI
由于在自身的执行时间要求内无法按时完成,则无法返回给服务器正常响应,此时服务器会返回502
。 -
504
是CGI
在服务器设置的超时时间内无法按时返回响应,服务器则返回504
。 -
499,502,504
都会因为超时而产生,区别是超时超了谁的时,499
是超了客户端本身的连接时间,502
是超了CGI
的执行时间,504
是超了服务器本身的最大允许读取时间。