Debug.log: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
mNo edit summary
mNo edit summary
(One intermediate revision by the same user not shown)
Line 1: Line 1:
Please see [[Diagnostics|Diags]] article. Read below for Cumulus 1, please see [[MXDiags]] for MX.
=Introduction=


However, a contributor amended this article for MX, although the relevant information for Cumulus 1 has been added back, the MX information below has not been moved to the correct article.
The introduction to [[Diagnostics|Diagnostics article]] is the place to look for general information about the files described here for Cumulus 1.


<big>APPEAL: Perhaps someone can now move the MX related information back to its correct place PLEASE</big>
This article is only for Cumulus 1 users, please see [[MXDiags]]  for equivalent file if you use Cumulus MX.


=Introduction=
=Details=
 
== File names ==
 
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.
# 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.
 
 
==File type,  and content==


The debug logging feature is extremely useful in troubleshooting problems with Cumulus and/or connectivity to your weather station or FTP upload communications.
All diagnostic log files are simple text files, with multiple lines (inside a file) containing the time and a description of each event.  


The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc.
Entries are identified by date as fraction, and time e.g. ''9173.516 : 14:23:59''.


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 (up to version 3.8.1 - b3091) to crash.  (From Release 3.8.2 - b3092 adds MXdiags log rotation to avoid this).  
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.


==Turning debugging log on/off==


*By default, logging of debugging information is disabled.
== File growth and deletion ==
*Restarting Cumulus (1, 2, or MX) will normally (you can manually change this) turn debug log off (because it is automatically turned off as Cumulus exits)
*Logging of debugging information can be enabled as Cumulus is started (see instructions below for your flavour)
*[[File:Badge vMx.png]] In MX only, you can turn the logging of debugging information on and off while it is running, using the admin interface (see below to identify which settings screen)


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.


{{Version badge 1}}Cumulus 1.x.y:  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#Section:_Station|Cumulus.ini configuration file]], and add a line in the [Station] section: <tt>Logging = 1</tt>, then restart Cumulus 1. From build 1003 onwards, you can also turn it on/off using the '''Configuration''' menu (debug option in menu).
Entries are added to the '''cumulus.~og''' file while Cumulus is left running, regardless of whether debugging is on or off.


[[File:Badge vMx.png]]Cumulus MX: There are three ways to '''turn on the logging''' of debugging messages in 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 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.  
# Close Cumulus MX, then edit [[Cumulus.ini#Read-Write_parameters_in_the_Station_section|Cumulus.ini configuration file]], and add a line in the [Station] section: <tt>Logging = 1</tt>, then restart Cumulus MX.
# When you start Cumulus MX, use [[Cumulus_MX#Parameter_for_adding_debugging|Parameter for adding debugging]] as part of the command for starting
# Use the [[MX_Administrative_Interface#Changing_Settings|admin interface Settings menu]], next ''tick'' the 'Debug Logging' menu option, and finally click '''Save''', on the appropriate web page depending on which version of MX you are using (see below). You can untick the option to disable the logging of debugging information
#* '''Program settings''' web page for version 3.9.4 - build 3099 onwards
#* [[MX_Administrative_Interface#Station_Settings|'''Station settings''']] web page for earlier MX versions


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


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


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 diagnostic file '''cumulus.~og''' also logs 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 CumulusMX, debug logging adds additional detail into the standard logging file. Entries are timestamped by date and time e.g. ''2020-09-07 14:26:21.793''.  These logging files are in sub-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'''
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 CumulusInclude 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, ''and when'' it encountered the problem and failed.  


The log file is a simple text file containing the time and a description of each event.  
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.  Add '''debug.log''' from the folder above into the zip.


The file can be deleted at any time as Cumulus does not read from it.
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').


==Sample File for Cumulus 1==
==Sample File for Cumulus 1==
Line 66: Line 70:
  9175.328 : TD = 0.0833333358168602 Lastval = 618 Firstval = 618 rate = 0
  9175.328 : TD = 0.0833333358168602 Lastval = 618 Firstval = 618 rate = 0


== Sample File extract for Cumulus MX ==
An extract from 20200907-142621.txt
<pre> 
2020-09-07 14:26:21.693 Cumulus MX v.3.8.3 build 3093
2020-09-07 14:26:21.715 Platform: Win32NT
2020-09-07 14:26:21.715 OS version: Microsoft Windows NT 6.2.9200.0
2020-09-07 14:26:21.746 Current culture: English (United Kingdom)
2020-09-07 14:26:21.746 Directory separator=[\] Decimal separator=[.] List separator=[,]
2020-09-07 14:26:21.746 Date separator=[/] Time separator=[:]
2020-09-07 14:26:21.746 Standard time zone name:  GMT Standard Time
2020-09-07 14:26:21.746 Daylight saving time name: GMT Summer Time
2020-09-07 14:26:21.746 Daylight saving time? True
2020-09-07 14:26:21.746 07/09/2020 14:26:21
2020-09-07 14:26:21.762 Reading Cumulus.ini file
2020-09-07 14:26:21.777 ASM=10 AST=00:10:00
2020-09-07 14:26:21.777 Cumulus start date: 19 January 2020
2020-09-07 14:26:21.793 Data path = data\
2020-09-07 14:26:21.878 Creating backup folder backup\20200907142621\
2020-09-07 14:26:22.232 Created backup folder backup\20200907142621\
2020-09-07 14:26:22.232 Debug logging is enabled
2020-09-07 14:26:22.232 Data logging is disabled
2020-09-07 14:26:22.232 FTP logging is disabled
2020-09-07 14:26:22.232 Spike logging is enabled
2020-09-07 14:26:22.232 Logging interval = 10 mins
2020-09-07 14:26:22.232 Real time interval = 55 secs
2020-09-07 14:26:22.232 NoSensorCheck = 0
2020-09-07 14:26:22.294 Calculating sunrise and sunset times
2020-09-07 14:26:22.310 Sunrise: 06:32:24
2020-09-07 14:26:22.310 Sunset : 19:44:49
</pre>
[[Category:Log Files]]
[[Category:Log Files]]

Revision as of 03:27, 22 January 2021

Introduction

The introduction to Diagnostics article is the place to look for general information about the files described here for Cumulus 1.

This article is only for Cumulus 1 users, please see MXDiags for equivalent file if you use Cumulus MX.

Details

File names

Cumulus 1 creates diagnostic logs in two places:

  1. It creates a file called Debug.log in the same folder as where the executable is stored.
  2. 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.


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 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 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 growth and deletion

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.

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.

Solving Cumulus 1 Errors

The diagnostic file cumulus.~og also logs 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.

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, and when it encountered the problem and failed.

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. Add debug.log from the folder above into the zip.

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

Sample File for Cumulus 1

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