From e41868b18b2f7e8ea5133e82bd8c35f1b3d0dbeb Mon Sep 17 00:00:00 2001 From: Andrew Kroh Date: Tue, 28 Mar 2017 11:15:52 -0400 Subject: [PATCH] Add newline to end of windows perfmon config (#3829) * Add newline to end of windows perfmon config This is to fix the docs builds. * Basic edits to perfmon docs Fixed capitalization and formatting --- metricbeat/docs/modules/windows.asciidoc | 7 +++--- metricbeat/metricbeat.full.yml | 1 + metricbeat/metricbeat.yml | 1 + metricbeat/module/windows/_meta/config.yml | 2 +- metricbeat/module/windows/_meta/docs.asciidoc | 4 ++-- .../windows/perfmon/_meta/docs.asciidoc | 22 ++++++++++--------- 6 files changed, 21 insertions(+), 16 deletions(-) diff --git a/metricbeat/docs/modules/windows.asciidoc b/metricbeat/docs/modules/windows.asciidoc index 4d31c2d77d6..11fd35069c2 100644 --- a/metricbeat/docs/modules/windows.asciidoc +++ b/metricbeat/docs/modules/windows.asciidoc @@ -3,9 +3,9 @@ This file is generated! See scripts/docs_collector.py //// [[metricbeat-module-windows]] -== windows Module +== Windows Module -This is the windows Module. +This is the Windows module. [float] @@ -21,7 +21,8 @@ metricbeat.modules: # metricsets: ["perfmon"] # enabled: true # period: 10s -# perfmon.counters:---- +# perfmon.counters: +---- [float] === Metricsets diff --git a/metricbeat/metricbeat.full.yml b/metricbeat/metricbeat.full.yml index 629f0109d31..e3b5256e9cb 100644 --- a/metricbeat/metricbeat.full.yml +++ b/metricbeat/metricbeat.full.yml @@ -321,6 +321,7 @@ metricbeat.modules: # enabled: true # period: 10s # perfmon.counters: + #------------------------------ ZooKeeper Module ----------------------------- #- module: zookeeper #metricsets: ["mntr"] diff --git a/metricbeat/metricbeat.yml b/metricbeat/metricbeat.yml index 93a86d97a95..ca197141ce4 100644 --- a/metricbeat/metricbeat.yml +++ b/metricbeat/metricbeat.yml @@ -54,6 +54,7 @@ metricbeat.modules: # perfmon.counters: + #================================ General ===================================== # The name of the shipper that publishes the network data. It can be used to group diff --git a/metricbeat/module/windows/_meta/config.yml b/metricbeat/module/windows/_meta/config.yml index 65cd605f602..34039190ae4 100644 --- a/metricbeat/module/windows/_meta/config.yml +++ b/metricbeat/module/windows/_meta/config.yml @@ -2,4 +2,4 @@ # metricsets: ["perfmon"] # enabled: true # period: 10s -# perfmon.counters: \ No newline at end of file +# perfmon.counters: diff --git a/metricbeat/module/windows/_meta/docs.asciidoc b/metricbeat/module/windows/_meta/docs.asciidoc index af84197d6eb..1f95a0d2c35 100644 --- a/metricbeat/module/windows/_meta/docs.asciidoc +++ b/metricbeat/module/windows/_meta/docs.asciidoc @@ -1,3 +1,3 @@ -== windows Module +== Windows Module -This is the windows Module. +This is the Windows module. diff --git a/metricbeat/module/windows/perfmon/_meta/docs.asciidoc b/metricbeat/module/windows/perfmon/_meta/docs.asciidoc index 1f1929fc8fb..29b65794354 100644 --- a/metricbeat/module/windows/perfmon/_meta/docs.asciidoc +++ b/metricbeat/module/windows/perfmon/_meta/docs.asciidoc @@ -1,24 +1,26 @@ -=== windows perfmon MetricSet +=== Windows Perfmon MetricSet -This is the perfmon metricset of the module windows. +This is the perfmon metricset of the Windows module. It reads Windows +performance counters. [float] -=== Features and configuration +=== Configuration -Metricset to collect performance counters. -Example configuration: -``` +You must configure queries for the Windows performance counters that you wish +to collect. The example below collects processor time and disk writes. + +[source,yaml] +---- - module: windows metricsets: ["perfmon"] - enabled: true period: 10s perfmon.counters: - - group: "processor" - collectors: + - group: "processor" + collectors: - alias: "processor_time" query: '\Processor Information(_Total)\% Processor Time' - group: "disk" collectors: - alias: "bytes_written" query: '\PhysicalDisk(_Total)\Disk Writes/sec' -``` +----