1,643
edits
Custom Logs: Difference between revisions
m
→IMPORTANT
m (→IMPORTANT) |
m (→IMPORTANT) |
||
| Line 9: | Line 9: | ||
=== '''IMPORTANT''' === | === '''IMPORTANT''' === | ||
'''NOTE: The formatting of the datafiles is important as the Custom Logs are basically free format: you can put into the file any text and numbers with any separator you wish. CUtils will NOT handle that Free Format in general. The user has to take care the information in the resulting datafiles is as follows:''' | '''1) NOTE: The formatting of the datafiles is important as the Custom Logs are basically free format: you can put into the file any text and numbers with any separator you wish. CUtils will NOT handle that Free Format in general. The user has to take care the information in the resulting datafiles is as follows:''' | ||
'''1) There MUST be at least one space or your local separator between the webtags; ''' | '''1) There MUST be at least one space or your local separator between the webtags; ''' | ||
'''2) There cannot be any plain text in the logfile''' | '''2) There cannot be any plain text in the logfile''' | ||
| Line 16: | Line 16: | ||
If there is free text in the definition of the log, the CustomLogs module will ignore that and parse only the webtags which result in a number. | If there is free text in the definition of the log, the CustomLogs module will ignore that and parse only the webtags which result in a number. | ||
'''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: 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. | ||
''' | ''' | ||
'''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''.''' | '''3) 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: 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. 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. That may give unexpected effects for you.''' | '''4) 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. 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. That may give unexpected effects for you.''' | ||
=== Dependency === | === Dependency === | ||