1,651
edits
Custom Logs: Difference between revisions
m
→Inifile Parameters
| (9 intermediate revisions by the same user not shown) | |||
| Line 9: | Line 9: | ||
=== '''IMPORTANT''' === | === '''IMPORTANT''' === | ||
'''NOTE: | '''1) NOTE: Be aware that for every webtag an entry in the JSON datafile will be created for the period of number of hours you have defined for the charts. This may lead to large datafiles being transferred every interval, data duplication (data already present in the standard datafiles of CMX or CUtils) and high memory use and performance of your server while displaying the charts may be the result. So the user is warned to think about what he really wants to log and view. | ||
''' | |||
'''2) NOTE: Webtag values are the actual momentane values when asked at CMX. Be aware that a webtag value is NEVER an average of the period before it. That is also not the case for the DAILY values where it would maybe be kind of natural to expect such value. A better name for Daily in this case would be the ''Midnight value''.''' | |||
'''NOTE: | '''3) NOTE: When you define or modify a CustomLog in CMX, you have to run CUtils with CustomLogs (or Website) as argument because there is no connection between CMX and CUtils: running CUtils will fetch the info from CMX and update the website accordingly. It will reset the JSON and a full dataset will be transferred to the webserver. However: if a new CustomLog did not yet contain any data, you will have to run CUtils again when it has. If you do not, the JSON will not adhere to the new definition and the PHP upload will not be able to do incremental uploads which will produce errors in the logfile. This should not be an issue for FTP uploads which are not incremental.<br/>''' | ||
''' | '''Also note that ''the frequency'' for the CustomLogs has no connection with the ''Internet Interval'' with which the data on the webserver (the JSONs) are updated, this may give unexpected effects for you.''' | ||
'''NOTE: | '''4) NOTE: The definition of a CustomLog can only contain one separator between the webtags. That separator is either the separator defined by the locale or a space. Two or more separators will lead to errors.''' | ||
=== Dependency === | === Dependency === | ||
| Line 26: | Line 24: | ||
If the user has already run [[Extra Sensors]] module, the file CutilsCharts.def will contain the line | If the user has already run [[Extra Sensors]] module, the file CutilsCharts.def will contain the line | ||
; ExtraSensorCharts | ; ExtraSensorCharts | ||
And everything below these lines will be replaced by generated ExtraSensors charts | And everything below these lines will be replaced by generated ExtraSensors charts (up to but not including the following CustomLogs demarcation line). | ||
A similar section will be created for the Custom Logs charts with the line | A similar section will be created for the Custom Logs charts with the CustomLogs demarcation line: | ||
; CustomLogsCharts | ; CustomLogsCharts | ||
and the parameter | |||
UserModificationCustomLogsCharts=true | UserModificationCustomLogsCharts=true | ||
will provide the possibility to modify the charts. | will provide the possibility to modify the charts (default is false). | ||
Again: be aware that making the modification of the charts manual will no longer overwrite. If you lose track and want to start over again with automatic chart generation set this parameter to false. | Again: be aware that making the modification of the charts manual will no longer overwrite. If you lose track and want to start over again with automatic chart generation set this parameter to false. | ||
| Line 78: | Line 72: | ||
The user can optionally create or modify the charts himself by setting the parameter ''UserModificationCustomLogsCharts'' to true and subsequently edit ''CutilsCharts.def''. <br> | The user can optionally create or modify the charts himself by setting the parameter ''UserModificationCustomLogsCharts'' to true and subsequently edit ''CutilsCharts.def''. <br> | ||
The outputfile for the charts MUST always be ''customlogscharts.txt'' so the first chart in the CustomLogs section ends with: <code>EndChart Output customlogscharts.txt</code> | The outputfile for the charts MUST always be ''customlogscharts.txt'' so the first chart in the CustomLogs section ends with: <code>EndChart Output customlogscharts.txt</code> but the user may change this with manual modification. | ||
== Inifile Parameters == | == Inifile Parameters == | ||
| Line 86: | Line 80: | ||
CustomLogs=false => If false (default) the module is skipped, no menu entry will be made | CustomLogs=false => If false (default) the module is skipped, no menu entry will be made | ||
UserModificationCustomLogsCharts=false => If true the ''CustomLogs'' charts will not be overwritten in ''CutilsCharts.def'' and give the user the possibility to create his own charts | UserModificationCustomLogsCharts=false => If true the ''CustomLogs'' charts will not be overwritten in ''CutilsCharts.def'' and give the user the possibility to create his own charts | ||
DoneToday=2023-10-16T12:41:00 => Exists and has a value when the JSON datafile(s) have been uploaded at least once. In case of PHP upload, removing this parameter makes sure next upload will non-incremental. | DoneToday=2023-10-16T12:41:00 => Exists and has a value when the JSON datafile(s) have been uploaded at least once. In case of PHP upload, removing this parameter makes sure next | ||
upload will non-incremental. | |||
ExcludedCustomLogs= => Is empty or contains a comma separated list of CustomLog names. Named logs are excluded from processing by CUtils. | |||
As CustomLogs is a CMX feature, it must be possible to have CustomLogs being used for purposes outside CUtils. If that is the case, exclude them here. | |||
[[Category:CumulusUtils]] | [[Category:CumulusUtils]] | ||