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 来访问定制日志处理程序、过滤器和格式化程序中的扩展。
下表描述了日志和跟踪扩展,包括您可用于过滤跟踪的各个方面的标识。
扩展 | 描述 |
---|---|
appName | 指定与日志或跟踪记录相关的 Java™ Platform Enterprise Edition (Java EE) 应用程序(如果存在)的名称。 |
requestID | 指定与每个日志或跟踪记录相关的请求(如果存在)的唯一标识。要使应用程序服务器能够将 requestID 扩展添加到日志和跟踪记录,必须启用跨组件跟踪 (XCT),在管理控制台中也称为“日志和跟踪关联”。仅为某些类型的请求添加请求标识,如 HTTP 或 JMS 请求。 |
SIPCallId | 指定 SIP 代理服务器或 SIP 容器正在处理的 SIP 调用标识。此信息在各个 SIP 代理服务器和 SIP 容器中是相同的。可以使用此扩展在各种组件之间跟踪 SIP 调用流。启用 HPEL 记录后,SIP 代理服务器和 SIP 容器会自动将此标识添加到每个日志和跟踪记录。 |
SIPASId | 指定 SIP 容器要处理的 SIP 应用程序会话标识。此信息在各个 SIP 容器中是相同的。可以使用此扩展跟踪 SIP 调用流。启用 HPEL 记录后,SIP 容器会自动将此标识添加到每个日志和跟踪记录。 |
SIPSessionId | 指定 SIP 容器要处理的 SIP 会话标识。此信息在各个 SIP 容器中是相同的。可以使用此扩展跟踪 SIP 调用流。启用 HPEL 记录后,SIP 容器会自动将此标识添加到每个日志和跟踪记录。 |
SIPCallId2 | 指定与同一个 SIP 应用程序会话相关联并且 SIP 容器正在处理的第二个 SIP 调用标识。此信息在各个 SIP 容器中是相同的。可以使用此扩展跟踪 SIP 调用流。启用 HPEL 记录后,SIP 容器会自动将此标识添加到每个日志和跟踪记录。 如果有两个以上的 SIP 调用标识与单个 SIP 应用程序会话相关联,那么仅记录前两个标识。不会记录其他标识。 |
SIPSessionId2 | 指定与同一个 SIP 应用程序会话相关联并且 SIP 容器正在处理的第二个 SIP 会话标识。此信息在各个 SIP 容器中是相同的。可以使用此扩展跟踪 SIP 调用流。启用 HPEL 记录后,SIP 容器会自动将此标识添加到每个日志和跟踪记录。 如果有两个以上的 SIP 会话标识与单个 SIP 应用程序会话相关联,那么仅记录前两个标识。不会记录其他标识。 |
thread | 指定每个日志或跟踪记录的相关请求的线程名称。 |