Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Reference

Components

prometheus

prometheus.exporter.windows

General availability (GA) Open source

`prometheus.exporter.windows`

The prometheus.exporter.windows component embeds the windows_exporter which exposes a wide variety of hardware and OS metrics for Windows-based systems.

The windows_exporter itself comprises various collectors, which you can enable and disable as needed. For more information on collectors, refer to the collectors-list section.

Note
The blacklist and whitelist configuration arguments are available for backwards compatibility but are deprecated. The include and exclude arguments are preferred going forward.

Usage

prometheus.exporter.windows "<LABEL>" {
}

Arguments

You can use the following arguments with prometheus.exporter.windows:

Name	Type	Description	Default	Required
`enabled_collectors`	`list(string)`	List of collectors to enable.	`["cpu","cs","logical_disk","net","os","service","system"]`	no

enabled_collectors defines a hand-picked list of enabled-by-default collectors. If set, anything not provided in that list is disabled by default. Refer to the Collectors list for the default set.

Blocks

You can use the following blocks with prometheus.exporter.windows:

Name	Description	Required
`dfsr`	Configures the `dfsr` collector.	no
`dns`	Configures the `dns` collector.	no
`exchange`	Configures the `exchange` collector.	no
`filetime`	Configures the `filetime` collector.	no
`iis`	Configures the `iis` collector.	no
`logical_disk`	Configures the `logical_disk` collector.	no
`mscluster`	Configures the `mscluster` collector.	no
`mssql`	Configures the `mssql` collector.	no
`netframework`	Configures the `netframework` collector.	no
`network`	Configures the `network` collector.	no
`performancecounter`	Configures the `performancecounter` collector.	no
`physical_disk`	Configures the `physical_disk` collector.	no
`printer`	Configures the `printer` collector.	no
`process`	Configures the `process` collector.	no
`scheduled_task`	Configures the `scheduled_task` collector.	no
`service`	Configures the `service` collector.	no
`smb_client`	Configures the `smb_client` collector.	no
`smb`	Configures the `smb` collector.	no
`smtp`	Configures the `smtp` collector.	no
`tcp`	Configures the `tcp` collector.	no
`text_file`	Configures the `textfile` collector.	no
`update`	Configures the `update` collector.	no

The textfile collector is currently configured with the text_file block. To be consistent with the textfile collector name, the text_file block will be deprecated in a future release and replaced with a textfile block.

Note
Starting with release 1.9.0, the msmq block is deprecated. It will be removed in a future release. You can still include this block in your configuration files. However, its usage is now a no-op.

`dfsr`

Name	Type	Description	Default	Required
`source_enabled`	`list(string)`	A list of DFSR Perflib sources to use.	`["connection","folder","volume"]`	no

`dns`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	A list of collectors to use.	`["metrics", "wmi_stats"]`	no

`exchange`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	A list of collectors to use.	`["ADAccessProcesses", "TransportQueues", "HttpProxy", "ActiveSync", "AvailabilityService", "OutlookWebAccess", "Autodiscover", "WorkloadManagement", "RpcClientAccess", "MapiHttpEmsmdb"]`	no

`filetime`

Name	Type	Description	Default	Required
`file_patterns`	`list(string)`	A list of glob patterns matching files to be monitored.	`[]`	no

`iis`

Name	Type	Description	Default	Required
`app_exclude`	`string`	Regular expression of applications to ignore.	`"^$"`	no
`app_include`	`string`	Regular expression of applications to report on.	`"^.+$"`	no
`site_exclude`	`string`	Regular expression of sites to ignore.	`"^$"`	no
`site_include`	`string`	Regular expression of sites to report on.	`"^.+$"`	no

User-supplied app_exclude, app_include, site_exclude and site_include strings are wrapped in a regular expression.

`logical_disk`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of volumes to exclude.	`"^$"`	no
`include`	`string`	Regular expression of volumes to include.	`"^.+$"`	no

Volume names must match the regular expression specified by include and must not match the regular expression specified by exclude to be included.

User-supplied exclude and include strings are wrapped in a regular expression.

`mscluster`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	A list of collectors to use.	`["cluster","network","node","resource","resourcegroup"]`	no

The collectors specified by enabled_list can include the following:

cluster
network
node
resource
resouregroup

For example, you can set enabled_list to ["cluster"].

`mssql`

Name	Type	Description	Default	Required
`enabled_classes`	`list(string)`	A list of MSSQL WMI classes to use.	`["accessmethods", "availreplica", "bufman", "databases", "dbreplica", "genstats", "info", "locks", "memmgr", "sqlerrors", "sqlstats", "transactions", "waitstats"]`	no

`network`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of NICs to exclude.	`"^$"`	no
`include`	`string`	Regular expression of NICs to include.	`"^.+$"`	no

NIC names must match the regular expression specified by include and must not match the regular expression specified by exclude to be included.

User-supplied exclude and include strings are wrapped in a regular expression.

`netframework`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	A list of collectors to use.	`["clrexceptions","clrinterop","clrjit","clrloading","clrlocksandthreads","clrmemory","clrremoting","clrsecurity"]`	no

