Sipura Syslogging

Configuring the Sipura Phone Adapter for Syslogging Support


The SPA has the capability to log execution and debugging information to a remote syslog server. The syslog server must understand the BSD syslog protocol RFC3164 and use UDP as the message transport.

Syslog on a Unix OS

Most modern Unix systems include a syslog daemon for logging system and other event information. Normally, the syslog daemon only accepts syslog messages from the host the syslog daemon resides. In order for the Unix syslog daemon to accept syslogs from the SPA, you must configure it to support access from remote syslog clients.

Linux OS

There are multiple methods, 1) If running the syslog daemon, the "-r" option must be appended to the syslog startup command line. 2) If running rsyslog, then "$ModLoad imudp.so" should be added to "/etc/rsyslog.conf" file.
In both cases, the IPTables firewall might need to be adjusted to allow incoming UDP packets destined to port 514.

Mac OS X

For Mac OS X, the "-u" option must be appended to the syslog startup command line. Mac OS X's IPFilter firewall might need to be adjusted to allow incoming UDP packets destined to port 514.

Solaris

Solaris does not require any additional command line parameters to support remote access to the syslog daemon.

Syslog on a MS-Windows OS

Microsoft Windows does not bundle a syslog daemon. You will need to install a syslog service. Try the syslog daemon from http://www.kiwisyslog.com or Sipura's slogsrv. Additionally, for Windows XP, you might need to allow incoming UDP packets to port 514 through your XP Firewall.

Syslog Facility and Priority Levels

The SPA does not fully conform to RFC3164 in that it does not send a Facility Level indicator in the syslog message. But, if you are using a Linux system that has a syslog system based on sysklogd, you accept the syslog using the following Facility Levels:
  • user
  • local0
For Unix based syslog daemons, you might need to modify your syslogd.conf to log the SPA messages to a separate file than the default system messages file. For the Linux environment, this can be accomplished with the following syslogd.conf entries:

#Don't log local0 and user stuff to /var/log/messages since the SPA uses those facility categories
*.info;user.none;local0.none;syslog.none;mail.none;authpriv.none;cron.none /var/log/messages

#SPA is logging at user and local0 facility categories.
user,local0.debug /var/log/sipura.log


SPA Setup for Syslogging

Assume the Syslog receiving server is running on a host with the IP of 192.168.0.100:

  1. Enter the advanced/admin configuration pages for your SPA. Assuming your SPA has the IP address of 192.168.0.2, the URL would be: http://192.168.0.2/advanced/admin.
  2. Enter the IP address of the syslog server into the input box for the parameter found at System > Optional Network Configuration > Syslog Server
  3. Enter the IP address of the syslog server into the input box for the parameter found at System > Optional Network Configuration > Debug Server
  4. Select 3 for the debugging level found in System > Optional Network Configuration > Debug Level
  5. Select full for the SIP debug option found in Line 1 > SIP Settings > SIP Debug Option
  6. Reboot your SPA via the URL: http://192.168.0.2/admin/reboot.

You will start to see syslog messages like:
May 19 00:56:39 192.168.0.100 System started: ip@192.168.0.2, reboot reason:W4

This indicates that the SPA started up and was rebooted via the Web reboot URL.


Sipura | Sipura Syslogging Interpretation




Configuring the Sipura Phone Adapter for Syslogging Support


The SPA has the capability to log execution and debugging information to a remote syslog server. The syslog server must understand the BSD syslog protocol RFC3164 and use UDP as the message transport.

Syslog on a Unix OS

Most modern Unix systems include a syslog daemon for logging system and other event information. Normally, the syslog daemon only accepts syslog messages from the host the syslog daemon resides. In order for the Unix syslog daemon to accept syslogs from the SPA, you must configure it to support access from remote syslog clients.

Linux OS

There are multiple methods, 1) If running the syslog daemon, the "-r" option must be appended to the syslog startup command line. 2) If running rsyslog, then "$ModLoad imudp.so" should be added to "/etc/rsyslog.conf" file.
In both cases, the IPTables firewall might need to be adjusted to allow incoming UDP packets destined to port 514.

Mac OS X

For Mac OS X, the "-u" option must be appended to the syslog startup command line. Mac OS X's IPFilter firewall might need to be adjusted to allow incoming UDP packets destined to port 514.

Solaris

Solaris does not require any additional command line parameters to support remote access to the syslog daemon.

Syslog on a MS-Windows OS

Microsoft Windows does not bundle a syslog daemon. You will need to install a syslog service. Try the syslog daemon from http://www.kiwisyslog.com or Sipura's slogsrv. Additionally, for Windows XP, you might need to allow incoming UDP packets to port 514 through your XP Firewall.

Syslog Facility and Priority Levels

The SPA does not fully conform to RFC3164 in that it does not send a Facility Level indicator in the syslog message. But, if you are using a Linux system that has a syslog system based on sysklogd, you accept the syslog using the following Facility Levels:
  • user
  • local0
For Unix based syslog daemons, you might need to modify your syslogd.conf to log the SPA messages to a separate file than the default system messages file. For the Linux environment, this can be accomplished with the following syslogd.conf entries:

#Don't log local0 and user stuff to /var/log/messages since the SPA uses those facility categories
*.info;user.none;local0.none;syslog.none;mail.none;authpriv.none;cron.none /var/log/messages

#SPA is logging at user and local0 facility categories.
user,local0.debug /var/log/sipura.log


SPA Setup for Syslogging

Assume the Syslog receiving server is running on a host with the IP of 192.168.0.100:

  1. Enter the advanced/admin configuration pages for your SPA. Assuming your SPA has the IP address of 192.168.0.2, the URL would be: http://192.168.0.2/advanced/admin.
  2. Enter the IP address of the syslog server into the input box for the parameter found at System > Optional Network Configuration > Syslog Server
  3. Enter the IP address of the syslog server into the input box for the parameter found at System > Optional Network Configuration > Debug Server
  4. Select 3 for the debugging level found in System > Optional Network Configuration > Debug Level
  5. Select full for the SIP debug option found in Line 1 > SIP Settings > SIP Debug Option
  6. Reboot your SPA via the URL: http://192.168.0.2/admin/reboot.

You will start to see syslog messages like:
May 19 00:56:39 192.168.0.100 System started: ip@192.168.0.2, reboot reason:W4

This indicates that the SPA started up and was rebooted via the Web reboot URL.


Sipura | Sipura Syslogging Interpretation




Created by: chandave, Last modification: Fri 09 of Oct, 2009 (17:15 UTC) by 423revival
Please update this page with new information, just login and click on the "Edit" or "Discussion" tab. Get a free login here: Register Thanks! - Find us on Google+