TCP Body Log

用途說明

傳送請求及回應日誌至TCP server。

與TCP Log相似，差異在於可以自定義是否紀錄回應body內容，以及可彈性自定義不需紀錄到日誌內的標頭。

日誌格式請參考下方：日誌格式。

欄位配置說明

啟用時可以看到以下畫面：

對應的配置說明如下：

參數	類型	預設值	說明	必填
host	string		日誌欲發送的IP位址或主機名。 ex: 10.18.66.1	V
port	integer		日誌欲發送的主機服務器之端口。 ex: 30544	V
timeout	number	10000	發送日誌到服務器的超時時間（以毫秒為單位）。
keepalive	number	60000	定義空閒連接關閉前的存活時間（以毫秒為單位）。
hide_body	boolean	false	true：隱藏回應的body內容，不會將body內容記錄到日誌內。 false：會將body內容記錄到日誌內。
clear_header	boolean	true	true ：開啟過濾header的功能。 false：關閉過濾header的功能。
clear_request_header_list	array of string		定義不紀錄到日誌中的請求標頭，ex: Content-Type ...等。沒設定代表所有請求標頭都會記錄於日誌中。 注意：當clear_header設定為true，才會觸發此設定。
clear_response_header_list	array of string		定義不紀錄到日誌中的回應標頭，ex: Content-Type ...等。沒設定代表所有請求標頭都會記錄於日誌中。 注意：當clear_header設定為true，才會觸發此設定。

用法示例

日誌格式

日誌使用JSON的格式來組成，如下：

