From 5d810730eb94a177595a742ebcf6a9ff9bd6c424 Mon Sep 17 00:00:00 2001 From: Thomas Williams Date: Thu, 27 Jun 2024 18:37:27 +0100 Subject: [PATCH] Resolves issue #6 --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 88348d3..66b03d6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ # monutil -Simple python utility for monitoring CPU and RAM usage, and external URLs \ No newline at end of file +Simple python utility for monitoring CPU and RAM usage, and the speed when downloading URLs. +Both CPU/RAM monitoring and URL monitoring can be set on their own monitoring periods. + +**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.