Syslog Viewer User's Guide - AudioCodes

1 User's Guide AudioCodes Utilities for Session Border Controllers and Media Gateways Syslog Viewer Version Version 3 Diagnostics and Analysis User's Guide Contents Table of Contents 1 Introduction .. 7 2 Installing Syslog Viewer .. 9 3 Configuring the Device for Syslog .. 11 4 Getting Started .. 13 Capturing Data .. 14 Receiving Logs from Device's Web Interface ..16 Loading Files .. 18 Supported File Formats ..18 Writing Logs to Disk .. 18 Searching for Strings .. 19 Editing a Line Entry .. 19 Filtering Logs .. 19 Configuring Syslog Listener .. 22 Configuring Syslog Listener with TLS ..22 Using the Command Line .. 23 5 Analyzing Syslog Messages .. 25 Syslog Message Types .. 25 SIP Call Session Logs ..26 Board Logs ..27 SNMP Alarms.

2 28 6 Analyzing Calls with SIP Ladder (Call Flow) .. 29 7 Configuring Display Settings .. 33 Changing the Scroll Buffer Default .. 33 Rotating Log Files .. 33 Freezing Display .. 33 Disabling Auto-Scroll .. 33 Saving Captured Buffer .. 34 Configuring external Editor .. 34 Detecting Missing and Out-Of-Order Logs .. 34 Filtering Incoming Traffic .. 34 Coloring and Formatting .. 35 Saving Window Position ..37 Configuring Font Type ..37 A Syslog Error Abbreviations .. 39 B Message Severity Levels .. 41 User's Guide 4 Document #: LTRT-40032 Syslog Viewer This page is intentionally left blank. Version 5 Diagnostics and Analysis User's Guide Notices Notice Information contained in this document is believed to be accurate and reliable at the time of printing. However, due to ongoing product improvements and revisions, AudioCodes cannot guarantee accuracy of printed material after the Date Published nor can it accept responsibility for errors or omissions.

3 Updates to this document can be downloaded from This document is subject to change without notice. Date Published: February-20-2022 WEEE EU Directive Pursuant to the WEEE EU Directive, electronic and electrical waste must not be disposed of with unsorted waste. Please contact your local recycling authority for disposal of this product. Customer Support Customer technical support and services are provided by AudioCodes or by an authorized AudioCodes Service Partner. For more information on how to buy technical support for AudioCodes products and for contact information, please visit our website at Stay in the Loop with AudioCodes Abbreviations and Terminology Each abbreviation, unless widely used, is spelled out in full when first used.

4 Document Revision Record LTRT Description 40030 Initial document release. 40031 Updated to Ver. Note added to indicate no support by MP-1xx for Receiving Logs from Device's Web Interface ; Syslog format updated to indicate SID and BID contains serial number instead of MAC for Mediant Software and 9000; installation updated 40032 Added Configuring Syslog Listener with TLS section. User's Guide 6 Document #: LTRT-40032 Syslog Viewer Documentation Feedback AudioCodes continually strives to produce high quality documentation. If you have any comments (suggestions or errors) regarding this document, please fill out the Documentation Feedback form on our website at User's Guide 1. Introduction Version 7 Diagnostics and Analysis 1 Introduction Syslog is an event notification protocol that enables a device to send event notification messages across IP networks to event message collectors, also known as Syslog Servers The device (SBC/GW) contains an embedded Syslog client, which sends error reports/events that it generates to a remote Syslog server This information is a collection of error, warning, and system messages that records every internal operation of the device AudioCodes Syslog Viewer utility can be used for the following major tasks.

5 Recording and displaying Syslog messages from your AudioCodes device Analyzing recorded logs (including support for interactive SIP ladder diagram) This document describes how to install, setup and configure the Syslog Viewer . The figure below illustrates the Syslog deployment. Figure 1-1: Syslog Monitoring User's Guide 8 Document #: LTRT-40032 Syslog Viewer This page is intentionally left blank. User's Guide 2. Installing Syslog Viewer Version 9 Diagnostics and Analysis 2 Installing Syslog Viewer This section describes how to install the Syslog Viewer on your PC. Installation of Syslog Viewer is performed on the computer that has access to the device. To install Syslog Viewer : 1. Download the Syslog Viewer installation file from AudioCodes website at 2.

