Debug.log: Difference between revisions

1,189 bytes added ,  22 January 2021
m
no edit summary
mNo edit summary
mNo edit summary
This article is only for Cumulus 1 users, please see [[MXDiags]] for equivalent file if you use Cumulus MX.
 
=Details=
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.
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.
 
== File names ==
 
Cumulus 1 creates diagnostic logs in two places:
== Solving Cumulus 1 Errors ==
# It creates a file called '''Debug.log''' in the same folder as where the executable is stored.
# It creates a diags folder; '''diags''' is a subfolder 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.
 
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.
 
==File type, and content==
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.
 
TheAll diagnostic log filefiles is aare simple text files, with multiple lines (inside a file) containing the time and a description of each event.
 
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''.
 
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.
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, Namegrowth and Formatdeletion ==
 
A new file is created each time Cumulus is restarted, after deleting the oldest and renaming the other old files to maintain the naming sequence. If debugging is switched off, periodically a message, confirming that, is added to the '''debug.log''' file, so it grows in size even when full diagnostics are not being stored.
 
Entries are added to the '''cumulus.~og''' file while Cumulus is left running, regardless of whether debugging is on or off.
 
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 current diagnostic files will grow in size. If the file is left to grow too large, Cumulus will crash. Therefore, you may want to delete these files.
 
TheAny diagnostic file can be deleted at any time as Cumulus does not read from itthem. Cumulus creates a new file if necessary to continue its logging.
 
== Solving Cumulus 1 Errors ==
 
The diagnostic filesfile '''cumulus.~og''' also loglogs error messages, often with extra information compared to the error window (accessed by clicking ''error'' light/indicator), and that file may help you if you have a problem.
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''.
 
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 ''both when'' Cumulus 1 is running normally, as well as''and when'' it encountered the problem and failed. Add '''debug.log''' from the folder above in the zip.
 
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 theAdd 'Attachment''debug.log''' section belowfrom the areafolder whereabove you have typed your message (browse forinto the file, then click 'Add the file')zip.
The log file is a simple text file containing the time and a description of each event.
 
Post your message in the forum, and attach the zip file using the 'Attachment' section below the area where you have typed your message (browse for the file, then click 'Add the file').
The file can be deleted at any time as Cumulus does not read from it.
 
==Sample File for Cumulus 1==
5,838

edits