The collectors specified by enabled_list can include the following:

clrexceptions
clrinterop
clrjit
clrloading
clrlocksandthreads
clrmemory
clrremoting
clrsecurity

For example, you can set enabled_list to ["clrjit"].

`performancecounter`

Name	Type	Description	Default	Required
`objects`	`string`	YAML string representing the counters to monitor.	`""`	no

The objects field should contain a YAML file as a string that satisfies the schema shown in the exporter’s documentation for the performancecounter collector. While there are ways to construct this directly in Alloy syntax using raw Alloy syntax strings for example, the best way to configure this collector will be using a local.file component.

local.file "counters" {
  filename = "/etc/alloy/performance_counters.yaml"
}

prometheus.exporter.windows "default" {
  ...

  performancecounter {
    objects = local.file.counters.content
  }
  
  ...
}

The performance_counters.yaml file should be a YAML file that represents an array of objects matching the schema in the documentation, like the example below.

- name: memory
  object: "Memory"
  counters:
    - name: "Cache Faults/sec"
      type: "counter" # optional

`physical_disk`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of physical disk to exclude.	`"^$"`	no
`include`	`string`	Regular expression of physical disk to include.	`"^.+$"`	no

User-supplied exclude and include strings are wrapped in a regular expression.

`printer`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of printer to exclude.	`"^$"`	no
`include`	`string`	Regular expression of printer to include.	`"^.+$"`	no

Printer must match the regular expression specified by include and must not match the regular expression specified by exclude to be included.

User-supplied exclude and include strings are wrapped in a regular expression.

`process`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of processes to exclude.	`"^$"`	no
`include`	`string`	Regular expression of processes to include.	`"^.+$"`	no
`enable_iis_worker_process`	`string`	Enable IIS collectWorker process name queries	`false`	no

Processes must match the regular expression specified by include and must not match the regular expression specified by exclude to be included.

User-supplied exclude and include strings are wrapped in a regular expression.

There is a warning in the upstream collector that use of enable_iis_worker_process may leak memory. Use with caution.

`scheduled_task`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of tasks to exclude.	`"^$"`	no
`include`	`string`	Regular expression of tasks to include.	`"^.+$"`	no

For a task to be included, it must match the regular expression specified by include and must not match the regular expression specified by exclude.

User-supplied exclude and include strings are wrapped in a regular expression.

`service`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of services to exclude.	`"^$"`	no
`include`	`string`	Regular expression of services to include.	`"^.+$"`	no

For a service to be included, it must match the regular expression specified by include and must not match the regular expression specified by exclude.

User-supplied exclude and include strings are wrapped in a regular expression.

Note
Starting with release 1.9.0, the use_api, where_clause, and enable_v2_collector attributes are deprecated. They will be removed in a future release. You can still include these attributes in your configuration files. However, their usage is now a no-op.

`smb`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	Deprecated (no-op), a list of collectors to use.	`[]`	no

The collectors specified by enabled_list can include the following:

ServerShares

For example, enabled_list may be set to ["ServerShares"].

`smb_client`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	Deprecated (no-op), a list of collectors to use.	`[]`	no

The collectors specified by enabled_list can include the following:

ClientShares

For example, enabled_list may be set to ["ClientShares"].

`smtp`

Name	Type	Description	Default	Required
`exclude`	`string`	Regular expression of virtual servers to ignore.	`"^$"`	no
`include`	`string`	Regular expression of virtual servers to include.	`"^.+$"`	no

For a server name to be included, it must match the regular expression specified by include and must not match the regular expression specified by exclude.

User-supplied exclude and include strings are wrapped in a regular expression.

`tcp`

Name	Type	Description	Default	Required
`enabled_list`	`list(string)`	A list of collectors to use.	`["metrics","connections_state"]`	no

The collectors specified by enabled_list can include the following:

connections_state
metrics

For example, you can set enabled_list to ["metrics"].

`text_file`

Name	Type	Description	Default	Required
`text_file_directory`	`string`	The directory containing the files to be ingested.	see below	no

The default value for text_file_directory is relative to the location of the Alloy executable. By default, text_file_directory is set to the textfile_inputs directory in the installation directory of Alloy. For example, if Alloy is installed in C:\Program Files\GrafanaLabs\Alloy\, the default is C:\Program Files\GrafanaLabs\Alloy\textfile_inputs.

When text_file_directory is set, only files with the extension .prom inside the specified directory are read.

Note
The .prom files must end with an empty line feed for the component to recognize and read them.

`update`

Name	Type	Description	Default	Required
`online`	`bool`	Whether to search for updates online.	`false`	no
`scrape_interval`	`duration`	How frequently to scrape Windows Update information.	`6h`	no

Exported fields

The following fields are exported and can be referenced by other components.

Name	Type	Description
`targets`	`list(map(string))`	The targets that can be used to collect exporter metrics.

For example, the targets can either be passed to a discovery.relabel component to rewrite the targets’ label sets or to a prometheus.scrape component that collects the exposed metrics.

