Debug.log: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
No edit summary |
m (CORRECTED - now right for Cumulus 1 again, and also now usable for people using MX 3.9.3 and below) |
||
| 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 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. |
The file contains a wealth of data including the raw data received from your weather station, connectivity attempts, file uploads, etc. |
||
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) |
|||
*[[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) |
|||
{{Version badge 1}}Cumulus 1.x.y: The only way to turn on the logging of debugging messages in 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. |
|||
[[File:Badge vMx.png]]Cumulus MX: There are three ways to '''turn on the logging''' of debugging messages in Cumulus MX: |
|||
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. |
|||
# 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= |
|||
=File Location, Name and Format= |
==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 Cumulus 1, the file is called Debug.log, and is located in the root of the Cumulus folder. |
||
| Line 19: | Line 36: | ||
The file can be deleted at any time as Cumulus does not read from it. |
The file can be deleted at any time as Cumulus does not read from it. |
||
=Sample File= |
==Sample File for Cumulus 1== |
||
An extract from a debug.log file |
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 |
||
Revision as of 19:50, 12 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.
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)
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)
Cumulus 1.x.y: The only way to turn on the logging of debugging messages in 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.
Cumulus MX: There are three ways to turn on the logging of debugging messages in Cumulus MX:
- Close Cumulus MX, then edit Cumulus.ini configuration file, and add a line in the [Station] section: Logging = 1, then restart Cumulus MX.
- When you start Cumulus MX, use Parameter for adding debugging as part of the command for starting
- 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
Details
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 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
