<- dhdcs:legacy:logging|Logging ^ dhdcs:legacy:start|DHD Communication Server (legacy version) ^ dhdcs:legacy:main_window|Main Window ->


====== Logging Options ======

In the ''Logging'' menu click ''Options'' to open the ''Logging Options'' window. In this window you can change the logging settings of the DHDCS.

<WRAP center round info 60%>
**Note**\\  All settings in the options dialog keep their current values even if the DHD Communication Server is closed.
</WRAP>

====== General Tab ======

On the ''General'' tab, you can set the general logging options.


[{{ :dhdcs:dhdcs_logging_general.png?nolink |//Logging Options window, General tab.//}}]

**Protocol Options area**

When you select the ''Auto protocol'' check box, the DHD Communication Server records the messages for every device to which a DHD application will be connected. When a DHD application connects to a device, the ''Protocol'' Column in the ''device list'' will show ''ON (Auto)'' for this device. With that feature you can, for example create logs when you select a device in the ''Device tree'' in the Toolbox5 ''Maintenance Window'' or when you load a Configuration to the device. By default, the check box is not selected.

<WRAP center round tip 80%>
**Tip**\\  Select this option if you want to monitor how other DHD applications (not running on your PC) communicate with a DSP core. Keep in mind that certain actions, for example updating the firmware, can cause more data in the protocol.
</WRAP>

Select the ''Do not quit server while protocol is active'' check box, if you want to avoid that the DHDCS is closed while recording a log file. This way, you can make sure that a long term logging can not be interrupted. If this option is active and you try to close the DHDCS, the following message will be shown:'' Protocol is active, Server could not stop.''In this case, the DHDCS can not be closed as long as a logging is active. By default, this check box is not seected.

<WRAP center round important 80%>
**Important**\\  If you have selected the ''Do not quit server while protocol is active'' check box and a log is being recorded for a device, you can not shut down the PC. Windows detects an active DHD application and requires to quit the application or to stop the shut down process. Other active programs on the PC can be quit by the system, though.
</WRAP>

Select the ''Remember active TCP loggings'' check box to resume logging after a restart of the DHDCS. When this check box is not selected, after a program restart all logging will be switched off.

====== File Tab ======

On the ''File'' tab you can configure the settings related to the log file.

[{{ :dhdcs:dhdcs_logging_file.png?nolink |//The File tab shows options for the log file handling//}}]

==== Log to area: ====

In the ''Log to'' area you can choose between 3 options, where the log data will be used:

  * The ''File'' option outputs the log data only into a log file. 
  * The ''Window'' options shows the log data only at the logging area.
  * The ''Both'' option writes data into the logging area and to the log file. The ''Both'' option is active by default.

==== Log file area: ====

In the ''Log file'' area you can set where the logging data is saved and you can change the behaviour of the log file regarding its file size. 

To set the log file destination, enter the path into the ''Log file directory'' box. Alternatively,  you can click on  and select from the ''Browse For Folder'' window the desired folder for the log files. At the first start of the DHD Communication Server, the directory is inserted, into which the program file DHDCS.exe is extracted.

The log files contain the log entries as ASCII text. The files are named according to the scheme ''DHDYYYY-MM-DD_hh-mm-ss.log'' (e.g., DHD2013-07-01_14-08-35.log)'' YYYY ''indicates the year,'' MM ''the month,'' DD ''the day,'' hh ''the hour,'' mm ''the minute and'' ss ''the second when the log file was started.

<WRAP center round important 80%>
**Important**\\  If you select a directory for the protocol files, you have to make sure that your current Windows user account has write permission to this directory!
</WRAP>

You have 2 options to set when a new log file should be started. 

  * When you select ''Start new log file every day'', the DHDCS starts a new file every day at midnight.This option is set by default. The maximum file size of the log file is 10 MB. When the file size of 10 MB is reached an additional log file is started. 
  * In addition, you can select the ''Keep only last''  ''days'' check box to store as many log files as entered in the ''days'' box. By default, the last five files are kept; but you can set values between 1 and 100.
  * When you select the ''Log file size max: <No> MB'' option, the size of the log file is limited to the number stated in the ''MB'' box (in megabytes). As soon as the log file reaches this size, the log file will be overwritten. You can set set the value for the maximum size to 0 MB, with that the log file has no size restriction. The name of the log file will be ''DHD.log''.

<WRAP center round important 80%>
**Important**\\  Depending on the number of logged devices and the selected settings, log files can reach a size of 100 MB or more. Therefore make sure that sufficient space is available on the hard disk of the PC!
</WRAP>

===== Filter Tab =====

On the ''Filter'' tab you can configure how UDP messages are filtered before being logged. The available options influence the incoming messages of all monitored devices. Only messages that match with the set filter criteria are logged.

[{{ :dhdcs:dhdcs_logging_filter_settings.png?nolink |//The Filter tab shows options for logging the messages of DHD devices.//}}]


==== Enable additional data area ====

The ''All UDP Messages'' check box enables the logging of all UDP messages within the DHD network. This includes routing commands, status messages of Global Resources and settings for Global Potentiometers. Only Global Logics and other Logic Exchange data will not be included. 

To show Global Logics and other Logic Exchange UDP messages, select the ''UDP Global Logics / Logic Exchange check box'' below.

==== Suppress area ====

Clear the ''TCP Remote Control / PPM data'' check box to activate the logging of TCP data transmitted by the DHD Remote Control software, including data sent to the peak meters in the DHD Remote Control software.

Clear the ''TCP DSP Control data'' check box to activate the logging of TCP data transmitted by the DHD DSP Control software.

Clear the ''TCP File transfer data'' check box to activate the logging of TCP data caused by firmware updates, sending configuration files, and snapshot transfers.

==== Suppress temporary area ====

Select the ''UDP error messages'' check box, to deactivate the recording of UDP error messages. These error messages could be for example, over modulation of inputs, changes of the synchronization sources or problems with DSP cards.

<WRAP center round alert 80%>
**Warning**\\  Use this option only in exceptional cases and only over a limited period of time. If you leave it switched on accidentally, important information can be lost.
</WRAP>

<WRAP center round important 80%>
**Important**\\  The deactivation of UDP error message logging will be valid only until the next DHDCS restart. After a restart the UDP error messages will be logged again.
</WRAP>