digiRunner APIM 深入淺出digiRunner API管理

深入淺出digiRunner - 如何追蹤API LOG

Sean / 陳奕勳 Chris Chen 2024/09/27 15:18:42
1269

在前一篇文章中,我們探討了API的批次匯入與啟用功能,這些操作提升了API管理的效率和靈活性。然而系統能夠詳細追蹤每次API呼叫過程中的資料傳輸是至關重要的不管是在進行問題排查或是維護測試時。本篇文章將深入介紹如何使用dgR系統中的Online Console來開啟並追蹤API的Log紀錄,幫助開發者更精確地進行除錯與性能優化,確保API的運行狀態符合預期。

 

  • 若需要確認呼叫的API時中間傳輸的所有資料,可透過online Console來查看。

  • 方便開發者DEBUG使用,以及提供詳細資訊來給開發者分析。

一、開啟追蹤LOG的設定檔

  1. 首先,點選左側選單中的[ 系統設定 ]然後選擇[ Setting ],您將看到所有設定檔的列表。

  2. 在搜索框中輸入關鍵字「TSMP_ONLINE_CONSOLE」。如果該值顯示為「false」,請點選 [ 更新 ] ,進入更新頁面。

  3. 將其值修改為「true」,後點選 [ 更新 ] 即可完成更新,且開啟追蹤功能。

       

二、呼叫API來產生API LOG

  1. 在呼叫API之前,請先開啟一個新分頁,進入Online Console頁面。具體步驟可參考指引中的第三項。

  2. 點選左側選單中的[ API管理 ],然後選擇[ API列表 ]即可查看現有的API列表。

  3. 在API列表中,選擇一支需要去追蹤的API,點選 [ 測試 ],開啟該API的測試區視窗。 若有啟用No Auth,即可在Authorization欄位中,選擇「No Auth」進行設置。

  4. 完成上述設置後,再次點選 [ 測試 ]。若成功呼叫API,即表示您已順利完成這一步,可以至Online Console頁面取得呼叫過程紀錄的所有Log。

       

三、透過Console頁面追蹤API的LOG

  1. 接下來,點選左側選單中的[ 系統設定 ],然後選擇[ Online Console ]以進入API LOG該頁面。

  2. 確認狀態(state)為 「OPEN」,以及確認 Log Level 必須在「API-Log」以上。

       

  1. 這樣您就可以查看API的LOG。以下示例顯示了呼叫後所呈現4道Log的畫面,供您參考。

  2. 4道Log由【Start DGRC】以及【End DGRC】標籤來定義其範圍
    每道LOG由【LOGUUID】來判讀,包括呼叫目標URL的位置、Request 的 Header和Body、Response的 Header和Body、Http status code、Http Elapsed Time以及LogUUID方便User來辨識與追蹤。

  3. 由【LOGUUID】以及【Start DGRC】開始來定義其第一道涵蓋的範圍。

    1. 可以透過【URL】來查看呼叫註冊在dgR的API URL,以及可以取得其 Http Method來確認其LOG結構是否如預期。

    2. 可以透過【Http Req Header】來確認其傳送的表頭內容,如Authorization的內容也會在該區域,且預設會做遮罩。

    3. 遮罩也是由Setting中的【ES_TOKEN_MASK_FLAG】該欄位來設定。

    4. 【Req Payload】該區域則是去顯示透過Request Body帶入的參數,可以確認由前端送進去的資料是否被截斷。

                   

  1. 接下來由下一個【LOGUUID】開始來定義其第二三道涵蓋的範圍。

    1. 該範圍的【URL】欄位值為代理的原網址,可以確認是否有代理錯目標位址

    2. 接下來一樣有【Http Req Header】以及【Req Payload】欄位可確保前段傳輸的資料有成功往後送

                  

  1. 最後一個【LOGUUID】搭配【End DGRC】以上來查看其第四道涵蓋的範圍。

    1. 可以透過【Http Resp Header】來取得回應的表頭。

    2. 【Http status code】可以確認是否呼叫成功。

    3. 【Http Elapsed Time】為該次呼叫的的所需時間,可以透過該數值來確認問題點,如呼叫時間過長造成的Time out就能從該欄位確認其時間。

                  

 

透過本篇文章的介紹,您已學會利用dgR系統中的Online Console來追蹤API的呼叫過程紀錄。藉由有效利用這些功能,能夠更精確地掌控API運行狀況與穩定性。接下來的文章將繼續探討dgR的其他API管理功能,我們下一片文章見!

Sean