6 Click the downloaded .exe file; the installation wizard starts: Figure 2-1: Syslog Viewer -Welcome Screen 3. Click Next; the following appears: Figure 2-2: Select Destination Location User's Guide 10 Document #: LTRT-40032 Syslog Viewer 4. Select the location on your computer where you want to install Syslog Viewer , and then click Next; the following appears: Figure 2-3: Select Location of Shortcut Menu 5. Select where you want to add Syslog Viewer 's shortcut menu, and then click Next; the program starts to install. When installation completes, the following appears: 6. Click Finish; the main window of the Syslog Viewer is displayed. For a description of the main areas of the window, see Section Getting Started. User's Guide 3. Configuring the Device for Syslog Version 11 Diagnostics and Analysis 3 Configuring the Device for Syslog Before you can start receiving any Syslog messages from the device, you need to configure the device to send generated Syslog messages to the Syslog Viewer .

7 Configuring Syslog : 1. Run the Syslog Viewer tool. 2. On the same computer, connect to the device's Web interface, and then log in using the device's username-password credentials. 3. Enable Syslog : a. Open the Logging Settings page (Troubleshoot menu > Troubleshoot tab > Logging folder > Logging Settings). b. From the 'Enable Syslog ' drop-down list, select Enable. 4. Configure the Syslog server: a. Open the Syslog Servers page (Troubleshoot menu > Troubleshoot tab > Logging folder > Syslog Servers). b. Click New, and then configure an IP address of the computer where Syslog Viewer is running and other parameters, if desired. Figure 3-1: Configuring Syslog Server 5. Configure the debug level: From the 'VoIP Debug Level' drop-down list, select Basic. Figure 3-2: Configuring VoIP Debug Level 6.

8 Click Apply, and then click Save to save your settings. User's Guide 12 Document #: LTRT-40032 Syslog Viewer This page is intentionally left blank. User's Guide 4. Getting Started Version 13 Diagnostics and Analysis 4 Getting Started Open the Syslog Viewer application. The figure below illustrates the main components of the Syslog Viewer screen. Figure 4-1: Syslog Viewer Table 4-1: Toolbar Icon Description Clears the screen. Browses to open Syslog file. See Section Writes log to file. See Section Resumes receiving Syslog messages. Pauses the receiving of Syslog messages. Connects to the web interface of an AudioCodes device. Magnifies the screen display. Configures an external editor. See Section Disables auto-scroll. See Section Freezes display. See Section User's Guide 14 Document #: LTRT-40032 Syslog Viewer Icon Description Opens the SIP flow diagram.

9 See Chapter 5. Opens the Options screen. Searches for a string. Table 4-2: Status Bar Status Description Line and Column Line and Column reference Syslog Listener Indicates whether the Syslog Listener is active. When inactive indicates OFF. When active indicates the active protocol (UDP or TCP). Write Log Indicates when a log is currently being written to a file. Web Connection Indicates the IP address of the AudioCodes device connection from which Syslog is captured (see Section ). Syslog can be enabled simultaneously to report to the same Syslog server. Total Indicates the total number of lines in the file. Errors Indicates the number of errors in the file Warning Indicates the number of warnings in the file. Capturing Data Once you have setup the managed device to send Syslog messages, you are ready to start capturing data.

10 To start capturing data: 1. Make a few calls or perform a basic configuration action such as reset on the managed device. 2. On the toolbar, use the Resume button or from the File menu, choose Resume to start capturing data from the device; on the status bar, you notice that the Syslog Listener status changes to UDP or TCP . Figure 4-2: Syslog Listener 3. Detailed logs, including all the send and received SIP messages are displayed in the Syslog Viewer . User's Guide 4. Getting Started Version 15 Diagnostics and Analysis Figure 4-3: SIP Call Figure 4-4: Activity Log User's Guide 16 Document #: LTRT-40032 Syslog Viewer Note: The above procedure configures the SBC to send Syslog messages to the PC where Syslog Viewer is installed. If such communication is not possible ( , due to a firewall or NAT devices in the middle), you may use the Web Connect feature in the Syslog Viewer to establish an HTTP connection with the SBC and retrieve logs from it (see Section below).