The exported targets use the configured in-memory traffic address specified by the run command.

Component health

prometheus.exporter.windows is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.exporter.windows doesn’t expose any component-specific debug information.

Debug metrics

prometheus.exporter.windows doesn’t expose any component-specific debug metrics.

Wrap regular expression strings

Some collector blocks such as scheduled_task accept a regular expression as a string argument. prometheus.exporter.windows prefixes some regular expression string arguments with ^(?: and suffixes them with )$. For example, if a user sets an exclude argument to ".*", Alloy sets it to "^(?:.*)$".

To find out if a particular regular expression argument will be wrapped, refer to the collector block documentation.

Note
The wrapping may change the behaviour of your regular expression. For example, the e.* regular expression would normally match both the “service” and “email” strings. However, ^(?:e.*)$ would only match “email”.

Collectors list

The following table lists the available collectors in windows_exporter. Some collectors only work on specific operating systems, enabling a collector that’s not supported by the host OS where Alloy is running is a no-op.

Users can choose to enable a subset of collectors to limit the amount of metrics exposed by the prometheus.exporter.windows component, or disable collectors that are expensive to run.

Name	Description	Enabled by default
`ad`	Active Directory Domain Services
`adcs`	Active Directory Certificate Services
`adfs`	Active Directory Federation Services
`cache`	Cache metrics
`cpu`	CPU usage	Yes
`cpu_info`	CPU Information
`cs`	“Computer System” metrics (system properties, num cpus/total memory)	Yes
`container`	Container metrics
`dfsr`	DFSR metrics
`dhcp`	DHCP Server
`dns`	DNS Server
`exchange`	Exchange metrics
`filetime`	File modification time 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	Yes
`logon`	User logon sessions
`memory`	Memory usage metrics
`mscluster`	MSCluster metrics
`msmq`	MSMQ queues
`mssql`	SQL Server Performance Objects metrics
`netframework`	.NET Framework metrics
`net`	Network interface I/O	Yes
`os`	OS metrics (memory, processes, users)	Yes
`pagefile`	Pagefile metrics
`performancecounter`	Performance Counter metrics
`physical_disk`	Physical disks	Yes
`printer`	Printer metrics
`process`	Per-process metrics
`remote_fx`	RemoteFX protocol (RDP) metrics
`scheduled_task`	Scheduled Tasks metrics
`service`	Service state metrics	Yes
`smb`	IIS SMTP Server
`smb_client`	IIS SMTP Server
`smtp`	IIS SMTP Server
`system`	System calls	Yes
`tcp`	TCP connections
`time`	Windows Time Service
`thermalzone`	Thermal information
`terminal_services`	Terminal services (RDS)
`textfile`	Read Prometheus metrics from a text file
`udp`	UDP connections
`update`	Windows Update service metrics
`vmware`	Performance counters installed by the VMware Guest agent

Refer to the linked documentation on each collector for more information on reported metrics, configuration settings and usage examples.

Caution
Certain collectors cause Alloy to crash if those collectors are used and the required infrastructure isn’t installed. These include but aren’t limited to mscluster, vmware, nps, dns, msmq, ad, hyperv, and scheduled_task.
The cs collector has been deprecated and may be removed in future versions of the exporter.

Example

The following example uses a prometheus.scrape component to collect metrics from prometheus.exporter.windows:

prometheus.exporter.windows "default" { }

// Configure a prometheus.scrape component to collect windows metrics.
prometheus.scrape "example" {
  targets    = prometheus.exporter.windows.default.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = "<PROMETHEUS_REMOTE_WRITE_URL>"

    basic_auth {
      username = "<USERNAME>"
      password = "<PASSWORD>"
    }
  }
}

Replace the following:

<PROMETHEUS_REMOTE_WRITE_URL>: The URL of the Prometheus remote_write compatible server to send metrics to.
<USERNAME>: The username to use for authentication to the remote_write API.
<PASSWORD>: The password to use for authentication to the remote_write API.

Compatible components

prometheus.exporter.windows has exports that can be consumed by the following components:

Components that consume Targets

Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.

Was this page helpful?

Create a GitHub issue

Email docs@grafana.com

Help and support

Community

prometheus.exporter.windows

Usage

Arguments

Blocks

dfsr

dns

exchange

filetime

iis

logical_disk

mscluster

mssql

network

netframework

performancecounter

physical_disk

printer

process

scheduled_task

service

smb

smb_client

smtp

tcp

text_file

update

Exported fields

Component health

Debug information

Debug metrics

Wrap regular expression strings

Collectors list

Example

Compatible components

Was this page helpful?

Related resources from Grafana Labs

`prometheus.exporter.windows`

`dfsr`

`dns`

`exchange`

`filetime`

`iis`

`logical_disk`

`mscluster`

`mssql`

`network`

`netframework`

`performancecounter`

`physical_disk`

`printer`

`process`

`scheduled_task`

`service`

`smb`

`smb_client`

`smtp`

`tcp`

`text_file`

`update`