Debug.log: Difference between revisions

← Older edit

Debug.log (view source)

Revision as of 14:13, 19 August 2021

368 bytes added , 19 August 2021

m

add category

Sfws

5,838

edits

Revision as of 09:21, 1 February 2021 (view source) Sfws (talk \| contribs) m (Text replacement - "[[MXDiags" to "[[MXDiags_folder") ← Older edit		Latest revision as of 14:13, 19 August 2021 (view source) Sfws (talk \| contribs) m (add category)
(4 intermediate revisions by the same user not shown)
The debug logging feature is extremely useful in troubleshooting problems with Cumulus. ~~=Introduction=~~ [[Category:~~Log Files~~Diagnostics]]▼ [[Category:Cumulus 1]] [[File:Badge v1.png]] This page only applies to Cumulus 1. [[Category:Cumulus Files]] == File growth and deletion ==▼ 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.▼ ~~The introduction to [[Diagnostics\|Diagnostics article]] is the place to look for general information about the files described here for Cumulus 1.~~ If debugging is switched on, extensive messages of the format shown are added to the file and it will rapidly grow in size. ▼ ~~This article is only for Cumulus 1 users, please see [[MXDiags_folder]] for equivalent file if you use Cumulus MX.~~ 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 . ▼ ~~=Details=~~ ~~== File names ==~~ =File Location, Name and Format= 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. ~~Any diagnostic~~#This file can be deleted, at any time, as Cumulus does not read from ~~them.~~it, ~~Cumulus~~and creates a new file ~~if necessary to continue its~~when ~~logging.~~needed▼ ~~All diagnostic~~#The log ~~files~~file ~~are~~is a simple text ~~files, with multiple lines (inside a~~ 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 ~~subfolder~~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 ~~the second place~~this is to be found on the [[Diags_folder\|diags folder]] page.▼ ~~# Each file in the diags folder has entries like the example below, regardless of whether debugging is turned on or off.~~ #* 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. ▲Further information about the second place is to be found on the [[Diags_folder\|diags folder]] page. ~~==File type, and content==~~ ▲All diagnostic log files are simple text files, with multiple lines (inside a file) containing the time and a description of each event. ~~Entries in '''debug.log''' are identified by date as fraction, and time e.g. ''9173.516 : 14:23:59''.~~ if you need help with a Cumulus 1 problem, then it can be useful to place this file, and those in the [[Diags_folder#Solving Cumulus 1 Errors\|diags sub-folder]] into a zip and add that file to your post in the support forum. ▲== File growth and deletion == ▲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. ▲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 . ▲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. ==Sample File ~~for Cumulus 1=~~= An extract from a ~~'''~~debug.log~~'''~~ file 9168.735 : 14:23:54 Realtime FTP Put attempt 9175.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: ▲[[Category:Log Files]] 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).