{

"latencies": {

"request": 515,

"kong": 58,

"proxy": 457

},

"service": {

"host": "httpbin.org",

"created_at": 1614232642,

"connect_timeout": 60000,

"id": "167290ee-c682-4ebf-bdea-e49a3ac5e260",

"protocol": "http",

"read_timeout": 60000,

"port": 80,

"path": "/anything",

"updated_at": 1614232642,

"write_timeout": 60000,

"retries": 5,

"ws_id": "54baa5a9-23d6-41e0-9c9a-02434b010b25"

},

"request": {

"querystring": {},

"size": 138,

"uri": "/log",

"url": "http://localhost:8000/log",

"headers": {

"host": "localhost:8000",

"accept-encoding": "gzip, deflate",

"user-agent": "HTTPie/2.4.0",

"accept": "*/*",

"connection": "keep-alive"

},

"method": "GET"

},

"tries": [

{

"balancer_latency": 0,

"port": 80,

"balancer_start": 1614232668399,

"ip": "18.211.130.98"

}

],

"client_ip": "192.168.144.1",

"upstream_uri": "/anything",

"response": {

"headers": {

"content-type": "application/json",

"date": "Thu, 25 Feb 2021 05:57:48 GMT",

"connection": "close",

"access-control-allow-credentials": "true",

"content-length": "503",

"server": "gunicorn/19.9.0",

"via": "kong/2.2.1.0-enterprise-edition",

"x-kong-proxy-latency": "57",

"x-kong-upstream-latency": "457",

"access-control-allow-origin": "*"

},

"status": 200,

"size": 827,

"body": "[{\"id\":\"2513b24e-21da-4c8a-ae41-26c1e5c96bcd\",\"username\":\"demo222\",\"email\":\"xxx@xxx.com\",\"display_name\":\"demo222\",\"create_time\":\"2020-08-21T08:55:28Z\"},{\"id\":\"25a52372-c8ce-4d02-b175-7eae8ee18ad1\",\"username\":\"jop\",\"email\":\"j.op@aaa.com\",\"display_name\":\"jop\",\"create_time\":\"2020-09-22T01:53:04Z\"},{\"id\":\"2e9c4445-e07d-4154-82c1-20eaee12a610\",\"username\":\"ginatest\",\"email\":\"gina_test@gmail.com\",\"display_name\":\"ginatest\",\"create_time\":\"2021-03-04T07:54:44Z\"},{\"id\":\"5be08e00-b228-47a4-b0da-4d4a969644d8\",\"username\":\"edward_op\",\"email\":\"edward_op@geminiopencloud.com\",\"display_name\":\"edward_op\",\"create_time\":\"2020-08-25T01:29:20Z\"},{\"id\":\"621cd187-501e-41ff-8816-23f36c29e434\",\"username\":\"gina_t_admin\",\"email\":\"gina_t_admin@gmail.com\",\"display_name\":\"gina_t_admin\",\"create_time\":\"2021-03-05T08:34:03Z\"},{\"id\":\"6c25fead-0ba0-45a3-aaf0-9c99ab6fc0cc\",\"username\":\"jdev\",\"email\":\"j.dev@aaa.com\",\"display_name\":\"jdev\",\"create_time\":\"2020-09-22T01:53:55Z\"},{\"id\":\"7408346a-67af-4a2f-8946-e72a218b6bfc\",\"username\":\"demo_dp\",\"email\":\"developerA@geminiopencloud.com\",\"display_name\":\"developer A\",\"create_time\":\"2020-07-15T03:32:25Z\"},{\"id\":\"7aa7a143-ad49-4347-8445-cf0c5ad0375a\",\"username\":\"demo444\",\"email\":\"demo444@xxx.com\",\"display_name\":\"demo444\",\"create_time\":\"2020-08-24T05:53:48Z\"},{\"id\":\"7dfec1f1-2522-458b-be71-2456c50bf9bf\",\"username\":\"tim_op2\",\"email\":\"eer\",\"display_name\":\"tim_op2\",\"create_time\":\"2020-08-28T07:50:22Z\"},{\"id\":\"87878787-afb8-11ea-8686-0bb5c49d8beb\",\"username\":\"ryyua\",\"email\":\"ryyua@geminiopencloud.com\",\"display_name\":\"Greg\",\"create_time\":\"2020-06-16T10:05:41Z\"},{\"id\":\"914a4f02-ef8b-43d9-b355-e761537f5a08\",\"username\":\"yee\",\"email\":\"yee@goc.com\",\"display_name\":\"yee\",\"create_time\":\"2020-07-14T07:56:14Z\"},{\"id\":\"aa60fef9-4122-4ebc-8c3d-17761e86e9fa\",\"username\":\"demo_op3\",\"email\":\"demo_op3@geminiopencloud.com\",\"display_name\":\"demo_op3\",\"create_time\":\"2020-08-24T09:46:03Z\"},{\"id\":\"ab87fdca-34c3-484c-8963-68020e055766\",\"username\":\"test08182\",\"email\":\"xxx@xxx.com\",\"display_name\":\"test08182\",\"create_time\":\"2020-08-18T09:04:36Z\"},{\"id\":\"admin\",\"username\":\"admin\",\"email\":\"admin@demo.com\",\"display_name\":\"Admin\",\"create_time\":\"2020-06-16T08:00:52Z\"},{\"id\":\"b516b2a7-67dd-431d-8b6d-8ad9bdfab521\",\"username\":\"devops_test\",\"email\":\"test@geminiopencloud.com\",\"display_name\":\"test\",\"create_time\":\"2020-07-14T08:00:08Z\"},{\"id\":\"bab476a1-d1bc-42a3-9a39-655608fdd056\",\"username\":\"test_aaa\",\"email\":\"xxx@xxx.com\",\"display_name\":\"aaa\",\"create_time\":\"2020-08-13T03:31:50Z\"},{\"id\":\"c0de1458-a781-4cfa-a278-6c28fccee882\",\"username\":\"tim_dp\",\"email\":\"tim_dp@geminiopencloude.com\",\"display_name\":\"tim_dp\",\"create_time\":\"2020-08-26T01:29:30Z\"},{\"id\":\"cabd94a0-a6a9-456b-bb72-34135852212b\",\"username\":\"yee_test\",\"email\":\"yee@geminiopencloud.com\",\"display_name\":\"kimochi~yee\",\"create_time\":\"2020-07-13T02:38:12Z\"},{\"id\":\"dbcabbc6-56af-417a-b938-01efd871f77c\",\"username\":\"demo111\",\"email\":\"xxx@xxx.com\",\"display_name\":\"demo111\",\"create_time\":\"2020-08-21T08:54:37Z\"},{\"id\":\"e0feef08-5282-4de6-ba35-9a724e55b68f\",\"username\":\"demo333\",\"email\":\"xxx@xxx.com\",\"display_name\":\"demo333\",\"create_time\":\"2020-08-21T09:03:21Z\"},{\"id\":\"e6ec26e9-1c93-47b0-8a33-e35c3176aa68\",\"username\":\"tim_op\",\"email\":\"tim_op@geminiopencloud,com\",\"display_name\":\"tim_op\",\"create_time\":\"2020-08-26T01:30:13Z\"},{\"id\":\"eefbb2fb-0dd6-4f70-a5be-9660f385a387\",\"username\":\"edward_dp\",\"email\":\"edward_dp@geminiopencloud.com\",\"display_name\":\"edward_dp\",\"create_time\":\"2020-08-25T01:29:10Z\"},{\"id\":\"f6c3349e-379b-49ca-82e9-272787537d38\",\"username\":\"demo_op\",\"email\":\"operatorA@geminiopencloud.com\",\"display_name\":\"Operator A\",\"create_time\":\"2020-07-15T03:23:32Z\"}]"

},

"route": {

"id": "78f79740-c410-4fd9-a998-d0a60a99dc9b",

"paths": [

"/log"

],

"protocols": [

"http"

],

"strip_path": true,

"created_at": 1614232648,

"ws_id": "54baa5a9-23d6-41e0-9c9a-02434b010b25",

"request_buffering": true,

"updated_at": 1614232648,

"preserve_host": false,

"regex_priority": 0,

"response_buffering": true,

"https_redirect_status_code": 426,

"path_handling": "v0",

"service": {

"id": "167290ee-c682-4ebf-bdea-e49a3ac5e260"

}

},

"started_at": 1614232668342

}

