Prometheus exporter for Windows machines, using the WMI (Windows Management Instrumentation).
Name | Description | Enabled by default |
---|---|---|
ad | Active Directory Domain Services | |
adfs | Active Directory Federation Services | |
cpu | CPU usage | ✓ |
cs | "Computer System" metrics (system properties, num cpus/total memory) | ✓ |
container | Container metrics | |
dns | DNS Server | |
hyperv | Hyper-V hosts | |
iis | IIS sites and applications | |
logical_disk | Logical disks, disk I/O | ✓ |
logon | User logon sessions | |
memory | Memory usage metrics | |
msmq | MSMQ queues | |
mssql | SQL Server Performance Objects metrics | |
netframework_clrexceptions | .NET Framework CLR Exceptions | |
netframework_clrinterop | .NET Framework Interop Metrics | |
netframework_clrjit | .NET Framework JIT metrics | |
netframework_clrloading | .NET Framework CLR Loading metrics | |
netframework_clrlocksandthreads | .NET Framework locks and metrics threads | |
netframework_clrmemory | .NET Framework Memory metrics | |
netframework_clrremoting | .NET Framework Remoting metrics | |
netframework_clrsecurity | .NET Framework Security Check metrics | |
net | Network interface I/O | ✓ |
os | OS metrics (memory, processes, users) | ✓ |
process | Per-process metrics | |
service | Service state metrics | ✓ |
system | System calls | ✓ |
tcp | TCP connections | |
thermalzone | Thermal information | |
textfile | Read prometheus metrics from a text file | ✓ |
vmware | Performance counters installed by the Vmware Guest agent |
See the linked documentation on each collector for more information on reported metrics, configuration settings and usage examples.
The latest release can be downloaded from the releases page.
Each release provides a .msi installer. The installer will setup the WMI Exporter as a Windows service, as well as create an exception in the Windows Firewall.
If the installer is run without any parameters, the exporter will run with default settings for enabled collectors, ports, etc. The following parameters are available:
Name | Description |
---|---|
ENABLED_COLLECTORS |
As the --collectors.enabled flag, provide a comma-separated list of enabled collectors |
LISTEN_ADDR |
The IP address to bind to. Defaults to 0.0.0.0 |
LISTEN_PORT |
The port to bind to. Defaults to 9182. |
METRICS_PATH |
The path at which to serve metrics. Defaults to /metrics |
TEXTFILE_DIR |
As the --collector.textfile.directory flag, provide a directory to read text files with metrics from |
EXTRA_FLAGS |
Allows passing full CLI flags. Defaults to an empty string. |
Parameters are sent to the installer via msiexec
. Example invocations:
msiexec /i <path-to-msi-file> ENABLED_COLLECTORS=os,iis LISTEN_PORT=5000
Example service collector with a custom query.
msiexec /i <path-to-msi-file> ENABLED_COLLECTORS=os,service --% EXTRA_FLAGS="--collector.service.services-where ""Name LIKE 'sql%'"""
On some older versions of Windows you may need to surround parameter values with double quotes to get the install command parsing properly:
msiexec /i C:\Users\Administrator\Downloads\wmi_exporter.msi ENABLED_COLLECTORS="ad,iis,logon,memory,process,tcp,thermalzone" TEXTFILE_DIR="C:\custom_metrics\"
See open issues
go get -u github.com/prometheus/promu
go get -u github.com/martinlindhe/wmi_exporter
cd $env:GOPATH/src/github.com/martinlindhe/wmi_exporter
promu build -v .
.\wmi_exporter.exe
The prometheus metrics will be exposed on localhost:9182
docker pull golang:1.13
mkdir $HOME/go
docker run --rm -ti --privileged -v $HOME/go:/go docker.io/golang:1.13 /bin/bash -c 'git clone https://github.com/bw2017/wmi_exporter.git; cd wmi_exporter; /bin/bash ./compiler-using-docker-on-linux.sh'
## Run the following command in the CMD window of Win10/Win7/...
git clone https://github.com/bw2017/wmi_exporter.git
cd wmi_exporter\installer
powershell .\build.ps1 ..\wmi_exporter.exe 1.0
## wmi_exporter-1.0-amd64.msi will appear in the "Output" folder
.\wmi_exporter.exe --collectors.enabled "service" --collector.service.services-where "Name='wmi_exporter'"
.\wmi_exporter.exe --collectors.enabled "process" --collector.process.processes-where "Name LIKE 'firefox%'"
When there are multiple processes with the same name, WMI represents those after the first instance as process-name#index
. So to get them all, rather than just the first one, the query needs to be a wildcard search using a %
character.
Please note that in Windows batch scripts (and when using the cmd
command prompt), the %
character is reserved, so it has to be escaped with another %
. For example, the wildcard syntax for searching for all firefox processes is firefox%%
.
Under MIT