nginx状态码源码分析 – 作者:stan1y

nginx状态码处理函数

nginx状态码分为五大类：
100-199 用于指定客户端应相应的某些动作。
200-299 用于表示请求成功。
300-399 用于已经移动的文件并且常被包含在定位头信息中指定新的地址信息。
400-499 用于指出客户端的错误。
500-599 用于支持服务器错误。

200 （成功） 服务器已成功处理了请求。 通常，这表示服务器提供了请求的网页。
201 （已创建） 请求成功并且服务器创建了新的资源。
202 （已接受） 服务器已接受请求，但尚未处理。
203 （非授权信息） 服务器已成功处理了请求，但返回的信息可能来自另一来源。
204 （无内容） 服务器成功处理了请求，但没有返回任何内容。
205 （重置内容） 服务器成功处理了请求，但没有返回任何内容。206 （部分内容） 服务器成功处理了部分 GET 请求。

300 （多种选择） 针对请求，服务器可执行多种操作。 服务器可根据请求者 (user agent) 选择一项操作，或提供操作列表供请求者选择。
301 （永久移动） 请求的网页已永久移动到新位置。 服务器返回此响应（对 GET 或 HEAD 请求的响应）时，会自动将请求者转到新位置。302 （临时移动） 服务器目前从不同位置的网页响应请求，但请求者应继续使用原有位置来进行以后的请求。303 （查看其他位置） 请求者应当对不同的位置使用单独的 GET 请求来检索响应时，服务器返回此代码。304 （未修改） 自从上次请求后，请求的网页未修改过。 服务器返回此响应时，不会返回网页内容。
305 （使用代理） 请求者只能使用代理访问请求的网页。 如果服务器返回此响应，还表示请求者应使用代理。
307 （临时重定向） 服务器目前从不同位置的网页响应请求，但请求者应继续使用原有位置来进行以后的请求。

400 （错误请求） 服务器不理解请求的语法。
401 （未授权） 请求要求身份验证。 对于需要登录的网页，服务器可能返回此响应。
403 （禁止） 服务器拒绝请求。404 （未找到） 服务器找不到请求的网页。405 （方法禁用） 禁用请求中指定的方法。
406 （不接受） 无法使用请求的内容特性响应请求的网页。
407 （需要代理授权） 此状态代码与 401（未授权）类似，但指定请求者应当授权使用代理。408 （请求超时） 服务器等候请求时发生超时。
409 （冲突） 服务器在完成请求时发生冲突。 服务器必须在响应中包含有关冲突的信息。
410 （已删除） 如果请求的资源已永久删除，服务器就会返回此响应。
411 （需要有效长度） 服务器不接受不含有效内容长度标头字段的请求。
412 （未满足前提条件） 服务器未满足请求者在请求中设置的其中一个前提条件。
413 （请求实体过大） 服务器无法处理请求，因为请求实体过大，超出服务器的处理能力。
414 （请求的 URI 过长） 请求的 URI（通常为网址）过长，服务器无法处理。
415 （不支持的媒体类型） 请求的格式不受请求页面的支持。
416 （请求范围不符合要求） 如果页面无法提供请求的范围，则服务器会返回此状态代码。
417 （未满足期望值） 服务器未满足”期望”请求标头字段的要求。

500 （服务器内部错误） 服务器遇到错误，无法完成请求。
501 （尚未实施） 服务器不具备完成请求的功能。 例如，服务器无法识别请求方法时可能会返回此代码。
502 （错误网关） 服务器作为网关或代理，从上游服务器收到无效响应。
503 （服务不可用） 服务器目前无法使用（由于超载或停机维护）。 通常，这只是暂时状态。
504 （网关超时） 服务器作为网关或代理，但是没有及时从上游服务器收到请求。
505 （HTTP 版本不受支持） 服务器不支持请求中所用的 HTTP 协议版本。

nginx记录状态码的函数是ngx_http_reqstat_log_handler。

这个函数在ngx_http_reqstat_init函数放在log phase阶段中。