• request 包含有關客戶端發送的請求。
• response 包含發送給客戶端的回應(含body內容)。
• tries 包含負載均衡器對此請求進行的（成功和失敗）列表。
• route 包含請求所對應之特定的API Manager 路由設定資料。
• service 包含請求所對應之API Manager 路由關聯的服務設定資料。
• authenticated_entity 如果已啟動身份認證插件，則會包含認證憑據。
• consumer 如果已啟動身份認證插件，則會包含認證的用戶設定資料。
• latencies 包含有關延遲的一些數據：
  • proxy 是最終服務處理請求所花費的時間。
  • kong 是運行所有插件所需的內部延遲。
  • request 是從客戶端讀取第一個字節到將最後一個字節發送到客戶端之間經過的時間。對於檢測速度較慢的客戶端很有用。
• client_ip 包含原始客戶端IP地址。
• started_at 包含開始處理請求的時間的UTC時區時戳。

在全局啟用插件

1. 從網站左邊Menu中 外掛插件 頁面中，點選右上角的 新增外掛插件 ：

2. 點選後，選擇 日誌 頁籤，並啟用TCP Body Log，填寫內容參考欄位配置說明，設定成功後，任何請求(不分服務、路由、用戶)的日誌都會發送到所配置的遠端主機上。

在服務端上啟用插件

1. 從網站左邊Menu中 服務 > 服務列表 頁面中，選擇要啟用此插件的服務，假設為google，點選對應的編輯按鈕：

2. 在編輯畫面中，點選上方的 外掛插件 頁籤，再點選頁籤內容上方的 新增外掛插件 按鈕：

