5,838
edits
MXdiags folder: Difference between revisions
m
add category
m (add category) |
m (add category) |
||
| (11 intermediate revisions by the same user not shown) | |||
|
=Introduction=
[[Category:Diagnostics]]
The introduction to [[:Category:Diagnostics|Diagnostics article]] is the place to look for general information about the files described here for Cumulus MX.
This article is about the MX diagnostic log file. Please see the [[Debug.log]] article for Cumulus 1 specific equivalent.
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'''
Entries are timestamped by date and time e.g. ''2020-09-07 14:26:21.793''.
= How to change the content of the diagnostics log file =▼
The "CreateMissing.exe" utility program will also store a log of what it does in this folder, see [[Calculate_Missing_Values#CreateMissing.exe]] for details.
The contents stored in these diagnostic log files can be enhanced by turning '''debugging on''' and/or by turning '''data logging''' on (see later sections for details of these).
When starting MX beta, add '''CumulusMX.exe -debug''' (to have full debugging turned on as MX starts), '''CumulusMX.exe -Logging=1''' (for the weather station specific logging). For example, <pre>sudo mono CumulusMX.exe -debug -Logging=1</pre> for both options described below.
Since MX came out of beta, the two options have been combined, only '''-debug''' is now required.
You can also switch logging on/off using the admin interface as described below.
== Standard diagnostic Logging ==▼
▲== Standard diagnostic Logging =
A certain amount of information about what MX is doing is always stored in the current diagnostics log file. Even without the extras, described below, switched on a lot of information is recorded.
There are three ways to turn on the logging of weather station debugging messages in all versions of Cumulus MX:
# (Releases 3.0.0 to 3.9.8) 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
#* (Example was given earlier)
# Use the[[MX_Administrative_Interface#Changing_Settings| admin interface Settings menu]], next tick the 'Data 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 data transfer information
#** Program settings web page for version 3.9.4 - build 3099 onwards
#** Station settings web page for earlier MX versions
Up to release 3.11.1, any change made using the admin interface was not saved into [[Cumulus.ini]], and therefore when you restarted MX it reverted to setting in that file.
From release 3.11.2, any change made using the admin interface is now saved into [[Cumulus.ini]], and therefore when you restart MX, it continues to follow what was last set, over-ridden by any debug parameter added to the starting command.
= Debug Logging =
# 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▼
#**
Up to release 3.11.1, any change made using the admin interface was not saved into [[Cumulus.ini]], and therefore when you restarted MX it reverted to setting in that file.
From release 3.11.2, any change made using the admin interface is now saved into [[Cumulus.ini]], and therefore when you restart MX, it continues to follow what was last set, over-ridden by any debug parameter added to the starting command.
</pre>
[[Category:
| |||