How to Use the Logfile
Logging is a powerful mechanism for tracking system activity. From the logfile, you can view the SIP packets and other important information that are generated by your PBX. The logfile is an invaluable tool that enables you to solve problems that are occurring on your PBX. It can answer questions like:
- "Why isn't my phone registering to the PBX?"
- "Why isn't Plug and Play working?"
- "Why can't I make outbound calls?"
- "Why isn't email working on my PBX?"
These and many other questions can be answered simply by using the logfile.
- In Admin mode under Settings, navigate to General > Logging as shown.
- From the Change all log levels to dropdown, select (0) Important so that all logging is turned off for all events.
- From the dropdowns shown below, select the events that apply to the issue you are experiencing, and set them each to 7.
- Set SIP logging if necessary.
- Navigate to Logfile under Status as shown, and click Clear. This will clear the page. Re-enact the issue that is occurring (i.e., make the call, plug the phone back in, etc.).
- Click Load.
Example: How to take a SIP log
SIP messages can be part of the log. Because many issues can be resolved easier when the SIP messages are correlated to the log entries generated by the PBX, you may include the SIP messages in the log itself. Here are the settings:
Specific Logging Event's Settings
You can enable or disable logging on a subsystem level (available subsystems are shown below):
- Change all log levels to: This dropdown can be used to globally change the level of log messages that will be included in the logfile. The range is from 0 to 9. Level 0 includes only critical messages, while level 9 shows all the available log messages of the system. Log level 9 should be used only for troubleshooting, as it creates additional load for the system and may generate extremely large log files.
- Log general events: These events are of general interest, for example, information about the working directory.
- Log SIP events: Events in this module relate to the SIP traffic of the system.
- Log media events: The system reports events about media processing, for example, a one-way audio RTP timeout.
- Log IVR events: This module logs events related to processing user input (e.g., all DTMF events, including the auto attendant and the mailbox).
- Log email events: If you want to troubleshoot the email server interaction, turn this module on so that you’ll see SMTP events.
- Log webserver events: This module logs all HTTP-related material, including HTTP-based plug and play.
- Log webclient events: This module logs all HTTP client related material, such as sending out HTTP requests out, in the case of CDRs, as well as HTTP/SOAP-related material).
- Log registration events: When a device registers or deregisters, it appears in this module.
- Log SNMP events: SNMP events occur when an external SNMP agent requests information from the system (see also page 58).
- Log trunk events: Log events are related to trunks (e.g., when a trunk registers for the first time or when an inbound trunk calls).
- Log SOAP events: This subsystem deals with SOAP input and output.
- Log TFTP and PnP events: This module includes events related to the built-in TFTP server. It also includes information related to plug and play.
- Log TLS events: This module logs TLS-related messages in the log file.
- Log LDAP Events: This module logs address book look-ups.
- Log configuration events: This module logs all events related to account creation, deletion, and modification.
- Analyze audio levels (CPU intense!): This feature measures the audio levels on a call leg. The volume is measured in decibels (dB) relative to the maximum volume (0 dB is maximum loudness).
SIP Events Logging Settings
Logging is important when tracking down problems. The settings on this page are designed to help you troubleshoot. When the system receives or sends a SIP packet, it determines whether the packet will be logged and which log level the event will have.
- Log REGISTER: REGISTER packets deal with the registration of extensions or trunks, which can generate a lot of traffic. If you are not interested in the registration traffic, disable this setting (see Appendix B for more information on SIP messages).
- Log SUBSCRIBE/NOTIFY: SUBSCRIBE/NOTIFY deals with message waiting indications (MWIs), the LED state, and other used subscriptions.
- Log call messages:: These packets usually belong to an ongoing call (e.g., INVITE, CANCEL, ACK, BYE). When you enable the logging for one of the previous categories, the SIP packets will be logged on log level 7. If your log level is below 7, the packets won’t show up in your log.
- Log Other Messages: This setting takes care of anything that are not part of the above 3 cases. When you enable the logging for one of the previous categories, the SIP packets will be logged on log level 7. If your log level is below 7, the packets won’t show up in your log.
- Log Watch List (IP): The watch list filters the SIP packets by IP address. This feature is useful when you have a specific device that you want to watch in the system’s log. Enter the IP addresses into this field.