SIP Log Viewer

You can view PortaSIP® call, message and SIP phone registration attempts logs on the SIP Log Viewer page. You need to know the Call-ID of the specific call or message in order to view its log.

If you do not know the Call-ID (e.g. you just tried to register a SIP phone, made a phone call or sent a message from a SIP phone and it failed), you can create another search query by specifying one or more parameters. All registration, call and message attempts that match the defined search criteria will be displayed on a separate tab so you can locate the Call-ID of “your” call or message.

Query tab

You can search SIP logs by the different parameters. Note that it is possible to configure which search parameters can be used. For more information please refer to the … configure search parameter list for the SIP Log Viewer? subsection of the How to .. section of the PortaSwitch Configuration Server Web Reference Guide.

Field	Description
Search ... by	Select Voice Calls from the list to search for call logs. Select Messaging Services from the list to search for message logs. Select UAs Registrations from the list to search for user agent’s registration attempts.
Call-ID	This allows you to search for logs by the SIP Call-ID header (the typical format is XXXXX@some.domain or XXXX@IP). The SIP Call-ID header serves as a unique identifier of a call or a message.
Other criteria	If a Call-ID is unknown, a call or message log can be found by using other search criteria. The available options are: Time interval – This displays logs for all call, message and registration attempts performed within the specified time interval Calling Station ID /Sender – This filters logs by originating phone number (ANI number). Caller’s IP address / Sender IP address – This filters logs by originating IP address. Caller’s User Agent – This option is only available when you search for call logs. It filters calls made from a SIP phone or dialer application according to brand. Recipient – This filters logs by destination phone number.

Field

Description

Search ... by

Select Voice Calls from the list to search for call logs.
Select Messaging Services from the list to search for message logs.
Select UAs Registrations from the list to search for user agent’s registration attempts.

Call-ID

This allows you to search for logs by the SIP Call-ID header (the typical format is XXXXX@some.domain or XXXX@IP). The SIP Call-ID header serves as a unique identifier of a call or a message.

Other criteria

If a Call-ID is unknown, a call or message log can be found by using other search criteria.

The available options are:

Time interval – This displays logs for all call, message and registration attempts performed within the specified time interval
Calling Station ID /Sender – This filters logs by originating phone number (ANI number).
Caller’s IP address / Sender IP address – This filters logs by originating IP address.
Caller’s User Agent – This option is only available when you search for call logs. It filters calls made from a SIP phone or dialer application according to brand.
Recipient – This filters logs by destination phone number.

The other content of the page changes dependant on what you have selected to search by.

Call-ID is selected

Field	Description
Call-ID	Click the Add icon to add another Call-ID to trace callback calls when one logical call consists of several independent SIP calls. These calls will be merged into a single call log. The number of Call-IDs that can be added in the search query is limited to 5.
Output format	Call diagram – This shows logs in the form of a diagram in a separate SIP log tab on the SIP Log Viewer. Call diagram in a new browser tab – This shows logs in the form of a diagram in a separate browser tab. Text log – This shows logs as raw text.

Field

Description

Call-ID

Click the Add icon to add another Call-ID to trace callback calls when one logical call consists of several independent SIP calls. These calls will be merged into a single call log.

The number of Call-IDs that can be added in the search query is limited to 5.

Output format

Call diagram – This shows logs in the form of a diagram in a separate SIP log tab on the SIP Log Viewer.
Call diagram in a new browser tab – This shows logs in the form of a diagram in a separate browser tab.
Text log – This shows logs as raw text.

Other criteria are selected

NOTE: If the originating or dialed numbers were specified in a local format that is different from E.164 format (e.g. 02065550236), these numbers must be entered in the same format to trace the call. Alternatively, you can use the % pattern to substitute unknown symbols (e.g. %2065550236, 206555% or %206555%).

Click the Add icon to add another value for the selected criterion. The number of values for each criterion is limited to 5.

SIP Log tab

On the SIP Log tab you can choose an output format for a call or message log:

Call diagram – This shows logs in the form of a diagram in a separate SIP log tab on the SIP Log Viewer.
Call diagram in a new browser tab – This shows logs in the form of a diagram in a separate browser tab.
Text log – This shows logs as raw text.

For logs shown in the form of a diagram you can choose the level of details:

0 - simple – SIP messages to / from UAs, AAA requests, RTP Proxy commands.
1 - extended – All SIP messages, AAA requests, RTP Proxy commands.
2 - whole – All messages from sip.log with corresponding Call-ID.

How to submit a log to PortaOne's support

To submit a log with all the relevant details to the PortaOne®’s support ticketing system first click the Send logs to RT icon on the toolbar and then specify the relevant trouble ticket number and comment (available for Call diagram and for Call diagram in a new browser tab).

How to download a log

To download a log, click the Download icon on the toolbar.

Call flow diagram

Logs for messages delivered via the SIP protocol

For messages delivered via the SIP protocol, message logs are split into two parts. The first part of the log includes information related to message delivery from the sender to the IMGate and message authorization in the billing engine. The second part of the log includes information related to message delivery from the IMGate to the recipient.

The second part of the log has a different Call-ID. It is provided in the first part of the log as the Outgoing message call-id header field.

SIP message flow diagram (the first part of the log)

SIP message flow diagram (the second part of the log)

Logs for UA Registration

Internode call logs

These logs are shown on a single diagram. Thus, you can view all SIP requests and responses, all PortaSIP® nodes involved and an entire call flow in one place. By default, the SIP Log Viewer displays a single diagram, however, there is the option of seeing all of the call history for each node separately. To do this, click on the Separate log for each SIP node link.