<- dhdcs:v3:logging|Logging ^ dhdcs:v3:start|DHD Communication Server ^ dhdcs:v3:file_menu|File ->
====== 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 80%>
**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:v3:logging-general.png?nolink |//Logging Options window, General tab.//}}]

  * ''Auto protocol'' checkbox: 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 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 DHD device. Keep in mind that certain actions, for example updating the firmware, can cause more data in the protocol. Browser-based applications such as Web Apps and 8511 Views App (Windows) don't generate any log messages this way, as they don't use DHDCS to communicate.
</WRAP>

  *''Do not quit server while protocol is active'' checkbox: select if you want to avoid that 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 DHDCS, the following message will be shown:'' Protocol is active. Server could not stop.''In this case, DHDCS can not be closed as long as a logging is active. By default, this check box is not selected. The message will appear if any log level greater than log level 0 is set or if ''TCP Protocol ON'' is set.

<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>

  * ''Remember active TCP loggings'' checkbox: When enabled, DHDCS will store the current per device ''Log Level'' and ''TCP Protocol'' settings before quitting the application. It will resume logging with the last state after a restart of DHDCS. When this check box is not selected, after a program restart all logging will be switched off.
  * ''Remember Added Devices'' checkbox: Remember devices you added manually using the [[dhdcs:v3:logging_menu#add_device|add device]] dialog.

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

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

[{{ :dhdcs:v3:logging-file.png?nolink |//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:

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

==== 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 automatically 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 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'', 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 <No> 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 quickly reach a size of 100 MB or more. Therefore make sure that sufficient space is available on the hard disk of the computer.
</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:v3:logging-filter.png?nolink |//Filter tab shows options for logging the messages of DHD devices.//}}]

==== Temporary Enable area ====

  * ''All UDP Messages'' checkbox: enables 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. 
  * ''UDP Global Logics / Logic Exchange'' checkbox: Show Global Logics and other Logic Exchange UDP messages.

<WRAP center round important 80%>
**Important**\\  These temporary logging options will be valid only until the next DHDCS restart.
</WRAP>

==== Temporary suppress area ====

  * ''UDP error messages'' checkbox: Deactivate the recording of UDP error messages. These error messages could be for example, overmodulation 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 will be lost.
</WRAP>

<WRAP center round important 80%>
**Important**\\  The temporary 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>

==== Suppress ====

  * ''TCP Remote Control / PPM data'' checkbox: disables the logging of TCP data transmitted by the DHDOS and DHDOM.
  * ''TCP DSP Control data'' checkbox: disables the logging of TCP data transmitted by the DHDOS and DHDOM software.
  * ''TCP File transfer data'' checkbox: disables the logging of TCP data caused by firmware updates, sending configuration files, and snapshot transfers.

<WRAP center round info 80%>
**Note**\\  These logging options are permanent and will be stored even if DHDCS is restarted.
</WRAP>