Category:Diagnostics: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
mNo edit summary
Line 4: Line 4:
The debug logging feature is extremely useful in troubleshooting problems with Cumulus and/or connectivity to your weather station or FTP upload communications.
The debug logging feature is extremely useful in troubleshooting problems with Cumulus and/or connectivity to your weather station or FTP upload communications.


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




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


= Note re Cumulus MX =


Please see [[MXDiags|MX Diagnostics article]]
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).
 
==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)
 
{{Version badge 1}}Cumulus 1.x.y:  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#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 is included in drop down of that menu).


== Solving Cumulus 1 Errors ==
[[File:Badge vMx.png]]Cumulus MX: There are three ways to '''turn on the logging''' of debugging messages in all versions of 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


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.
= Further details =


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''' folderespecially for problems that occur when you start or restart Cumulus.  Include all files, 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.
Separate articles exist for each flavour.


== Debugging in Cumulus MX ==


Please see [[MXDiags|MX Diagnostics article]]


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


== Debugging in Cumulus 1 ==
== Debugging in Cumulus 1 ==


See [[Debug.log]] as this is separate file stored in the top directory.
Please see [[Debug.log]] article.
 
[[Category: Cumulus Files‏‎]]
[[Category: Cumulus Files‏‎]]

Revision as of 02:50, 22 January 2021

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 file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc.


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


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

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)

Cumulus Version 1 SpecificCumulus 1.x.y: 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 configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus 1.
  • From build 1003 onwards, you can also turn it on/off using the Configuration menu (debug option is included in drop down of that menu).

Badge vMx.pngCumulus MX: There are three ways to turn on the logging of debugging messages in all versions of Cumulus MX:

  1. Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
  2. When you start Cumulus MX, use Parameter for adding debugging as part of the command for starting
  3. Use the 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
    • Station settings web page for earlier MX versions

Further details

Separate articles exist for each flavour.

Debugging in Cumulus MX

Please see MX Diagnostics article


Debugging in Cumulus 1

Please see Debug.log article.

Pages in category "Diagnostics"

The following 4 pages are in this category, out of 4 total.

B

D

M

Retrieved from "https://www.cumuluswiki.org/index.php?title=Category:Diagnostics&oldid=7512"