5,838
edits
Debug.log: Difference between revisions
m
CORRECTED - now right for Cumulus 1 again, and also now usable for people using MX 3.9.3 and below
No edit summary |
m (CORRECTED - now right for Cumulus 1 again, and also now usable for people using MX 3.9.3 and below) |
||
| Line 1: | Line 1: | ||
=Introduction= | |||
The debug logging feature is extremely useful in troubleshooting problems with Cumulus and/or connectivity to your weather station or FTP upload communications. | The debug logging feature is extremely useful in troubleshooting problems with Cumulus and/or connectivity to your weather station or FTP upload communications. | ||
By default this is | The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc. | ||
The file can grow very large very quickly so turn the Debug Log option off it not required. If the file grows too large it can cause Cumulus (up to version 3.8.1 - b3091) to crash. (From Release 3.8.2 - b3092 adds MXdiags log rotation to avoid this). | |||
==Turning debugging log on/off== | |||
*By default, logging of debugging information is disabled. | |||
*Restarting Cumulus (1, 2, or MX) will normally (you can manually change this) turn debug log off (because it is automatically turned off as Cumulus exits) | |||
*Logging of debugging information can be enabled as Cumulus is started (see instructions below for your flavour) | |||
*[[File:Badge vMx.png]] In MX only, you can turn the logging of debugging information on and off while it is running, using the admin interface (see below to identify which settings screen) | |||
{{Version badge 1}}Cumulus 1.x.y: The only way to turn on the logging of debugging messages in Cumulus 1, is to stop Cumulus 1, edit the [[Cumulus.ini#Section:_Station|Cumulus.ini configuration file]], and add a line in the [Station] section: <tt>Logging = 1</tt>, then restart Cumulus 1. | |||
[[File:Badge vMx.png]]Cumulus MX: There are three ways to '''turn on the logging''' of debugging messages in Cumulus MX: | |||
# Close Cumulus MX, then edit [[Cumulus.ini#Read-Write_parameters_in_the_Station_section|Cumulus.ini configuration file]], and add a line in the [Station] section: <tt>Logging = 1</tt>, then restart Cumulus MX. | |||
# When you start Cumulus MX, use [[Cumulus_MX#Parameter_for_adding_debugging|Parameter for adding debugging]] as part of the command for starting | |||
# Use the [[MX_Administrative_Interface#Changing_Settings|admin interface Settings menu]], next ''tick'' the 'Debug Logging' menu option, and finally click '''Save''', on the appropriate web page depending on which version of MX you are using (see below). You can untick the option to disable the logging of debugging information | |||
#* '''Program settings''' web page for version 3.9.4 - build 3099 onwards | |||
#* [[MX_Administrative_Interface#Station_Settings|'''Station settings''']] web page for earlier MX versions | |||
=Details= | |||
=File Location, Name and Format= | ==File Location, Name and Format== | ||
In Cumulus 1, the file is called Debug.log, and is located in the root of the Cumulus folder. | In Cumulus 1, the file is called Debug.log, and is located in the root of the Cumulus folder. | ||
| Line 19: | Line 36: | ||
The file can be deleted at any time as Cumulus does not read from it. | The file can be deleted at any time as Cumulus does not read from it. | ||
=Sample File= | ==Sample File for Cumulus 1== | ||
An extract from a debug.log file | An extract from a '''debug.log''' file | ||
9168.735 : 14:23:54 Realtime FTP Put attempt | 9168.735 : 14:23:54 Realtime FTP Put attempt | ||