Debug.log: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (Text replacement - "[[MXDiags" to "[[MXDiags_folder")
m (Reverted edits by Sfws (talk) to last revision by ExperiMentor)
Tag: Rollback
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 introduction to [[Diagnostics|Diagnostics article]] is the place to look for general information about the files described here for Cumulus 1.
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.


This article is only for Cumulus 1 users, please see [[MXDiags_folder]]  for equivalent file if you use Cumulus MX.
The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc.


=Details=


== File names ==
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.


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 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 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.
#* Each file in the diags folder has entries like the example below, regardless of whether debugging is turned on or off.


Further information about the second place is to be found on the [[Diags_folder|diags folder]] page.
=File Location, Name and Format=


==File type, and content==
In Cumulus 1, the file is called Debug.log, and is located in the root of the Cumulus folder.


All diagnostic log files are simple text files, with multiple lines (inside a file) containing the time and a description of each event.  
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


Entries in '''debug.log''' 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.


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.
=Sample File=


== File growth and deletion ==
An extract from a debug.log file
 
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
  9168.735 : 14:23:54 Realtime FTP Put attempt
Line 63: Line 42:
  9175.328 : Adding LH entry, ts = 14:24:00 raintot = 618
  9175.328 : Adding LH entry, ts = 14:24:00 raintot = 618
  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]]
[[Category:Log Files]]

Revision as of 06:04, 29 April 2021

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

The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc.


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.


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

An extract from a debug.log file 

9168.735 : 14:23:54 Realtime FTP Put attempt
9168.766 : 14:23:54 Realtime FTP local file: C:\Program Files\Cumulus\realtime.txt
9168.766 : 14:23:54 Realtime FTP remote file: /var/www/html/data/realtime.txt
9173.500 : 14:23:59 USB device is plugged in
9173.500 : 14:23:59 request EW data block, written = 9, addr = 000000 
9173.516 : 14:23:59 EW data line 01  55 AA FF FF FF FF FF FF 
9173.516 : 14:23:59 EW data line 02  FF FF FF FF FF FF FF FF 
9173.531 : 14:23:59 EW data line 03  0A 20 08 25 11 00 00 00 
9173.531 : 14:23:59 EW data line 04  81 00 00 F0 0F 00 10 DD 
9173.531 : 14:23:59 USB device is plugged in
9173.547 : 14:23:59 request EW data block, written = 9, addr = 00DD10 
9173.563 : 14:23:59 EW data line 05  00 3A BF 00 47 97 00 FD 
9173.578 : 14:23:59 EW data line 06  25 00 03 00 0B 0C 08 00 
9173.578 : 14:23:59 Data: 00 3A BF 00 47 97 00 FD 25 00 03 00 0B 0C 08 00 
9173.578 : 14:23:59 EW data line 07  0A 2D D5 00 55 57 00 16 
9173.594 : 14:23:59 EW data line 08  26 00 00 00 06 65 07 00 
9175.328 : 27/08/2009 14:24:00 Minute timer 24
9175.328 : Adding LH entry, ts = 14:24:00 raintot = 618
9175.328 : TD = 0.0833333358168602 Lastval = 618 Firstval = 618 rate = 0
Retrieved from "https://www.cumuluswiki.org/index.php?title=Debug.log&oldid=8724"