static ngx_int_t ngx_http_reqstat_init(ngx_conf_t *cf)

{

…

h = ngx_array_push(&cmcf->phases[NGX_HTTP_LOG_PHASE].handlers);

*h = ngx_http_reqstat_log_handler;

…

}

接下来根据保存好的状态码来进行记录

static ngx_int_t ngx_http_reqstat_log_handler(ngx_http_request_t *r)

{

…

// 判断status

if (r->err_status) {

status = r->err_status;

} else if (r->headers_out.status) {

status = r->headers_out.status;

} else if (r->http_version == NGX_HTTP_VERSION_9) {

status = 9;

} else {

status = 0;

}

// 接下来根据status来进行判断，对全部的req状态码进行处理

switch (status) {

case 500:

ngx_http_reqstat_count(fnode, NGX_HTTP_REQSTAT_500, 1);

break;

case 502:

ngx_http_reqstat_count(fnode, NGX_HTTP_REQSTAT_502, 1);

break;

// 处理5xx和4xx，注意这里upstream_states是个数组，他这块选取的是最后一个元素的状态码，原因在于下方代码块

if (r->upstream_states != NULL && r->upstream_states->nelts > 0) {

ngx_http_upstream_state_t *state = r->upstream_states->elts;

status = state[r->upstream_states->nelts – 1].status;

if (status >= 400 && status < 500) {

ngx_http_reqstat_count(fnode, NGX_HTTP_REQSTAT_UPS_4XX, 1);

} else if (status >= 500 && status < 600) {

ngx_http_reqstat_count(fnode, NGX_HTTP_REQSTAT_UPS_5XX, 1);

} else if (status >= 200 && status < 300) {

ngx_http_reqstat_count(fnode, NGX_HTTP_REQSTAT_UPS_2XX, 1);

}

}

…

}

upstream与状态码

ngx_http_upstream_connect过程中，每次连接都会使用一个新的state，这是个array。

void ngx_http_upstream_connect(ngx_http_request_t *r, ngx_http_upstream_t *u)

{

…

// 从states中取出一个state，来记录后端的状态

u->state = ngx_array_push(r->upstream_states);

ngx_memzero(u->state, sizeof(ngx_http_upstream_state_t));

rc = ngx_event_connect_peer(&u->peer);

// busy代表了后端断连了

if (rc == NGX_BUSY) {

ngx_log_error(NGX_LOG_ERR, r->connection->log, 0, “no live upstreams”);

ngx_http_upstream_next(r, u, NGX_HTTP_UPSTREAM_FT_NOLIVE);

return;

}

// 如果connect阶段没问题，发送request

ngx_http_upstream_send_request(r, u, 1);

…

}

static void ngx_http_upstream_send_request(ngx_http_request_t *r, ngx_http_upstream_t *u, ngx_uint_t do_write)

{

…

// 获取状态码

rc = ngx_http_upstream_send_request_body(r, u, do_write);

if (rc == NGX_ERROR) {

ngx_http_upstream_next(r, u, NGX_HTTP_UPSTREAM_FT_ERROR);

return;

}

// 状态码异常，使用该状态码结束请求

if (rc >= NGX_HTTP_SPECIAL_RESPONSE) {

ngx_http_upstream_finalize_request(r, u, rc);

return;

}

…

}

这块是判断健康检查失败如何判断出来的，是在get round robin peer的时候判断健康检查

ngx_int_t ngx_http_upstream_get_round_robin_peer(ngx_peer_connection_t *pc, void *data)

{

…

#if (NGX_HTTP_UPSTREAM_CHECK)

if (ngx_http_upstream_check_peer_down(peer->check_index)) {

goto failed;

}

#endif

failed:

return NGX_BUSY;

…

}

ngx_http_upstream_next分析

static void ngx_http_upstream_next(ngx_http_request_t *r, ngx_http_upstream_t *u,

ngx_uint_t ft_type)

{

…

switch (ft_type) {

case NGX_HTTP_UPSTREAM_FT_TIMEOUT:

status = NGX_HTTP_GATEWAY_TIME_OUT;

break;

case NGX_HTTP_UPSTREAM_FT_HTTP_500:

status = NGX_HTTP_INTERNAL_SERVER_ERROR;

break;

case NGX_HTTP_UPSTREAM_FT_HTTP_403:

status = NGX_HTTP_FORBIDDEN;

break;

case NGX_HTTP_UPSTREAM_FT_HTTP_404:

status = NGX_HTTP_NOT_FOUND;

break;

/*

* NGX_HTTP_UPSTREAM_FT_BUSY_LOCK and NGX_HTTP_UPSTREAM_FT_MAX_WAITING

* never reach here

*/

default:

status = NGX_HTTP_BAD_GATEWAY;

if (status) {

u->state->status = status;

timeout = u->conf->next_upstream_timeout;

// 以这个status终结

ngx_http_upstream_finalize_request(r, u, status);

…

}

请求结束状态码的处理

ngx_http_upstream_finalize_request中，会调用finalize request。

void ngx_http_upstream_finalize_request(ngx_http_request_t *r,

ngx_http_upstream_t *u, ngx_int_t rc)

{

…

// 以这个状态码结束request

ngx_http_finalize_request(r, rc);

…

}

void ngx_http_finalize_request(ngx_http_request_t *r, ngx_int_t rc)

{

…

// 状态码异常

if (rc >= NGX_HTTP_SPECIAL_RESPONSE

|| rc == NGX_HTTP_CREATED

|| rc == NGX_HTTP_NO_CONTENT)

{

if (rc == NGX_HTTP_CLOSE) {

ngx_http_terminate_request(r, rc);

return;

}

if (r == r->main) {

if (c->read->timer_set) {

ngx_del_timer(c->read);

}

if (c->write->timer_set) {

ngx_del_timer(c->write);

}

}

c->read->handler = ngx_http_request_handler;

c->write->handler = ngx_http_request_handler;

// 特殊状态码回调handler

ngx_http_finalize_request(r, ngx_http_special_response_handler(r, rc));

return;

}

…

}

ngx_int_t ngx_http_special_response_handler(ngx_http_request_t *r, ngx_int_t error)

{

…

// err_status赋值

r->err_status = error;

// 接下来是错误页的返回

…

}

lantency状态码计数

真正展示状态码技术的是这个函数

location /check_req_status {

req_status_show req_server_status;

}

static ngx_int_t ngx_http_reqstat_show_handler(ngx_http_request_t *r)

{

…

for (j = 0; j < rlcf->user_select->nelts; j++) {

if (user[j] < NGX_HTTP_REQSTAT_RSRV) {

index = user[j];

b->last = ngx_slprintf(b->last, b->end, “%uA,”,

*NGX_HTTP_REQSTAT_REQ_FIELD(node,

ngx_http_reqstat_fields[index]));

} else {

index = user[j] – NGX_HTTP_REQSTAT_RSRV;

b->last = ngx_slprintf(b->last, b->end, “%uA,”,

*NGX_HTTP_REQSTAT_REQ_FIELD(node,

NGX_HTTP_REQSTAT_EXTRA(index)));

}

}

…

}

off_t ngx_http_reqstat_fields[NGX_HTTP_REQSTAT_RSRV] = {

NGX_HTTP_REQSTAT_BYTES_IN,

NGX_HTTP_REQSTAT_BYTES_OUT,

NGX_HTTP_REQSTAT_CONN_TOTAL,

NGX_HTTP_REQSTAT_REQ_TOTAL,

NGX_HTTP_REQSTAT_2XX,

NGX_HTTP_REQSTAT_3XX,

NGX_HTTP_REQSTAT_4XX,

NGX_HTTP_REQSTAT_5XX,

NGX_HTTP_REQSTAT_OTHER_STATUS,

NGX_HTTP_REQSTAT_RT,

NGX_HTTP_REQSTAT_UPS_REQ,

NGX_HTTP_REQSTAT_UPS_RT,

NGX_HTTP_REQSTAT_UPS_TRIES,

NGX_HTTP_REQSTAT_200,

NGX_HTTP_REQSTAT_206,

NGX_HTTP_REQSTAT_302,

NGX_HTTP_REQSTAT_304,

NGX_HTTP_REQSTAT_403,

NGX_HTTP_REQSTAT_404,

NGX_HTTP_REQSTAT_416,

NGX_HTTP_REQSTAT_499,

NGX_HTTP_REQSTAT_500,

NGX_HTTP_REQSTAT_502,

NGX_HTTP_REQSTAT_503,

NGX_HTTP_REQSTAT_504,

NGX_HTTP_REQSTAT_508,

NGX_HTTP_REQSTAT_OTHER_DETAIL_STATUS,

NGX_HTTP_REQSTAT_UPS_4XX,

NGX_HTTP_REQSTAT_UPS_5XX,

NGX_HTTP_REQSTAT_UPS_2XX,

NGX_HTTP_REQSTAT_UPS_LATENCY

};

新版的tenginx去掉了NGX_HTTP_REQSTAT_UPS_2XX（因为和NGX_HTTP_REQSTAT_2XX一致）

off_t ngx_http_reqstat_fields[30] = {

NGX_HTTP_REQSTAT_BYTES_IN,

NGX_HTTP_REQSTAT_BYTES_OUT,

NGX_HTTP_REQSTAT_CONN_TOTAL,

NGX_HTTP_REQSTAT_REQ_TOTAL,

NGX_HTTP_REQSTAT_2XX,

NGX_HTTP_REQSTAT_3XX,

NGX_HTTP_REQSTAT_4XX,

NGX_HTTP_REQSTAT_5XX,

NGX_HTTP_REQSTAT_OTHER_STATUS,

NGX_HTTP_REQSTAT_RT,

NGX_HTTP_REQSTAT_UPS_REQ,

NGX_HTTP_REQSTAT_UPS_RT,

NGX_HTTP_REQSTAT_UPS_TRIES,

NGX_HTTP_REQSTAT_200,

NGX_HTTP_REQSTAT_206,

NGX_HTTP_REQSTAT_302,

NGX_HTTP_REQSTAT_304,

NGX_HTTP_REQSTAT_403,

NGX_HTTP_REQSTAT_404,

NGX_HTTP_REQSTAT_416,

NGX_HTTP_REQSTAT_499,

NGX_HTTP_REQSTAT_500,

NGX_HTTP_REQSTAT_502,

NGX_HTTP_REQSTAT_503,

NGX_HTTP_REQSTAT_504,

NGX_HTTP_REQSTAT_508,

NGX_HTTP_REQSTAT_OTHER_DETAIL_STATUS,

NGX_HTTP_REQSTAT_UPS_4XX,

NGX_HTTP_REQSTAT_UPS_5XX,

NGX_HTTP_REQSTAT_UPS_LATENCY

};

lantency状态码修改

之前的tengine2.2.0的nginx_version是1008001

tengine2.3.0的nginx_version是1015009

#if nginx_version >= 1009002，所以使用最新的时间结构。

typedef struct {

ngx_uint_t                       status;

ngx_msec_t                       response_time;

ngx_msec_t                       connect_time;

ngx_msec_t                       header_time;

ngx_msec_t                       queue_time;

off_t                            response_length;

off_t                            bytes_received;

off_t                            bytes_sent;

ngx_str_t                       *peer;

} ngx_http_upstream_state_t;

u->start_time = ngx_current_msec;

u->state->response_time = (ngx_msec_t) -1;

u->state->connect_time = (ngx_msec_t) -1;

u->state->header_time = (ngx_msec_t) -1;

而header time的时间为

static void ngx_http_upstream_process_header(ngx_http_request_t *r, ngx_http_upstream_t *u)

{

…

rc = u->process_header(r);

// 获取header time时间

u->state->header_time = ngx_current_msec – u->start_time;

…

}

来源：freebuf.com 2020-12-12 19:23:32 by: stan1y