Small amendment to README

This commit is contained in:
Thomas Williams 2024-07-04 14:09:21 +01:00
parent 2e6157e8ec
commit df0f19949a
Signed by: thomas
GPG key ID: EB8F975CF60BCBFF

View file

@ -11,7 +11,8 @@ Both CPU/RAM monitoring and URL monitoring can be set on their own monitoring pe
- urlTimeout - the delay before considering a URL to have timed out. - 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. - 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. - 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 - loggingMode - Valid options: mssql, mariadb, rabbitmq, none.
- sqlDatabase - the database to write the data - sqlServer - the address of the SQL server which to write the data.
- sqlUsername - the username used to authenticate to the SQL server - sqlDatabase - the database to write the data.
- sqlPassword - the password used to authenticate to the SQL server - sqlUsername - the username used to authenticate to the SQL server.
- sqlPassword - the password used to authenticate to the SQL server.