Cumulus Wiki

Debug.log: Difference between revisions

Page Discussion

Debug.log (view source)

Revision as of 03:00, 22 January 2021

2,728 bytes removed ,  22 January 2021
m
no edit summary
mNo edit summary
mNo edit summary
=Introduction=▼
Please see [[Diagnostics|Diags]] article. Read below for Cumulus 1, please see [[MXDiags]] for MX.
 
The introduction to [[Diagnostics|Diagnostics article]] is the place to look for general information about the files described here for Cumulus 1.
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.
 
This article is only for Cumulus 1 users, please see [[MXDiags]] for equivalent file if you use Cumulus MX.
<big>APPEAL: Perhaps someone can now move the MX related information back to its correct place PLEASE</big>
 
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.
▲=Introduction=
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.
 
The debug logging feature is extremely useful in troubleshooting problems with Cumulus and/or connectivity to your weather station or FTP upload communications.
 
== Solving Cumulus 1 Errors ==
The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc.
 
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.
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).
 
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.
==Turning debugging log on/off==
 
*By default, logging of debugging information is disabled.
*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)
 
 
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').
{{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).
 
[[File:Badge vMx.png]]Cumulus MX: There are three ways to '''turn on the logging''' of debugging messages in Cumulus MX:
# 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=
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''.
 
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'''
 
The log file is a simple text file containing the time and a description of each event.
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]]
Sfws
5,838

edits

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