Check plugins - check-ntservice

• Unintended service outages are detected
• When the specified service is not found, an UNKNOWN alert is emitted

check-ntservice is a plugin that monitors whether Windows services are running.

Configurable options

Option	Short	Required	Description
--service-name	-s	✓	Monitor services that contain the specified string
--exclude-service	-x		Exclude from monitoring if the specified string is contained
--list-service	-l		Displays a list of service names
--exact			Check the service name for exact match
--status-as			Overwrite the monitoring status. For Example, if you specify CRITICAL=WARNING, the monitoring status will become WARNING when it is CRITICAL. Multiple values can be specified, separated by commas

• Multiple specification of options and specification by regular expressions are not supported.
• --exact has been enabled for plugins shipped with mackerel-agent v0.78.0 and later.
• --status-as has been enabled for plugins shipped with mackerel-agent v0.85.0 and later.

Example configuration

To monitor the availability of the W3SVC service, configure as follows.

[plugin.checks.ntsvc_w3svc]
command = ["check-ntservice", "--service-name", "W3SVC"]

To check the above settings manually, you can run the following at the command prompt.

• The path to the command must be included in the PATH system environment variable.

check-ntservice --service-name W3SVC

Tips

• You can confirm the service name in advance by executing the command with the --list-service option.

check-ntservice --list-service

Troubleshooting

Unintended service outages are detected

Because check-ntservice checks for services containing the string specified in the --service-name option, it may detect unintended service outages.

In this case, use the --exact or --exclude-service option to identify the target service or exclude services that contain unnecessary strings.

For example, if you have two services running, foo and foobar, and you want to monitor foo, you can simply specify the --exact option as follows.

[plugin.checks.ntsvc_w3svc]
command = ["check-ntservice", "--service-name", "foo", "--exact"]

It may also be excluded by specifying the --exclude-service option as follows.

[plugin.checks.ntsvc_w3svc]
command = ["check-ntservice", "--service-name", "foo", "--exclude-service", "foobar"]

When the specified service is not found, an UNKNOWN alert is emitted

An UNKNOWN alert with the message service does not exist. is caused when a service specified in the condition is not found.

Please check whether the correct service name is specified or not by utilizing the --list-service option.

Repository

https://github.com/mackerelio/go-check-plugins/tree/master/check-ntservice