On Tuesday September 6th the forum will be down for maintenance from 9:30 PM to 11:59 PM PDT

Main Menu

Logging OBi Device Messages Using Syslog

Started by OBiSupport, April 19, 2011, 11:17:36 AM

Previous topic - Next topic


Capturing Messages via Syslog: OBi100 / OBi110
A syslog is a log of the status and debug messages sent out by your OBi unit. The messages are sent in syslog format over the network to an IP address and UDP port number you specify in the OBi's System Management (Device Admin) configuration settings.

You must use a program known as a syslog server to capture these messages and store them in a log file.
This log file is very useful for troubleshooting.

To troubleshoot issues with a SIP service (for SP1 or SP2 Service), you can also tell the OBi to log all the SIP messages exchanged with the ITSP.  By default these SIP messages are not logged.

Here are the instructions on how to set-up your OBi so that it sends debug messages to the IP address x.y.w.z and port number ppppp. You will replace x.y.w.z and ppppp with the actual IP address and port number where your syslog server program is running.

Step 1: Find your OBi's IP address.
From phone handset attached to the OBi, press *** 1. The OBi's IP address will be announced.

Step 2
: Configure the OBi's parameters for where to send debug messages.
Open the OBi's webpage (http://obi-ip-address) and navigate to System Management / Device Admin / Syslog.
Fill-in the "Server" parameter with x.y.w.z, and "Port" parameter ppppp – if different than default (514).
Note that ppppp must be in the range 1 - 65535.

Step 3: Enable logging of SIP Messages for SP1 (or SP2)
From the OBi device web page Voice Services settings, go to the SP1 Service (or SP2 Service) settings.
Change the "X_SipDebugOption" parameter to "Log All Messages."

Note:  If your OBi device is managed from within OBiTALK, you have the option of configuring the syslog parameters from the OBiTALK-based OBi Expert Configuration web pages.

Obihai Syslog Server Program for Windows
There are many free syslog server programs available for download from the Internet.
You are free to use any that you like.
It is best to use one that supports time-stamping of the log messages.

For your convenience, Obihai Technology provides a free syslog server program.

You can download the program here

Note: This program is for Windows machines only.
It must be run under the Windows Command Prompt, i.e. DOS window.

Syntax when running the Obihai syslog server:

C:\>syslogd -help
Usage:  syslogd [-p=port] [-o=filename] [-nl] [-s=all]

-p:  Listen to syslog messages at a port number other than the default (514).
                 For example -p=9000
-o:  Output location and name for the log file of the captured syslog messages.
                 For example -o=c:\temp\test.log
-s:  Options to control time-stamping and source IP Address.
                -s=time enables time-stamping of each message
                -s=ip enables logging the source IP address of each message
                -s=all enables both time-stamp and source address
                Note that -s=all is equivalent to -s=time -s=ip
-nl: Insert an extra blank line after each message (for better readability).

Please run the Obihai syslog server program with the following options (which includes time-stamping):

C:\>syslogd -nl -s=all

If you are using another syslog server program, please enable the time-stamping option of the program (usually time-stamping is enabled by default).