Debug.log: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Debug.log (view source)

Revision as of 14:13, 19 August 2021

646 bytes added ,  14:13, 19 August 2021
m
add category
mNo edit summary
m (add category)
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Introduction=
The debug logging feature is extremely useful in troubleshooting problems with Cumulus.
[[Category:Diagnostics]]
[[Category:Cumulus 1]] [[File:Badge v1.png]] This page only applies to Cumulus 1.
[[Category:Cumulus Files]]
== File growth and deletion ==


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 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.


This article is only for Cumulus 1 users, please see [[MXDiags]]  for equivalent file if you use Cumulus MX.
If debugging is switched on, extensive messages of the format shown are added to the file and it will rapidly grow in size.  


Cumulus 1 creates diagnostic logs in its diags folder; '''diags''' is a subfolder of the folder where the Cumulus executable is stored.  It contains 10 files named cumulus.~og and cumulus.001 to cumulus.009.  These represent logs for previous 9 Cumulus restarts and the current log reporting what has happened since the last time Cumulus was started.
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 .  
These files log many of the actions performed by Cumulus 1. They will show the [[:Category:Cumulus Files|Cumulus specific files]] that have been accessed, values found or calculated from log files, before and after values for updates to highs and lows for monthly and annual extreme records, rejected spikes, and much more.




== Solving Cumulus 1 Errors ==
=File Location, Name and Format=


The diagnostic files also log error messages, often with extra information compared to the error window (accessed by clicking ''error'' light/indicator), and may help you if you have a problem.
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.


When you ask for support via the forum, you often need to upload (as a zip) one or all of the diagnostic files in the '''Diags''' folder especially for problems that occur when you start or restart Cumulus.  Include all files in the folder, unless you definitely know that a single diags file contains all the information for when Cumulus 1 is running normally as well as when it encountered the problem and failed.  Add '''debug.log''' from the folder above in the zip.


=Sample File=


 
An extract from a debug.log file
In Windows Explorer, open the Cumulus installation folder (default is C:\Cumulus). Right-click on the 'Diags' folder, and from the pop-up menu, select 'Send to -> Compressed (zipped) Folder' (available in most Windows versions). This will create a file called Diags.zip. Post your message in the forum, and attach the file using the 'Attachment' section below the area where you have typed your message (browse for the file, then click 'Add the file').
 
=Details=
 
==File Location, Name and Format==
 
In Cumulus 1, the file is called Debug.log, and is located in the root of the Cumulus folder. Entries are identified by date as fraction, and time e.g. ''9173.516 : 14:23:59''.
 
 
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 for Cumulus 1==
 
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
Line 54: Line 52:
  9175.328 : TD = 0.0833333358168602 Lastval = 618 Firstval = 618 rate = 0
  9175.328 : TD = 0.0833333358168602 Lastval = 618 Firstval = 618 rate = 0


[[Category:Log Files]]
=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).
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/7514...9773"

Navigation menu