forked from apache/apisix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support file-logger plugin of response body record (apache#8414)
- Loading branch information
Showing
4 changed files
with
198 additions
and
0 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,183 @@ | ||
| # | ||
| # Licensed to the Apache Software Foundation (ASF) under one or more | ||
| # contributor license agreements. See the NOTICE file distributed with | ||
| # this work for additional information regarding copyright ownership. | ||
| # The ASF licenses this file to You 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. | ||
| # | ||
| use t::APISIX 'no_plan'; | ||
|
|
||
| no_long_string(); | ||
| no_root_location(); | ||
|
|
||
| add_block_preprocessor(sub { | ||
| my ($block) = @_; | ||
|
|
||
| if (! $block->request) { | ||
| $block->set_value("request", "GET /t"); | ||
| if (!$block->response_body) { | ||
| $block->set_value("response_body", "passed\n"); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
|
|
||
| run_tests; | ||
|
|
||
| __DATA__ | ||
| === TEST 1: add plugin with 'include_resp_body' setting | ||
| --- config | ||
| location /t { | ||
| content_by_lua_block { | ||
| local t = require("lib.test_admin").test | ||
| -- delete plugin metadata for response body format | ||
| t('/apisix/admin/plugin_metadata/file-logger', ngx.HTTP_DELETE) | ||
| local code, body = t('/apisix/admin/routes/1', | ||
| ngx.HTTP_PUT, | ||
| [[{ | ||
| "plugins": { | ||
| "file-logger": { | ||
| "path": "file-with-resp-body.log", | ||
| "include_resp_body": true | ||
| } | ||
| }, | ||
| "upstream": { | ||
| "nodes": { | ||
| "127.0.0.1:1982": 1 | ||
| }, | ||
| "type": "roundrobin" | ||
| }, | ||
| "uri": "/hello" | ||
| }]] | ||
| ) | ||
| if code >= 300 then | ||
| ngx.status = code | ||
| end | ||
| ngx.say(body) | ||
| } | ||
| } | ||
| === TEST 2: verify plugin for file-logger with response | ||
| --- config | ||
| location /t { | ||
| content_by_lua_block { | ||
| local core = require("apisix.core") | ||
| local t = require("lib.test_admin").test | ||
| local code = t("/hello", ngx.HTTP_GET) | ||
| local fd, err = io.open("file-with-resp-body.log", 'r') | ||
| local msg | ||
| if not fd then | ||
| core.log.error("failed to open file: file-resp-check.log, error info: ", err) | ||
| return | ||
| end | ||
| -- note only for first line | ||
| msg = fd:read() | ||
| local new_msg = core.json.decode(msg) | ||
| ngx.status = code | ||
| if new_msg.response ~= nil and new_msg.response.body == "hello world\n" then | ||
| ngx.status = code | ||
| ngx.say('contain with target') | ||
| end | ||
| } | ||
| } | ||
| --- response_body | ||
| contain with target | ||
| === TEST 3: check file-logger 'include_resp_body' with 'expr' | ||
| --- config | ||
| location /t { | ||
| content_by_lua_block { | ||
| local t = require("lib.test_admin").test | ||
| local code, body = t('/apisix/admin/routes/1', | ||
| ngx.HTTP_PUT, | ||
| [[{ | ||
| "plugins": { | ||
| "file-logger": { | ||
| "path": "file-with-resp-expr-body.log", | ||
| "include_resp_body": true, | ||
| "include_resp_body_expr": [ | ||
| [ | ||
| "arg_foo", | ||
| "==", | ||
| "bar" | ||
| ] | ||
| ] | ||
| } | ||
| }, | ||
| "upstream": { | ||
| "nodes": { | ||
| "127.0.0.1:1982": 1 | ||
| }, | ||
| "type": "roundrobin" | ||
| }, | ||
| "uri": "/hello" | ||
| }]] | ||
| ) | ||
| if code >= 300 then | ||
| ngx.status = code | ||
| end | ||
| ngx.say(body) | ||
| } | ||
| } | ||
| === TEST 4: verify file-logger resp with expression of concern | ||
| --- config | ||
| location /t { | ||
| content_by_lua_block { | ||
| local core = require("apisix.core") | ||
| local t = require("lib.test_admin").test | ||
| local code = t("/hello?foo=bar", ngx.HTTP_GET) | ||
| local fd, err = io.open("file-with-resp-expr-body.log", 'r') | ||
| local msg | ||
| if not fd then | ||
| core.log.error("failed to open file: file-with-resp-expr-body.log, error info: ", err) | ||
| return | ||
| end | ||
| -- note only for first line | ||
| msg = fd:read() | ||
| local new_msg = core.json.decode(msg) | ||
| ngx.status = code | ||
| if new_msg.response ~= nil and new_msg.response.body == "hello world\n" then | ||
| ngx.status = code | ||
| ngx.say('contain target body hits with expr') | ||
| end | ||
| --- a new request is logged | ||
| t("/hello?name=pix", ngx.HTTP_GET) | ||
| msg = fd:read("*l") | ||
| local new_msg = core.json.decode(msg) | ||
| if new_msg.response.body == nil then | ||
| ngx.say('skip unconcern body') | ||
| end | ||
| } | ||
| } | ||
| --- response_body | ||
| contain target body hits with expr | ||
| skip unconcern body |