Liberty 中的「階段作業起始通訊協定 (SIP)」二進位日誌和追蹤延伸
藉由二進位記載,開發人員可將延伸欄位新增至日誌和追蹤記錄中,此外,也會提供對應的方法,供您依延伸值來過濾日誌和追蹤記錄。
日誌和追蹤記錄包含一些資訊欄位,例如:記錄的建立時間,以及所記載的訊息內容。這些欄位是核心欄位,存在於每一個日誌和追蹤記錄中。相對地,延伸欄位是一些可供應用程式開發人員新增至日誌和追蹤記錄中的欄位,可在您搜尋特定的日誌和追蹤內容時用來作為過濾準則。在您將文字輸出格式配置成使用進階格式時,可在二進位日誌中看見這些日誌和追蹤延伸,或者當您以進階格式使用 binaryLog 指令時,也會看到它們。
- 管理者
應用程式伺服器會自動建立一些延伸,以供您用來過濾日誌和追蹤記錄。您也可以使用應用程式開發人員所新增的任何延伸,來過濾日誌和追蹤記錄。您可以利用 binaryLog 指令行工具,根據日誌和追蹤記錄延伸的內容來過濾記錄。如需相關資訊,請參閱BinaryLog 指令選項。
例如,如果要查看 SIP 儲存器已處理的所有 SIP 應用程式階段作業,您可以使用下列 binaryLog 指令:binaryLog view binaryFile --includeExtension=SIPASId=* --format=advanced
- 開發人員
開發人員可以透過日誌記錄環境定義 API (com.ibm.websphere.logging.hpel.LogRecordContext),利用二進位記載,將自訂延伸新增至日誌和追蹤記錄中。當二進位記載儲存日誌和追蹤記錄時,它會包含存在於相同執行緒上日誌記錄環境定義中的任何延伸。比方說,您可以撰寫 Servlet 過濾器,將重要的 HTTP 要求參數新增至日誌記錄環境定義中。當執行該 Servlet 時,HPEL API 會將這些延伸新增到相同執行緒上所建立的任何日誌和追蹤記錄中。
如同其他日誌和追蹤記錄欄位,開發人員可以利用 HPEL API 來存取這些記錄延伸。在您撰寫工具來讀取日誌和追蹤儲存庫時,這個 API 很有用。開發人員也可以利用日誌記錄環境定義 API,在執行時期存取自訂日誌處理程式、過濾器和格式製作程式中的各項延伸。
下表說明各項日誌和追蹤延伸,包括可用來過濾各個追蹤層面的 ID。
延伸 | 說明 |
---|---|
appName | 指定日誌或追蹤記錄相關的 Java™ Platform Enterprise Edition (Java EE) 應用程式名稱(若有的話)。 |
requestID | 指定每一筆日誌或追蹤記錄之相關要求的唯一 ID(若有的話)。如果應用程式伺服器要在日誌和追蹤記錄中新增 requestID 延伸,您必須啟用「跨元件追蹤 (XCT)」,這在管理主控台中亦稱為日誌和追蹤相關性。只有特定類型的要求(例如:HTTP 或 JMS 要求),才會新增要求 ID。 |
SIPCallId | 指定 SIP Proxy 伺服器或 SIP 儲存器所要處理的 SIP 呼叫 ID。此資訊在 SIP Proxy 伺服器與 SIP 儲存器之間是共用的。您可以利用這項延伸,來追蹤不同元件之間的 SIP 呼叫流程。若有啟用 HPEL 記載,SIP Proxy 伺服器和 SIP 儲存器會自動將這個 ID 新增至每一筆日誌和追蹤記錄中。 |
SIPASId | 指定 SIP 儲存器所要處理的 SIP 應用程式階段作業 ID。這項資訊在 SIP 儲存器之間是共用的。您可以利用這項延伸,來追蹤 SIP 呼叫流程。若有啟用 HPEL 記載,SIP 儲存器會自動將這個 ID 新增至每一筆日誌和追蹤記錄中。 |
SIPSessionId | 指定 SIP 儲存器所要處理的 SIP 階段作業 ID。這項資訊在 SIP 儲存器之間是共用的。您可以利用這項延伸,來追蹤 SIP 呼叫流程。若有啟用 HPEL 記載,SIP 儲存器會自動將這個 ID 新增至每一筆日誌和追蹤記錄中。 |
SIPCallId2 | 指定與相同 SIP 應用程式階段作業相關聯,且 SIP 儲存器所要處理的第二個 SIP 呼叫 ID。這項資訊在 SIP 儲存器之間是共用的。您可以利用這項延伸,來追蹤 SIP 呼叫流程。若有啟用 HPEL 記載,SIP 儲存器會自動將這個 ID 新增至每一筆日誌和追蹤記錄中。 如果單一 SIP 應用程式階段作業相關聯的 SIP 呼叫 ID 超過兩個,只會記錄前兩個 ID。不會記錄其他的 ID。 |
SIPSessionId2 | 指定與相同 SIP 應用程式階段作業相關聯,且 SIP 儲存器所要處理的第二個 SIP 階段作業 ID。這項資訊在 SIP 儲存器之間是共用的。您可以利用這項延伸,來追蹤 SIP 呼叫流程。若有啟用 HPEL 記載,SIP 儲存器會自動將這個 ID 新增至每一筆日誌和追蹤記錄中。 如果單一 SIP 應用程式階段作業相關聯的 SIP 階段作業 ID 超過兩個,只會記錄前兩個 ID。不會記錄其他的 ID。 |
thread | 指定每一筆日誌或追蹤記錄之相關要求的執行緒名稱。 |