使用3CX Log Viewer分析SIP通信

介绍

3CX Bin Log Viewer用于读取和过滤3CX电话系统生成的日志,允许用户构建高级过滤器并轻松筛选日志。

安装

可以直接从3CX管理控制台下载和安装3CX Bin日志查看器。

您可以直接从此处下载Bin Log Viewer:3CX Bin Log Viewer V15

3CX Bin Log Viewer概述

一次加载3CX日志查看器时,单击文件→打开,然后导航到存储3CX日志的位置。 Bin日志查看器不应直接在3CX主机上使用,以避免对实时系统的性能影响。 从3CX管理控制台生成支持包并将其下载到运行Bin Log Viewer的PC。 解压缩ZIP文件,在/ Logs文件夹中,您将找到名为“3CXPhoneSystem.bldef”的文件。

3CX Bin日志查看器由四个主要部分组成,如下图所示。

筛选选项

“筛选选项”部分允许您选择日志窗口中显示的日志。

按日期过滤:选择以按日期/时间范围过滤日志记录。 3CX电话系统使用本地计算机的时间为日志添加时间戳。

按标签过滤:大多数日志行都已分配了一个标记。例如,特定呼叫的所有日志都标有其呼叫ID(例如,CallID 10)。您可以使用许多标签。我们将在本指南的最后看一些重要的标签。

如果要按特定标记过滤,请双击标记和标记公式窗口,并根据您的选择更新公式文本。单击“应用”按钮以使用所选标​​签进行过滤。

您会遇到要在过滤器中使用运算符的情况。例如,如果选择SiPMsg.method(INVITE),并且只需要Invites for extension 100,则可以单击“AND”按钮,然后从标签列表中选择“DN(100)”。

您还可以构建嵌套查询。例如,您可能希望过滤ID为12和13的INVITE请求。这将在下面的屏幕截图中显示:

添加和删​​除标记时,公式文本会更新。复制并保存您经常使用的公式。这将节省您尝试查找所需标签的时间。

重要说明 – 显示的标签是二进制日志中的标签。因此,例如,如果您尝试过滤分机116的日志,并且未找到DN 116,则表示该日志不包含分机116中的任何条目。

突出显示匹配日志:选中此复选框后,将显示所有日志条目,并且与过滤条件匹配的日志记录将以红色突出显示。按“应用”以使用所选的过滤条件刷新日志记录。

日志窗口

日志窗口是显示日志条目的位置。 您可以右键单击条目并“全选”日志条目或将所选日志“复制”到剪贴板。 您可以通过按住Shift或Control键来选择多个条目。 上面的屏幕截图显示了分机100的日志条目被突出显示。

标签窗口

标签窗口将显示已分配给所选日志条目的所有标签。 您可以双击任何标记,以便使用该标记进行过滤。 如果使用操作符,则首先需要在双击标记窗口中的标记之前选择操作符。 当您想要了解新标签时,标签窗口非常有用。 例如,在选定的日志条目中,CallId标记为1,DestAddr.Host为IP地址。

细节窗口

选择日志行时,详细信息窗口将显示该日志行。

某些日志条目由多行组成,这些行未显示在主日志窗口中。 这些显示在详细信息窗口中。 一个示例是下面的屏幕截图中显示的SIP消息。

其他特性

记录/页面:3CX日志查看器使用分页 – 它不会一次显示二进制日志,否则可能会使用太多资源和太多时间来存储大型二进制日志文件。它将记录每页X的记录数量。默认情况下,它每页加载10,000行。此编号可从“首选项”部分进行配置。

使用顶部的箭头按钮从一个页面移动到下一个页面或转到日志文件的开头或结尾。

搜索日志:您还可以通过在“查找:”输入字段中插入搜索词并按“Enter”来搜索日志。这将从当前位置搜索到结尾。或者,使用向下按钮向下搜索,然后按向上按钮向上搜索。始终从当前位置开始执行搜索。请注意,搜索将在所有页面上完成,直到搜索到达日志文件的开头或结尾。

