Custom Logs: Difference between revisions

m
 
(2 intermediate revisions by the same user not shown)
Line 16: Line 16:
'''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/>'''
'''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.'''
'''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.'''
'''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 78: 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]]