monutil/README.md

# monutil

Simple Python utility for monitoring CPU and RAM usage, and monitoring the speed when downloading URLs.
Both CPU/RAM monitoring and URL monitoring can be set on their own monitoring periods. See the available configuration options, which should be specified in config.py.

**Configuration options:**

- hostMonitoringPeriod - the delay in between the CPU and RAM usage being probed (defined in seconds).
- urlMonitoringPeriod - the delay in between monitoring all of the URLs (defined in seconds).
- urls - the list of URLs to monitor (e.g. ["url1", "url2"]).
- urlTimeout - the delay before considering a URL to have timed out.
- maxWorkers - the amount of threads to use when pulling URL resources. Do not set above the maximum number of threads on the host.
- forceNonPOSIXCPU - For POSIX compatible systems, psutil.getloadavg() is executed which relies on os.getloadavg(). For Windows, this seemingly returns 0 (at least on the version executed during development). For Windows, a custom function has been built to obtain running CPU averages, but you can choose to use this function on POSIX systems by setting this variable to True.
- sqlServer - the address of the SQL server which to write the data
- sqlDatabase - the database to write the data
- sqlUsername - the username used to authenticate to the SQL server
- sqlPassword - the password used to authenticate to the SQL server
Initial commit 2024-06-25 19:06:57 +00:00			`# monutil`

Wording change 2024-06-27 17:38:35 +00:00			`Simple Python utility for monitoring CPU and RAM usage, and monitoring the speed when downloading URLs.`
Wording change 2024-06-27 17:38:54 +00:00			`Both CPU/RAM monitoring and URL monitoring can be set on their own monitoring periods. See the available configuration options, which should be specified in config.py.`
Resolves issue #6 2024-06-27 17:37:27 +00:00
			`Configuration options:`

			`- hostMonitoringPeriod - the delay in between the CPU and RAM usage being probed (defined in seconds).`
			`- urlMonitoringPeriod - the delay in between monitoring all of the URLs (defined in seconds).`
Amendment to readme 2024-06-27 18:00:06 +00:00			`- urls - the list of URLs to monitor (e.g. ["url1", "url2"]).`
Resolves issue #6 2024-06-27 17:37:27 +00:00			`- urlTimeout - the delay before considering a URL to have timed out.`
			`- maxWorkers - the amount of threads to use when pulling URL resources. Do not set above the maximum number of threads on the host.`
Updated README 2024-07-03 20:57:55 +00:00			`- forceNonPOSIXCPU - For POSIX compatible systems, psutil.getloadavg() is executed which relies on os.getloadavg(). For Windows, this seemingly returns 0 (at least on the version executed during development). For Windows, a custom function has been built to obtain running CPU averages, but you can choose to use this function on POSIX systems by setting this variable to True.`
			`- sqlServer - the address of the SQL server which to write the data`
			`- sqlDatabase - the database to write the data`
			`- sqlUsername - the username used to authenticate to the SQL server`
			`- sqlPassword - the password used to authenticate to the SQL server`