Skip to main content
Version: 2.3.3

File Log

File Log

用途說明#

傳送請求及回應日誌至檔案。

此插件會使用I/O將日誌寫入實體檔案內，針對比較慢速的儲存資源，可能會影響到部分性能。

若API Manager是架設在Kubernetes上，可以額外指定串流（如：/dev/stdout 及 /dev/stderr)。

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

欄位配置說明#

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

插件啟用配置圖

對應的配置說明如下：

參數類型預設值說明必填
pathstring輸出日誌文件的文件路徑。
ex: /tmp/file.log
如果此文件不存在，則插件會創建日誌文件，來確保具有對此文件的寫入權限。
請注意設定的路徑是否有足夠權限能夠創立文件。		V
reopenbooleanfalse確定是否在每次請求時關閉並重新打開日誌文件。
如果沒有重新打開文件，且文件已經被移動或循環使用的情況下，插件將會繼續寫入過時的文件描述符，造成資訊丟失。		V

用法示例#

日誌格式#

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

在全局啟用插件#

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

全局啟用畫面

  1. 點選後，選擇 日誌 頁籤，並啟用File Log，填寫內容參考欄位配置說明，設定成功後，任何請求(不分服務、路由、用戶)的日誌都會寫入路徑對應的文件內。

在服務端上啟用插件#

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

服務啟用畫面1

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

服務啟用畫面2

點選後，選擇 日誌 頁籤，並啟用File Log，填寫內容參考欄位配置說明，設定成功後，僅有此服務(範例為google)請求的日誌會寫入路徑對應的文件內。

在路由端上啟用插件#

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

方式一：路由列表#

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

路由啟用畫面1

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

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

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

路由啟用畫面2

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

路由啟用畫面3

點選新增外掛插件 按鈕後，選擇 日誌 頁籤，並啟用File Log，填寫內容參考欄位配置說明，設定成功後，僅有此路由(範例為google)請求的日誌會寫入路徑對應的文件內。

在用戶端上啟用插件#

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

用戶啟用畫面1

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

用戶啟用畫面2

點選後，選擇 日誌 頁籤，並啟用File Log，填寫內容參考欄位配置說明，設定成功後，僅有此用戶(範例為portaladmin)請求的日誌會寫入路徑對應的文件內。

驗證#

假設目前僅能夠在/tmp路徑底下創立文件，則配置的path設定為/tmp/file.log。

透過API Manager去呼叫服務，範例如下（使用curl命令來測試）：

curl -XGET <API Manager protocol>://<API Manager ip>:<API Manager port>/api/v2/users/ \
-H 'X-API-HOST: gocv3' \
-H 'X-API-KEY: 7338ebd5-a29c-469a-8501-ad861e1821c8' \
-uadmin:password -i
HTTP/1.1 200 OK
[{"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"...(略)

API Manager在取得服務的回應後，會將該次的請求&回應之日誌，寫入對應之/tmp/file.log路徑文件內。

如下圖所示，即為設定驗證成功。

FileLog驗證畫面1