If you would like to log your data in a different format to the standard formats available, this option will allow you to create your own custom file logging format from the fields available.
Creating a new custom format
To create a new custom file format, select the "Custom file formats" option then right click to choose "add new custom file format". Alternatively, you can use the "New" tool bar button at the top of the form.
Once a custom file format has been created, it will be available from the "Log File Format" dropdown in the "Log to File" actions. The custom file formats appear at the very end of the drop down list.
Changing the order of fields
The order in which the fields are written to the file can be changed by simply dragging the field checkboxes into a new order. When the mouse is over the checkbox text, the mouse cursor will change to a drag-drop cursor. Just click, drag and then drop to change the order as you want. The order shown will be used when creating the log file entry.
Enabling a Field
All the available fields are listed in the "Log file fields" area. Just check the fields you want to be written to the log file.
Date and Time formats
The format for the Date, Time and Date-Time fields can be chosen from the drop down options on the right hand side of the screen. Choose the format that best suites your location.
Field Delimiter
Each field is normally separated by a specific and unique delimiting character. Tab characters are the most common delimiters used for syslog files.
Qualifier
Each field can be enclosed in quotes, or double quotes etc. This is especially useful when the delimiter is set to use a comma character.
Adjust time to UTC
If you would like the date and time stamps in your log files to be adjusted to UTC (GMT) time, then simply check this box. The current time difference (in hours) between your system and UTC is shown in brackets.
Custom fields
Custom fields are for use by the run script action. By writing a parsing script, the syslog message text can be broken down into various sub fields. The values can then be assigned to the 16 custom fields and then logged to a file. Because each device manufacturer creates syslog messages in a different format, it is not possible to create a generic parser that will break up the message text into separate fields. A custom script must be written to parse the message text and then place it in the custom fields. Example parsing scripts can be found in the \Scripts sub folder. If you have checked the Custom field checkbox, all 16 custom fields will be written to the log file. Each custom field is separated by the selected delimiter character.
Example of fields and their values:
Field name Example
----------------------------------------------------->
Date 28/01/2005
Time 16:12:54
Date-Time 28/01/2005 16:12:54
Milliseconds 123
TimeZone -13 hrs
Facility Local7
Level Debug
Priority Local7.Debug
HostAddress 192.168.0.1
Hostname host.company.com
InputSource UDP
Message Text This is a test message from Kiwi Syslog Daemon
Custom Custom01 Custom02 Custom03 etc