-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(error_log): custom error handler (#65)
* feat(error_log): custom error handler * Defines a new error log handler and a directive lua_kong_error_log_request_id that enable configuring a Request ID from the value of an nginx variable, to append to the error log. * includes tests for the new directive * tests(*): fix github workflow Co-authored-by: Chrono <chrono_cpp@me.com> Co-authored-by: Datong Sun <datong.sun@konghq.com>
- Loading branch information
3 people
authored
Sep 6, 2023
1 parent
4826102
commit 949131f
Showing
8 changed files
with
446 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| /** | ||
| * Copyright 2019-2023 Kong Inc. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #include "ngx_http_lua_kong_common.h" | ||
|
|
||
|
|
||
| /* | ||
| * This function contains the logic to append the Request ID to | ||
| * the error log line when being called | ||
| */ | ||
| static u_char * | ||
| ngx_http_lua_kong_error_log_handler(ngx_http_request_t *r, u_char *buf, size_t len) | ||
| { | ||
| ngx_http_variable_value_t *value; | ||
| ngx_http_lua_kong_loc_conf_t *lcf; | ||
|
|
||
| lcf = ngx_http_get_module_loc_conf(r, ngx_http_lua_kong_module); | ||
| if (lcf->request_id_var_index == NGX_CONF_UNSET) { | ||
| return buf; | ||
| } | ||
|
|
||
| value = ngx_http_get_indexed_variable(r, lcf->request_id_var_index); | ||
| if (value == NULL || value->not_found) { | ||
| return buf; | ||
| } | ||
|
|
||
| buf = ngx_snprintf(buf, len, ", request_id: \"%v\"", value); | ||
|
|
||
| return buf; | ||
| } | ||
|
|
||
|
|
||
| /* | ||
| * This function replaces the original HTTP error | ||
| * log handler (r->log_handler). It executes the original logic | ||
| * and then our error log handler: ngx_http_lua_kong_error_log_handler | ||
| */ | ||
| static u_char * | ||
| ngx_http_lua_kong_combined_error_log_handler(ngx_http_request_t *r, | ||
| ngx_http_request_t *sr, u_char *buf, size_t len) | ||
| { | ||
| u_char *p; | ||
| ngx_http_lua_kong_ctx_t *ctx; | ||
|
|
||
| ctx = ngx_http_lua_kong_get_module_ctx(r); | ||
| if (ctx == NULL || ctx->orig_log_handler == NULL) { | ||
| return buf; | ||
| } | ||
|
|
||
| /* original log handler */ | ||
| p = ctx->orig_log_handler(r, sr, buf, len); | ||
| len -= p - buf; | ||
| buf = p; | ||
|
|
||
| /* Kong log handler */ | ||
| buf = ngx_http_lua_kong_error_log_handler(r, buf, len); | ||
|
|
||
| return buf; | ||
| } | ||
|
|
||
|
|
||
| static ngx_int_t | ||
| ngx_http_lua_kong_replace_error_log_handler(ngx_http_request_t *r) | ||
| { | ||
| ngx_http_lua_kong_ctx_t *ctx; | ||
|
|
||
| ctx = ngx_http_lua_kong_get_module_ctx(r); | ||
| if (ctx == NULL) { | ||
| return NGX_ERROR; | ||
| } | ||
|
|
||
| if (r->log_handler == NULL) { | ||
| return NGX_DECLINED; | ||
| } | ||
|
|
||
| /* | ||
| * Store the original log handler in ctx->orig_log_handler, replace | ||
| * it with the combined log handler, which will execute the original | ||
| * handler's logic in addition to our own. | ||
| */ | ||
| ctx->orig_log_handler = r->log_handler; | ||
| r->log_handler = ngx_http_lua_kong_combined_error_log_handler; | ||
|
|
||
| return NGX_DECLINED; | ||
| } | ||
|
|
||
|
|
||
| char * | ||
| ngx_http_lua_kong_error_log_init(ngx_conf_t *cf) | ||
| { | ||
| ngx_http_handler_pt *h; | ||
| ngx_http_core_main_conf_t *cmcf; | ||
|
|
||
| cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module); | ||
|
|
||
| h = ngx_array_push(&cmcf->phases[NGX_HTTP_POST_READ_PHASE].handlers); | ||
| if (h == NULL) { | ||
| ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, | ||
| "failed setting error log handler"); | ||
| return NGX_CONF_ERROR; | ||
| } | ||
|
|
||
| *h = ngx_http_lua_kong_replace_error_log_handler; | ||
|
|
||
| return NGX_CONF_OK; | ||
| } | ||
|
|
||
|
|
||
| char * | ||
| ngx_http_lua_kong_error_log_request_id(ngx_conf_t *cf, ngx_command_t *cmd, void *conf) | ||
| { | ||
| ngx_str_t *value; | ||
| ngx_http_lua_kong_loc_conf_t *lcf = conf; | ||
|
|
||
| value = cf->args->elts; | ||
|
|
||
| if (value[1].data[0] != '$') { | ||
| ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, | ||
| "invalid variable name \"%V\"", &value[1]); | ||
| return NGX_CONF_ERROR; | ||
| } | ||
|
|
||
| value[1].len--; | ||
| value[1].data++; | ||
|
|
||
| lcf->request_id_var_index = ngx_http_get_variable_index(cf, &value[1]); | ||
| if (lcf->request_id_var_index == NGX_ERROR) { | ||
| return NGX_CONF_ERROR; | ||
| } | ||
|
|
||
| return NGX_CONF_OK; | ||
| } | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.