Categorygithub.com/bbigras/wmi_exporter
modulepackage
0.4.2
Repository: https://github.com/bbigras/wmi_exporter.git
Documentation: pkg.go.dev

# README

WMI exporter

Build status

Prometheus exporter for Windows machines, using the WMI (Windows Management Instrumentation).

Collectors

NameDescriptionEnabled by default
adWin32_PerfRawData_DirectoryServices_DirectoryServices Active Directory
cpuWin32_PerfRawData_PerfOS_Processor metrics (cpu usage)
csWin32_ComputerSystem metrics (system properties, num cpus/total memory)
dnsWin32_PerfRawData_DNS_DNS metrics (DNS Server)
hypervPerformance counters for Hyper-V hosts
iisWin32_PerfRawData_W3SVC_WebService IIS metrics
logical_diskWin32_PerfRawData_PerfDisk_LogicalDisk metrics (disk I/O)
netWin32_PerfRawData_Tcpip_NetworkInterface metrics (network interface I/O)
msmqWin32_PerfRawData_MSMQ_MSMQQueue metrics (MSMQ/journal count)
mssqlvarious SQL Server Performance Objects metrics
osWin32_OperatingSystem metrics (memory, processes, users)
processWin32_PerfRawData_PerfProc_Process metrics (per-process stats)
serviceWin32_Service metrics (service states)
systemWin32_PerfRawData_PerfOS_System metrics (system calls)
tcpWin32_PerfRawData_Tcpip_TCPv4 metrics (tcp connections)
textfileRead prometheus metrics from a text file
vmwarePerformance counters installed by the Vmware Guest agent

The HELP texts shows the WMI data source, please see MSDN documentation for details.

Installation

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:

NameDescription
ENABLED_COLLECTORSAs the --collectors.enabled flag, provide a comma-separated list of enabled collectors
LISTEN_ADDRThe IP address to bind to. Defaults to 0.0.0.0
LISTEN_PORTThe port to bind to. Defaults to 9182.
METRICS_PATHThe path at which to serve metrics. Defaults to /metrics
TEXTFILE_DIRAs the --collector.textfile.directory flag, provide a directory to read text files with metrics from

Parameters are sent to the installer via msiexec. Example invocation:

msiexec /i <path-to-msi-file> ENABLED_COLLECTORS=os,iis LISTEN_PORT=5000

Roadmap

See open issues

Usage

go get -u github.com/golang/dep
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

Examples

Enable only service collector and specify a custom query

.\wmi_exporter.exe --collectors.enabled "service" --collector.service.services-where "Name='wmi_exporter'"

Enable only process collector and specify a custom query

.\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.

License

Under MIT

# Packages

returns data points from Win32_PerfRawData_vmGuestLib_VMem and Win32_PerfRawData_vmGuestLib_VCPU.
No description provided by the author

# Structs

WmiCollector implements the prometheus.Collector interface.