C:/Program Files (x86)/CollectdWin/conf/or
C:/Program Files/CollectdWin/conf/(depending on the version of windows).
enablesetting for the
CollectdWin.configfile to enable the system checks.
Currently, Metricly comes with three pre-built checks: Heartbeat, Processes, and Ports. These are turnkey checks that do not require any scripting or coding, just simple configuration setting in the respective configuration files.
This check is enabled by default. The Heartbeat check is to monitor the state of the agent. This check is enabled by default so no additional configuration is required once the Windows Checks have been enabled.
To disable this check, open the
../CollectdWin/conf/ReadSystemChecks.config and change the
EnableAgentHeartbeat setting to
Note that each check has a TTL (time to live) timer which is expressed as a multiple of the agent collection interval time. The default agent collection interval is 60 seconds so a TTLMultiplier of 2.0 would mean that the check timer would expire if no new post has been made to the API within 120 seconds. The minimum value allowed is 1.0 and decimal values are allowed. The intent is to have the TTL timer slightly be longer in duration than the posting frequency for the checks. This will allow some buffer and avoid potential “flapping” due to network latency or processing delays.
<readsystemchecks enableagentheartbeat="true" heartbeatttlmultiplier="2.0"> </readsystemchecks>
Configure HTTP checks to send an
HTTP GET request to a URL. If a successful response is returned a check is sent to Metricly. By default, no HTTP checks are configured.
Add something like:
<HttpCheck Name="MyTestHTTPCheck" Url="http://www.google.com" StatusMatches="^(?!4|5)" />
To your ReadySystemChecks.config file:
<ReadSystemChecks EnableAgentHeartbeat="true" HeartbeatTTLMultiplier="2.5"> <Checks> <HttpCheck Name="MyTestHTTPCheck" Url="http://www.google.com" StatusMatches="^(?!4|5)" /> </Checks> </ReadSystemChecks>
HTTP GETrequest sent to the given URL returns a successful response. Redirects are automatically followed.
^2which matches any
2xxcode. Other examples:
^(?!4|5): any code except
By default, no process or service checks are enabled.
To add a new check:
Namesetting is the service name. This can be found by opening the service in the Service Control Manager (note that it is the Service Name, not the Display Name).
Namesetting is is the process name as it appears in the performance monitor process list (this is typically the same as it appears in Task Manager but without the file extension).
TTLMultiplierto configure the check time-to-live as a multiple of the agent collection interval.
Alias=”my check alias”setting to provide an alias for the check received by Metricly. If it is not supplied then the process name is used.
UseRegex=”true”to the check configuration. With this set to true the
Namefield is used as a regular expression instead of an exact match and may match several processes.
<ServiceCheck Name="MSSQLSERVER" Alias="sqlservercheck" TTLMultiplier="2.5"/> <ProcessCheck Name="Process123" Alias="process123" TTLMultiplier="2.5"/>
No port checks are configured by default.To configure the port checks requires the same steps documented above for the Service and Process checks except that the Name is simply the check name and the Port must be specified.
<PortCheck Name="ApplicationABC" Port="8081"/>