========================================================================== README NOTES FOR mod_benchmark VERSION: 1.6.0 ========================================================================== 1.WHAT IS "mod_benchmark" ? --------------------------- "mod_benchmark" is an Apache module which purpose is to give statistics about the mean time needed by the server to answer the requests. Thus, "benchmark" is a bad name, it's more a kind of chronometer, but "mod_benchmark" is not only a logging module that measures the time. It is also able to alert you when selected requests last too long and it is provided with a control panel that gives a graphical interface to view and exploit the collected statistics. 2.FUNCTIONALITIES ----------------- "mod_benchmark" behaviour is directed by specific Apache directives (see directives.html file). Some of them are "global" (per-server), others are "local" (per-location). You tell "mod_benchmark" to measure and log time taken to answer the requests you want. These requests can be determined by "/Location" and by file extension. Thus, you probably will be more interested by tracing "php" requests than "gif "or "jpg" ones ! Logs are stored in the Apache log and/or in any Database where you have previously created the requested tables. Using a DB is much faster and will allow you to get statistical graphs about the measures. "mod_benchmark" is also able to generate "alerts" when a time threshold has been reached for the traced request. It can be useful to detect, in real-time, when your server is getting slower and allow you to check the system load. It is also an indicator about the quality of service of your server. List of measures: ---------------- For each traced request, "mod_benchmark" will compute and store a set of indicators that will help you understand if there was a side-effect that can explain time differences. The indicators are: - the request itself - the args of the request - the request time, in microseconds - the HTTP request status - the count of other busy Apache server instances - the count of sleeping Apache server instances - the count of zombie processes - the count of running processes - the count of stopped processes - the count of sleeping processes - the percentage of used memory - the percentage of used swap - the mean CPU load (computed at selected intervals) 3.REQUIREMENTS -------------- Linux Apache PHP with GD a DB like MySQL or Sybase ASE 4.HOW TO INSTALL IT ? --------------------- Follow the guide in INSTALL file... 5.TODO ------ a) if required, I can port "mod_benchmark" under Windows NT/2000 b) if required, I can develop interface for other DB Thanks, and let me know if you find this module useful ! Send your comments to: jd@trickytools.com ================================ EOF =====================================