Debug.log: Difference between revisions

Debug.log (view source)

Revision as of 06:24, 29 April 2021

1,681 bytes added , 06:24, 29 April 2021

m

Remove text that was MX specific, this is a Cumulus 1 only page

Sfws

5,838

edits

@@ Line 1: / Line 1: @@
-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.
-By default this is not enabled, but can be turned on and off as required.  Click on the Settings / Program settings menu within CumulusMX (Settings / Station settings menu in Cumulus 1) and ''tick'' the 'Debug Logging' menu option.
+== File growth and deletion ==
-The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc.
+If debugging is switched off, periodically a message, confirming that as shown earlier, is added to the '''debug.log''' file, so it grows in size even when full diagnostics are not being stored.
+If debugging is switched on, extensive messages of the format shown are added to the file and it will rapidly grow in size.
-Note:  Logging is turned on when you 'Save' the chnage in settings. It is automatically turned off if Cumulus is restarted. 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 to crash.
+To avoid loss (or inaccuracy) of readings being processed from your weather station, it is best if Cumulus is left running, and not restarted except when unavoidable. Consequently, the '''debug.log''' file will continually grow in size. If the file is left to grow too large, Cumulus will crash. Therefore, you '''should''' delete this file periodically .
 =File Location, Name and Format=
-In Cumulus 1, the file is called Debug.log, and is located in the root of the Cumulus folder.
+Cumulus 1 creates diagnostic logs in two places:
+# It creates a file called '''Debug.log''' in the same folder as where the executable is stored.
+#*This file can be deleted at any time as Cumulus does not read from it, and creates a new file when needed
+#*The log file is a simple text file containing the time and a description of each event.
+#* This file periodically has a message '''0000.000 : **** Logging Disabled''' stored if debugging is switched off.
+#* This file will have additional debugging information added, as per example below, if debugging is turned on.
+# It creates a [[Diags_folder|diags folder]]; '''diags''' is a sub-folder of the folder where the Cumulus executable is stored.
+#* That diags folder contains up to 10 files named '''cumulus.~og''' and '''cumulus.001''' to '''cumulus.009'''.
+#** '''cumulus.~og''' is the current log reporting what has happened since the last time Cumulus was started.
+#** '''cumulus.001''' to '''cumulus.009''' represent logs for previous 9 Cumulus restarts, and so do not exist if Cumulus has not been used before.
+#*Further information about this is to be found on the [[Diags_folder|diags folder]] page.
+#* Any diagnostic file can be deleted, at any time, as Cumulus does not read from them. Cumulus creates a new file if necessary to continue its logging.
-In CumulusMX, debug logging adds additional detail into the standard logging file. This is located in folder MXdiags within the CumulusMX root directory. It is a text (*.txt) file named by the date and time that the CumulusMX session began, for example: 20210112-171450.txt
-The log file is a simple text file containing the time and a description of each event.
-The file can be deleted at any time as Cumulus does not read from it.
 =Sample File=
@@ Line 42: / Line 49: @@
 .328 : Adding LH entry, ts = 14:24:00 raintot = 618
 .328 : TD = 0.0833333358168602 Lastval = 618 Firstval = 618 rate = 0
+==Turning debugging logging on/off==
+*By default, logging of debugging information is disabled.
+*Restarting Cumulus will mean the debug log is off (because it is automatically turned off as Cumulus exits)
+*Logging of debugging information can be enabled as Cumulus is started, or at some point while it is running (except earliest builds)
+Depending on which version of Cumulus 1 you are using, there is '''either one or two ways''' of turning logging of debugging data on and off:
+* The only way to turn on the logging of debugging messages in all builds of Cumulus 1, is to stop Cumulus 1, edit the [[Cumulus.ini_(Cumulus_1)#Section:_Station|configuration file]], and add a line in the [Station] section: <tt>Logging = 1</tt>, then restart Cumulus 1.
+* From build 1003 onward, you can also turn it on/off using the '''Configuration''' menu (debug option is included in drop down of that menu).
 [[Category:Log Files]]