打开日志:当您打开3CX日志查看器时,它将自动从最后一个位置加载日志。您可以从“文件→打开”中打开另一组3CX日志。您还可以查看最近从“文件→最近日志”打开的一组日志。

首选项:从“视图→首选项”中,您可以配置每页显示的记录数。您还可以选择显示日志时将使用的严重性掩码和日志级别。下面的屏幕截图显示了默认值,这些值在大多数故障排除情况下都应该有效。关闭3CX日志查看器时,将保留这些设置。

关联日志文件:从“设置→关联日志文件”,您可以将blrec和bldef文件与3CX日志查看器关联。

导出到文本:从“工具→导出到文本”,可以将过滤的日志条目导出到文本文件。将导出所有页面中的所有日志条目。如果要导出所有日志条目,请删除所有过滤器。您可能需要从“视图→首选项”调整默认过滤首选项。

命令行:3CX日志查看器也可以从命令行执行,在这种情况下,它将接受以下参数:

3cxBinLogViewer.exe <输入日志文件的路径> <导出文本文件的路径>

如果运行3cxBinLogViewer.exe <日志文件的输入路径>,3CX日志查看器将加载在指定路径中找到的日志文件。例如 –  3cxBinLogViewer.exe c:\ 3cxlogs。

如果运行3cxBinLogViewer.exe <日志文件的输入路径> <导出文本文件的路径>,3CX日志查看器会将输入路径中的二进制日志导出到导出路径中指定的文本文件。例如 –  3cxBinLogViewer.exe c:\ 3cxlogs c:\ 3cxlogs \ txtlog.txt。

有关3CX服务器日志的信息

3CX服务器日志由一个bldef文件和一个或多个blrec文件组成。 bldef文件是包含有关标记和其他索引数据的信息的文件。 blrec文件是保存日志的文件。这两个文件都是必需的,以便读取3CX日志。请注意,一个bldef文件可用于读取多个blrec文件。

3CX日志在达到50MB时会轮换。如果禁用“保留备份”选项(在“3CX管理控制台(仪表板)→活动日志→设置”中),则会保留两个blrec日志文件 – 当前文件和前一个文件。如果启用了“保留备份”设置,则旧文件将移动到备份文件夹。可以选择将日志文件备份保留X天。这会影响备份中保留的3CX日志数。

请注意,3CX服务器日志是由3CX电话系统SIP服务器服务写入的日志。其他进程(如3CX电话系统媒体服务器服务)以.log格式写入日志,并可使用文本编辑器查看。

有用的标签

此列表将帮助您了解并开始使用日志标记(并未列出所有标记):

  • CallId:PBX为每个呼叫分配一个呼叫ID。 CallId标记允许您按照与所选CallId匹配的日志记录进行筛选。
  • Cause.Code:Cause.Code显示日志中找到的所有SIP原因代码。因此,如果您正在排除呼叫返回忙音的情况,您可以过滤Cause.Code = 486
  • Contact.Host:Contact.Host允许您过滤SIP标头中列出的特定IP地址。
  • DestAddr.Host和SrcAddr.Host:在目标/源地址上过滤时很有用。请注意,这是网络地址,而不是SIP标头中指定的网络地址。
  • DN:这是电话或设备的分机号码(虚拟分机号码)。使用此标记可以过滤来自设备上特定分机或端口的日志记录。
  • InboundDID:当您想要过滤特定DID号的日志记录时,这可能会很有用。
  • SipMsg.Method:这对过滤日志记录并显示特定的SIP消息很有用。例如,您可能希望仅在日志文件中显示REGISTER SIP方法。这对于开始使用非常有用 – 也许您希望在注册发生时找到它,以便您可以按日期过滤日志记录。请记住检查其他SipMsg.X标记