////
This file is generated! See scripts/mage/docs_collector.go
////

:modulename: windows

[[metricbeat-module-windows]]
== Windows module

include::{libbeat-dir}/shared/integration-link.asciidoc[]

:modulename!:

This is the `windows` module which collects metrics from Windows systems.
The module contains the `service` metricset, which is set up by default when the `windows` module is enabled.
The `service` metricset will retrieve status information of the services on the Windows machines. The second `windows`
metricset is `perfmon` which collects Windows performance counter values.





[float]
=== Example configuration

The Windows module supports the standard configuration options that are described
in <<configuration-metricbeat>>. Here is an example configuration:

[source,yaml]
----
metricbeat.modules:
- module: windows
  metricsets: ["perfmon"]
  enabled: true
  period: 10s
  perfmon.ignore_non_existent_counters: false
  perfmon.group_measurements_by_instance: false
  perfmon.queries:
#  - object: 'Process'
#    instance: ["*"]
#    counters:
#    - name: '% Processor Time'
#      field: cpu_usage
#      format: "float"
#    - name: "Thread Count"

- module: windows
  metricsets: ["service"]
  enabled: true
  period: 60s
----

[float]
=== Metricsets

The following metricsets are available:

* <<metricbeat-metricset-windows-perfmon,perfmon>>

* <<metricbeat-metricset-windows-service,service>>

include::windows/perfmon.asciidoc[]

include::windows/service.asciidoc[]

