Category:Log Files

From CumulusWiki
Jump to: navigation, search

Below is a list of the Log files within Cumulus.

Descriptions, and tips, can also be found in the Help file within the Cumulus software.

Remember, if you edit any of these log files to obey cautions in the individual articles:

  • stop cumulus before editing any file that Cumulus might be updating,
  • don't use a word processor (that adds lots of unwanted control characters),
  • don't change the format of files for example don't change format of dates or real numbers (using a spreadsheet, like Microsoft Office Excel or Libre Office Calc, don't let dates or special numbers be recognised),
  • don't add 'Byte Order Mark' (many pieces of software on Microsoft Windows such as Notepad treat a BOM as a required magic number and add a BOM when saving text as UTF-8. Google Docs also adds a BOM when converting a document to a plain text file for download.),
  • don't add blank lines (the only 'blank' line in a log file is the final one, where Cumulus will later append the next item),
  • don't add headers to files where Cumulus needs to read the file as well as update it (Cumulus reads all log files except Alltimelog.txt).

Essentially, there are 4 types:

  1. .ini files - these hold values that represent sums, counts, or extremes, for cumulus to read, and update, as it reads the weather observations.
  2. .txt files - these are the logs that Cumulus updates at defined intervals to hold details of what has happened, but it can also read these files when requested.
  3. .xml file - this holds the Weather_Diary. Although it uses standard XML, the component that Cumulus 1 uses also writes a special value that other XML editors will not understand.
  4. .log file - cumulus writes either "Logging Disabled" messages or logs its actions in detail for debugging purposes into debug.log.

These files apply to both Cumulus 1 and Cumulus MX. Note that file names are case-sensitive, read documentation to see where capital letters are required.

Cumulus MX also has some JSON files with data for its trends web page.