A Prometheus exporter for Windows machines.
| 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 | |
| dhcp | DHCP Server | |
| dns | DNS Server | |
| exchange | Exchange metrics | |
| fsrmquota | Microsoft File Server Resource Manager (FSRM) Quotas collector | |
| 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 | |
| remote_fx | RemoteFX protocol (RDP) metrics | |
| service | Service state metrics | ✓ |
| system | System calls | ✓ |
| tcp | TCP connections | |
| thermalzone | Thermal information | |
| terminal_services | Terminal services (RDS) | |
| 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.
windows_exporter accepts flags to configure certain behaviours. The ones configuring the global behaviour of the exporter are listed below, while collector-specific ones are documented in the respective collector documentation above.
| Flag | Description | Default value |
|---|---|---|
--telemetry.addr |
host:port for exporter. | :9182 |
--telemetry.path |
URL path for surfacing collected metrics. | /metrics |
--telemetry.max-requests |
Maximum number of concurrent requests. 0 to disable. | 5 |
--collectors.enabled |
Comma-separated list of collectors to use. Use [defaults] as a placeholder for all the collectors enabled by default." |
[defaults] |
--collectors.print |
If true, print available collectors and exit. | |
--scrape.timeout-margin |
Seconds to subtract from the timeout allowed by the client. Tune to allow for overhead or high loads. | 0.5 |
The latest release can be downloaded from the releases page.
Each release provides a .msi installer. The installer will setup the windows_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 |
REMOTE_ADDR |
Allows setting comma separated remote IP addresses for the Windows Firewall exception (whitelist). Defaults to an empty string (any remote address). |
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=5000Example 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\windows_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/prometheus-community/windows_exporter
cd $env:GOPATH/src/github.com/prometheus-community/windows_exporter
promu build -v
.\windows_exporter.exe
The prometheus metrics will be exposed on localhost:9182
.\windows_exporter.exe --collectors.enabled "service" --collector.service.services-where "Name='windows_exporter'"
.\windows_exporter.exe --collectors.enabled "process" --collector.process.whitelist="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 regular expression must use .+. See process for more information.
Under MIT