Enabling RTF Logging
Symptom:
Enabling RTF (Runtime Tracing Facility) logging is similar for both Windows and Linux across all current HMP and SR releases.
Reason for the problem:
This tool is included in the Dialogic system release (in the Dialogic\Bin directory, or HMP\Log directory) and will log application function calls and events useful for troubleshooting.
Fix / Solution:
The RTF Server is started automatically when the system is started. However, the levels configured in the RtfConfig(Win/Linux).xml are for the error/exception level only. For troubleshooting most issues, additional layers must be enabled. To do so, you will need to enable the RTF Configuration XML file.
A user can edit the rtf configuration file to increase or decrease logging levels. The RTF configuration filename, depending on the operating system, is either “RtfConfigWin..xml” or “RtfConfigLinux..xml. It is located in the Dialogic\Cfg directory and can be edited with any text editor. Note: You must have administrative rights to modify the RtfConfig*.xml files.
For any change in the RTF config file to take effect, the user must pause and reload the RTF Trace services. Before doing this, we suggest backing up the previous RTF logging files (found in the \Dialogic\log directory), as well as backing up the original RTF config file so that you can revert back to minimal logging once troubleshooting is complete. To reload the RTF Server with the updated RTF configuration, issue the following commands:
1. rtftool pause
(This pauses the RTF logging, which will stop any logging that is currently being generated.)
2. rtftool clean (optional)
(This deletes all previously generated log files. While it's not necessary, it does make it easier to send the pertinent log files.)
3. rtftool reload
(This loads the new configuration into the RTF Server so it can log the enabled levels.)
4. rtftool resume
(This resumes the RTF Server's logging, which will now log the enabled levels and will start a new logging file with the current timestamp in the file name.)
Workaround:
There are some values that will be necessary to change to capture the appropriate logging levels. In these lines:
<Logfile duplicate_to_debug_console="0" log_format="text" maxbackups="10" path="$(INTEL_DIALOGIC_DIR)\log" preserve_maxbackups="10" preserve_size="300" size="300"/>
The default log file size is 300, which is 300 Kilobytes (KB). The default maximum amount of backups is 10 which will save up to that many backup files if the log size goes over the specified size. The “preserve” values will override the other values. Generally you can set them to the same values. See the appropriate Diagnostics Guide for your release for more information on preservation mode. This will be in the RTF (Runtime Tracing Facility) Reference section of the guide.
The RTF config file is broken up into sections that the user can enable for the specific case. Do not enable everything as this will consume memory and lead to system performance issues. See your appropriate technical support point of contact for advice on what options to enable. Generally, the user will edit the sections that apply to the particular case, for example, on a DM3 voice issue (Play/Record), the user would enable all sections with a “1” as shown below:
<!-- DM3 VOICE -->
<Module family="DM3,HMP" name="dm3voice" state="1" technology="media">
<MLabel name="DEBG" state="0"/>
<MLabel name="INFO" state="0"/>
<MLabel name="WARN" state="0"/>
<MLabel name="APPL" state="0"/>
<MLabel name="EXCE" state="1"/>
<MLabel name="ERR1" state="1"/>
<MLabel name="ERR2" state="1"/>
<MLabel name="EINF" state="1"/>
</Module>
Change all parameters to “0” to disable DM3 Voice logging.
Product List
HMP for Windows and Linux. SR 6+ for Windows or Linux.
Glossary of Acronyms / Terms
N/A.
Related Documentation
HMP 4.1 for Linux:
First published: 06-Apr-2008
Last published: 21-Apr-2011
Open access: Product rule: ; Page rule: Auto
