 |
Ribbon Documentation Portal will be unavailable Thursday February 2nd 2023 between 2:00 PM EST ~ 12:00 PM. More Info |
|
Ribbon Documentation Portal will be unavailable Thursday February 2nd 2023 between 2:00 PM EST ~ 12:00 PM. More Info |
LX Main User Interface
This includes the path and filename for the log file.
The Menu Bar displays the main options in the LX.
Menu Bar Options
| Menu Option | Description/Options |
|---|---|
| File | Open -- Opens a log file. Settings -- Sets configuration and formatting for syslog server entries. See Working with Settings and Filters. Clear Screen -- Clears the screen contents. History – Displays the LX log file history (includes the last date the file was opened). Exit – Exits the LX. |
| View | Auto-resizes the columns for ease of viewing. |
| Search | Basic Call Search – Searches the log file by Regex Called/Calling number, Called Number, Calling Number, and Call ID. See Working with Call Flows. Advance Call Search -- Searches Method, Regex Number, Peer IP, Peer Port, SBC IP, SBC, Calling Number, Called Number, and Call-ID. See Working with Call Flows. Regex Number Search -- Searches the log file by Regex Number. |
| Editor | Opens an new screen to edit log files. |
| Syslog Server | Turns on Syslog Server. See Working with Syslogs. |
| Syslog File Management | Provides a real time view on the current state of the syslogs in the file directory. See working with Working with Syslogs. To enable feature, set a value under Log Destinations. Open -- Opens the file in the default text editor. Analyze -- Analyzes the syslog file in LX. Delete -- Permanently deletes the syslog file. |
| Tools | External Database Dashboard – Accesses the external syslog database to search, delete, and export syslogs files. See Working with an External Syslog Database. Syslog Loss Analyzer -- Inspects log file for missing log lines.This feature is only available for Sonus Edge (1000/2000/SWe Lite). See Working with Syslogs. Syslog Separator – Separates data received from multiple clients. See Working with Syslogs Clear User History -- Clears LX log history. Clear Stale Data – Clears data based on log rotation. See Working with Settings and Filters. |
| SFTP | Opens the SFTP Utility. See Working with SFTP. |
| Help | Displays LX Help. |
The message page displays information for each log file.
Text will appear in a different color depending on call protocol.
Message Pane Field Definitions
| Field | Description |
|---|---|
| ID | Creates an ID for each entry. |
| Protocol | Specifies the request-response protocol. |
| Direction | Lists if the message was sent or received. |
| Received Time | List the time the message was received. |
| Peer IP | Specifies the Peer IP Address for signaling tracing. |
| Peer Port | Specifies the port for the preceding peer IP address. |
| SBC IP | Specifies the SBC IP Address for signaling tracing. |
| SBC Port | Specifies the port for the preceding SBC IP address. |
Calling Number | Specifies the calling party number traced. |
| Called Number | Specifies the called party number traced. |
| Method | Specifies if the message method request was accepted and processed. |
| Hold | Lists if message was on hold for send only (sendonly), or send and receive (sendrecv). |
| Call Reference Value (CRV) | Lists the valid value during time period of the connection and is only used for call signaling. |
| CallID/Machine ID | Identifies the relayed subscription. |
| Transport | Lists the protocol used between hosts to transmit message. |
| Global Call ID (GCID) | Groups each leg (ingress, egress, and transfers) for a call automatically. |
Multiple subsystems are available and can be collapsed together to view a steam of all log files.
Subsystem Menu
| Field | Description |
|---|---|
| Calls | Displays one leg (ingress or egress) of call. Select multiple calls to combine. |
| Debug Systems | Displays the specified (SIP, CCC, MSC) errors and the error level(s). This feature helps determine what is happening in each subsystem. Autosearch on log load -- Select subsystem and levels to search for automatically on when the syslog loads. The total message counts for SIP calls, ISDN calls, SIP completed calls, SIP invites, etc. are displayed on the Status Bar. Hold down CTRL to select subsystems and levels not in sequential order. |
| Call Statistics | Provides graphical representation of statics for SIP and ISDN messages. Also provides the line rate – how many calls came into the box at that time (ingress). |
| ERROR/WARN/FILE Statistics [Only for SBC Edge (1000/2000/SWe Lite)] | Provides list of errors and warnings that occurred and which line the errors or warnings appear. This tab can be turned off and on. To set the tab, go to File > Settings > Metrics and check the appropriate box. For more information, see Working with Settings and Filters. |
| Call Duration | Displays SIP call connection time. This tab can be turned off and on. To set the tab, go to File > Settings > Metrics and check the appropriate box. For more information, see Working with Settings and Filters. |
| End To End Calls | Identifies and ties together all legs of a call flow using proprietary ID, Global Call ID. Clicking a call leg in this tab displays everything that happened on both the ingress and egress of the call. |
| AoR Based Flows | Displays information of SIP calls pertinent to Address of Record (AoR). This tab can be turned off and on. To set the tab, go to File > Settings > Call Flow and check the appropriate box. For more information, see Working with Settings and Filters. |
The Status Bar provides the progress and various message counts for the log file. The types of message counts displayed can be determined by the settings of the Debug Systems.
From the main window, double-click on a specific call to display the details of a particular call flow. The dialog comprises two panes, the Call Flow Pane and the Message Contents Pane. Within the Message Contents Pane are three buttons: Generate Call Ladder, Generate HTML, and Export Call Flow. For more information about call ladders or exporting call flows, see Working with Syslogs.
Call Flow Screen
The text editor included as part of Logging Exchange is based on the Scintilla SciTE text editor. Sonus has added a few enhanced features to make the tool more robust and those features are explained here. For more information about the basic features and functionality provided by Scintilla, see the Scintilla Documentation.
Several short-cut key combinations are available for performing common task without the need to open menus.
Window Short-cut Keys
Menu - Function | Short-cut Key |
|---|---|
File - Open | Ctrl+O |
File - Settings | Ctrl+G |
File - Clear Background | Ctrl+Shift+C |
File - History | Ctrl+H |
File - Exit | Ctrl+X |
| Calls - Filter By Call-ID | Ctrl+I |
Search - Basic Search | Ctrl+Shift+S |
Search - Advanced Search | Ctrl+Shift+A |
Search - Regex Number Search | Ctrl+R |