README.md

    windows_exporter

    Build status

    A Prometheus exporter for Windows machines.

    Collectors

    Name Description Enabled by default
    ad Active Directory Domain Services
    adfs Active Directory Federation Services
    cache Cache metrics
    cpu CPU usage
    cpu_info CPU Information
    cs "Computer System" metrics (system properties, num cpus/total memory)
    container Container metrics
    dfsr DFSR 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
    smtp IIS SMTP Server
    system System calls
    tcp TCP connections
    time Windows Time Service
    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.

    Filtering enabled collectors

    The windows_exporter will expose all metrics from enabled collectors by default. This is the recommended way to collect metrics to avoid errors when comparing metrics of different families.

    For advanced use the windows_exporter can be passed an optional list of collectors to filter metrics. The collect[] parameter may be used multiple times. In Prometheus configuration you can use this syntax under the scrape config.

      params:
        collect[]:
          - foo
          - bar

    This can be useful for having different Prometheus servers collect specific metrics from nodes.

    Flags

    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 which gets expanded containing 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
    --web.config.file A web config for setting up TLS and Auth None

    Installation

    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=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\windows_exporter.msi ENABLED_COLLECTORS="ad,iis,logon,memory,process,tcp,thermalzone" TEXTFILE_DIR="C:\custom_metrics\"

    Supported versions

    windows_exporter supports Windows Server versions 2008R2 and later, and desktop Windows version 7 and later.

    Usage

    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

    Examples

    Enable only service collector and specify a custom query

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

    Enable only process collector and specify a custom query

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

    Using [defaults] with --collectors.enabled argument

    Using [defaults] with --collectors.enabled argument which gets expanded with all default collectors.

    .\windows_exporter.exe --collectors.enabled "[defaults],process,container"

    This enables the additional process and container collectors on top of the defaults.

    Using a configuration file

    YAML configuration files can be specified with the --config.file flag. E.G. .\windows_exporter.exe --config.file=config.yml

    collectors:
      enabled: cpu,cs,net,service
    collector:
      service:
        services-where: "Name='windows_exporter'"
    log:
      level: warn

    An example configuration file can be found here.

    Configuration file notes

    Configuration file values can be mixed with CLI flags. E.G.

    .\windows_exporter.exe --collectors.enabled=cpu,logon

    log:
      level: debug

    CLI flags enjoy a higher priority over values specified in the configuration file.

    License

    Under MIT

    项目简介

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/martinlindhe/wmi_exporter

    发行版本 46

    v0.16.0

    全部发行版

    贡献者 89

    全部贡献者

    开发语言

    • Go 98.2 %
    • HTML 0.9 %
    • PowerShell 0.7 %
    • Makefile 0.1 %