點選後，選擇 日誌 頁籤，並啟用TCP Body Log，填寫內容參考欄位配置說明，設定成功後，僅有此服務(範例為google)請求的日誌會發送到所配置的遠端主機上。

在路由端上啟用插件

可以由兩種方式來選擇路由，並啟用插件：

方式一：路由列表

1. 從網站左邊Menu中 服務 > 路由列表 頁面中，選擇要啟用此插件的路由，假設為google，點選對應的編輯按鈕：

方式二：服務 > 服務列表 > 路由列表

1. 從網站左邊Menu中 服務 > 服務列表 頁面中，選擇要啟用此插件的路由 所屬之服務(假設為google)，點選對應的編輯按鈕。

在編輯畫面中，點選上方的 路由 頁籤，選擇要啟用此插件的路由(假設為google)，點選對應的編輯按鈕：

---

2. 承第1步，點擊上述兩種方式之一的編輯按鈕後，在編輯畫面中，點選上方的 外掛插件 頁籤，再點選頁籤內容上方的 新增外掛插件 按鈕：

點選新增外掛插件 按鈕後，選擇 日誌 頁籤，並啟用TCP Body Log，填寫內容參考欄位配置說明，設定成功後，僅有此路由(範例為google)請求的日誌會發送到所配置的遠端主機上。

在用戶端上啟用插件

1. 從網站左邊Menu中 訂閱用戶 > 用戶列表 頁面中，選擇要啟用此插件的用戶，假設為portaladmin，點選對應的編輯按鈕：

2. 在編輯畫面中，點選上方的 外掛插件 頁籤，再點選頁籤內容上方的 新增外掛插件 按鈕：

點選後，選擇 日誌 頁籤，並啟用TCP Body Log，填寫內容參考欄位配置說明，設定成功後，僅有此用戶(範例為portaladmin)請求的日誌會發送到所配置的遠端主機上。

驗證

假設有個Logstash Server，host為10.18.66.1，port為30544，啟用此插件時，填入對應的host及port。

透過API Manager去呼叫服務，可以觀察到Logstash Server所接收到的資訊類似如下，即為設定驗證成功。

