Windows - Services (WMI)
Description
Gives OS specific service information and metrics
Target
Typical platform: Microsoft Windows
Operating system: Microsoft Windows
Prerequisites
Leverages: WMI
Technology and protocols: WMI
Variables:
serviceNames: Regular expression pattern to identify the services to monitor. (default:.*)
Examples
CLI
metricshub HOSTNAME -t win -c +WindowsService --wmi -u USER
metricshub.yaml
resourceGroups:
<RESOURCE_GROUP>:
resources:
<HOSTNAME-ID>:
attributes:
host.name: <HOSTNAME> # Change with actual host name
host.type: win
connectors: [ +WindowsService ] # Optional, to load only this connector
protocols:
wmi:
username: <USERNAME> # Change with actual credentials
password: <PASSWORD> # Encrypted using metricshub-encrypt
additionalConnectors:
WindowsService: # Unique ID. Use 'uses' if different from the original connector ID
uses: WindowsService # Optional - Original ID if not in key
force: true # Optional (default: true); false for auto-detection only
variables:
serviceNames: <VALUE> # Replace with desired value.
Connector Activation Criteria
The Windows - Services (WMI) connector must be selected manually, and its status will be reported as OK if all the below criteria are met:
- The WMI query below succeeds:
- Namespace:
root\CIMv2 - Query:
SELECT * FROM Win32_OperatingSystem
- Namespace:
Metrics
| Type | Collected Metrics | Specific Attributes |
|---|---|---|
| service | system.service.status{state="Continue Pending|Pause Pending|Paused|Running|Start Pending|Stop Pending|Stopped|Unknown"} | idsystem.service.commandsystem.service.namesystem.service.startsystem.service.username |