Gateway / Log Settings
The logging mechanism may be configured using this page. The current value of each parameter is displayed and the value of each parameter may be reconfigured from this page. To modify the value of one or more parameters enter the new parameter value(s) in the corresponding text box and click ‘Save Changes’.
Logging Level: This parameter controls the severity of log messages that will be recorded. There are 7 log severity levels as follows, with Level 1 being the lowest level which records most data, Level 7 being the highest level which records least data:
Level 1 – DEBUG
This is the lowest level and is used for debugging of the software.
Level 2 – INFO
This is the level used for non-error messages regarding the execution of the software processes.
Level 3 – SERIAL
This level is used to isolate just the incoming and outgoing serial communication traffic (between the Gateway and the ZAP).
Level 4 – WARN
This level is used for warning messages from the gateway application.
Level 5 – ERROR
This level is used for error messages from the gateway application.
Level 6 – FATAL
This level is used for fatal errors and software exception messages from the Gateway application.
Level 7 – EVENT
This level is used for significant events occurring in the gateway e.g. start-up, shutdown, nodes joining the network.
If Level 1 – DEBUG is selected, the log file will contain log messages of severity DEBUG and higher. If Level 2 – INFO is selected, the log file will contain log messages of severity INFO and higher. If Level 7 – EVENT is selected the log file will contain log messages of severity EVENT only.
Max Log Size: The maximum size in Kilobytes that the log file can grow to. When the log file reaches the size defined here, it will roll-over. The default value is 900 KB. See also Max Archive Log Files.
Max Archived Log Files: The maximum number of log files that will be archived. The default value is 100. When the currently active log file reaches the configured Max Log Size, it will rollover and start a new “gateway.log”. If the Max Archived Log Files > 0, the old “gateway.log” will be renamed to “gateway.log.1” and so on. The next time the currently active log file reaches the configured Max Log Size, it will rollover again and start a new “gateway.log” file.
The maximum amount of disk space used by log files on the gateway will be equal to (Max Archive Log Files + 1)*(Max Log Size) in kilobytes. Setting the log level at a level higher than Level 3 – SERIAL is recommended to conserve disk space and avoid a large amount of data being written to the file system.
Logging to a Syslog server may also be enabled and configured with the following fields:
Syslog: If this is enabled, the Gateway will send log data to a syslog server. If this box is not checked, export of logs to a syslog server will be disabled.
Host: The Syslog server host name or IP address.
Port: The Syslog server port number. The default is port 514.