{

"request": {

"method": "GET",

"headers": {

"x-api-key": "xxxxx",

"accept": "*/*",

"user-agent": "curl/7.65.3",

"x-api-host": "yyyyy",

"authorization": "Basic YWRtaW46YWRtaW4=",

"host": "localhost:9000"

},

"querystring": {},

"url": "http://localhost:8000/api/v2/solutions/",

"uri": "/api/v2/solutions/",

"size": "201"

},

"upstream_uri": "/api/v2/solutions/",

"tries": [

{

"port": 443,

"ip": "10.xx.xx.xx",

"balancer_latency": 0,

"balancer_start": 1616572324448

}

],

"port": 48967,

"response": {

"status": 200,

"headers": {

"date": "Wed, 24 Mar 2021 07:52:04 GMT",

"connection": "close",

"vary": "Accept,Accept-Language,Cookie",

"server": "Apache/2.4.7 (Ubuntu)",

"allow": "GET, POST, HEAD, OPTIONS",

"content-type": "application/json",

"set-cookie": [

"csrftoken=DWi9x5f7TP4uGbbBHqI9cGSlgtwXFlWV; expires=Wed, 23-Mar-2022 07:52:07 GMT; Max-Age=31449600; Path=/",

"sessionid=\".eJxNjstOwzAQRdNCaEupKvEVXVlBTZ1mCwt2YTUSO2v8oLGa2p3EZofEp2OglbKdc8-98z39oskGZnEwvbCapu95lmWoT9bRDawExtCKK7wdwRzWvTlY74Rx-uytC3TXwDolP60yg_iHNGtgEYxDF34L5g08jiolqmOyaQG7g1edj5oNvoshiezcYfjw_Ykl8qewS5q9vr08X8R7mF9ztIQM8uDTnR7SI6OZFoeWVrAp90VVPklV1nq3lRwLzlVdK26qikspC4UK5V6ayH4ATCteBw:1lOyJD:_4-n9hC5h5NO_c_E4yVjL24gEx4\"; expires=Wed, 24-Mar-2021 08:50:27 GMT; httponly; Max-Age=3500; Path=/"

]

},

"size": "1438",

"body": "[{\"id\":\"2513b24e-21da-4c8a-ae41-26c1e5c96bcd\",\"username\":\"demo222\",\"email\":\"xxx@xxx.com\",\"display_name\":\"demo222\",\"create_time\":\"2020-08-21T08:55:28Z\"},{\"id\":\"25a52372-c8ce-4d02-b175-7eae8ee18ad1\",\"username\":\"jop\",\"email\":\"j.op@aaa.com\",\"display_name\":\"jop\",\"create_time\":\"2020-09-22T01:53:04Z\"},{\"id\":\"2e9c4445-e07d-4154-82c1-20eaee12a610\",\"username\":\"ginatest\",\"email\":\"gina_test@gmail.com\",\"display_name\":\"ginatest\",\"create_time\":\"2021-03-04T07:54:44Z\"},{\"id\":\"5be08e00-b228-47a4-b0da-4d4a969644d8\",\"username\":\"edward_op\",\"email\":\"edward_op@geminiopencloud.com\",\"display_name\":\"edward_op\",\"create_time\":\"2020-08-25T01:29:20Z\"},{\"id\":\"621cd187-501e-41ff-8816-23f36c29e434\",\"username\":\"gina_t_admin\",\"email\":\"gina_t_admin@gmail.com\",\"display_name\":\"gina_t_admin\",\"create_time\":\"2021-03-05T08:34:03Z\"},{\"id\":\"6c25fead-0ba0-45a3-aaf0-9c99ab6fc0cc\",\"username\":\"jdev\",\"email\":\"j.dev@aaa.com\",\"display_name\":\"jdev\",\"create_time\":\"2020-09-22T01:53:55Z\"},{\"id\":\"7408346a-67af-4a2f-8946-e72a218b6bfc\",\"username\":\"demo_dp\",\"email\":\"developerA@geminiopencloud.com\",\"display_name\":\"developer A\",\"create_time\":\"2020-07-15T03:32:25Z\"},{\"id\":\"7aa7a143-ad49-4347-8445-cf0c5ad0375a\",\"username\":\"demo444\",\"email\":\"demo444@xxx.com\",\"display_name\":\"demo444\",\"create_time\":\"2020-08-24T05:53:48Z\"},{\"id\":\"7dfec1f1-2522-458b-be71-2456c50bf9bf\",\"username\":\"tim_op2\",\"email\":\"eer\",\"display_name\":\"tim_op2\",\"create_time\":\"2020-08-28T07:50:22Z\"},{\"id\":\"87878787-afb8-11ea-8686-0bb5c49d8beb\",\"username\":\"ryyua\",\"email\":\"ryyua@geminiopencloud.com\",\"display_name\":\"Greg\",\"create_time\":\"2020-06-16T10:05:41Z\"},{\"id\":\"914a4f02-ef8b-43d9-b355-e761537f5a08\",\"username\":\"yee\",\"email\":\"yee@goc.com\",\"display_name\":\"yee\",\"create_time\":\"2020-07-14T07:56:14Z\"},{\"id\":\"aa60fef9-4122-4ebc-8c3d-17761e86e9fa\",\"username\":\"demo_op3\",\"email\":\"demo_op3@geminiopencloud.com\",\"display_name\":\"demo_op3\",\"create_time\":\"2020-08-24T09:46:03Z\"},{\"id\":\"ab87fdca-34c3-484c-8963-68020e055766\",\"username\":\"test08182\",\"email\":\"xxx@xxx.com\",\"display_name\":\"test08182\",\"create_time\":\"2020-08-18T09:04:36Z\"},{\"id\":\"admin\",\"username\":\"admin\",\"email\":\"admin@demo.com\",\"display_name\":\"Admin\",\"create_time\":\"2020-06-16T08:00:52Z\"},{\"id\":\"b516b2a7-67dd-431d-8b6d-8ad9bdfab521\",\"username\":\"devops_test\",\"email\":\"test@geminiopencloud.com\",\"display_name\":\"test\",\"create_time\":\"2020-07-14T08:00:08Z\"},{\"id\":\"bab476a1-d1bc-42a3-9a39-655608fdd056\",\"username\":\"test_aaa\",\"email\":\"xxx@xxx.com\",\"display_name\":\"aaa\",\"create_time\":\"2020-08-13T03:31:50Z\"},{\"id\":\"c0de1458-a781-4cfa-a278-6c28fccee882\",\"username\":\"tim_dp\",\"email\":\"tim_dp@geminiopencloude.com\",\"display_name\":\"tim_dp\",\"create_time\":\"2020-08-26T01:29:30Z\"},{\"id\":\"cabd94a0-a6a9-456b-bb72-34135852212b\",\"username\":\"yee_test\",\"email\":\"yee@geminiopencloud.com\",\"display_name\":\"kimochi~yee\",\"create_time\":\"2020-07-13T02:38:12Z\"},{\"id\":\"dbcabbc6-56af-417a-b938-01efd871f77c\",\"username\":\"demo111\",\"email\":\"xxx@xxx.com\",\"display_name\":\"demo111\",\"create_time\":\"2020-08-21T08:54:37Z\"},{\"id\":\"e0feef08-5282-4de6-ba35-9a724e55b68f\",\"username\":\"demo333\",\"email\":\"xxx@xxx.com\",\"display_name\":\"demo333\",\"create_time\":\"2020-08-21T09:03:21Z\"},{\"id\":\"e6ec26e9-1c93-47b0-8a33-e35c3176aa68\",\"username\":\"tim_op\",\"email\":\"tim_op@geminiopencloud,com\",\"display_name\":\"tim_op\",\"create_time\":\"2020-08-26T01:30:13Z\"},{\"id\":\"eefbb2fb-0dd6-4f70-a5be-9660f385a387\",\"username\":\"edward_dp\",\"email\":\"edward_dp@geminiopencloud.com\",\"display_name\":\"edward_dp\",\"create_time\":\"2020-08-25T01:29:10Z\"},{\"id\":\"f6c3349e-379b-49ca-82e9-272787537d38\",\"username\":\"demo_op\",\"email\":\"operatorA@geminiopencloud.com\",\"display_name\":\"Operator A\",\"create_time\":\"2020-07-15T03:23:32Z\"}]"

},

"latencies": {

"request": 2820,

"kong": 36,

"proxy": 2783

},

"host": "10-18-66-1.kubernetes.default.svc.cluster.local",

"started_at": 1616572324413,

"route": {

"name": "yyyyy",

"created_at": 1609211603,

"regex_priority": 0,

"updated_at": 1611039120,

"strip_path": false,

"https_redirect_status_code": 426,

"hosts": [

"yyyyy"

],

"tags": [

"p1",

"p2"

],

"service": {

"id": "6799854c-1e31-41b4-ac75-b5f55c4653a1"

},

"path_handling": "v0",

"id": "a9d3404d-15bf-481c-88ac-63bfdb522cd4",

"preserve_host": false,

"protocols": [

"http",

"https"

]

},

"service": {

"connect_timeout": 60000,

"name": "gocv3",

"read_timeout": 60000,

"created_at": 1592296411,

"retries": 5,

"updated_at": 1592296411,

"port": 443,

"host": "10.11.11.11",

"write_timeout": 60000,

"id": "6799854c-1e31-41b4-ac75-b5f55c4653a1",

"protocol": "https"

},

"client_ip": "172.18.0.1"

}