Update and reorganize system module config docs (elastic#4909)

Move configuration options from module page to their respective metricset pages.

- Add `process.include_cpu_ticks` to reference config file (it was missing).
- Rename Darwin to macOS in list of supported operating systems.
- Add docs for `core.metrics` and `cpu.metrics`.

metricbeat/docs/modules/system.asciidoc

@@ -5,67 +5,8 @@ This file is generated! See scripts/docs_collector.py
 [[metricbeat-module-system]]
 == System module
 
-The System module allows you to monitor your servers. Because the System module always applies to the local
-server, the `hosts` config option is not needed.
-
-[float]
-=== Module-specific configuration notes
-
-The System module has these additional config options:
-
-*`processes`*:: When the `process` metricset is enabled, you can use the `processes` option to define a list of
-regexp expressions to filter the processes that are reported. For more complex filtering, you should use the `processors` configuration option. See <<filtering-and-enhancing-data>> for more information.
-+
-The following example config returns metrics for all processes:
-+
-[source,yaml]
-----
-metricbeat.modules:
-- module: system
-  metricsets: ["process"]
-  processes: ['.*']
-----
-
-*`process.include_top_n`*:: These options allow you to filter out all processes
-that are not in the top N by CPU or memory, in order to reduce the number of
-documents created. If both the `by_cpu` and `by_memory` options are used, the
-union of the two sets is included.
-
-*`process.include_top_n.enabled`*:: Set to false to disable the top N feature and
-include all processes, regardless of the other options. The default is `true`,
-but nothing is filtered unless one of the other options (`by_cpu` or `by_memory`)
-is set to a non-zero value.
-
-*`process.include_top_n.by_cpu`*::  How many processes to include from the top
-by CPU. The processes are sorted by the `system.process.cpu.total.pct` field.
-The default is 0.
-
-*`process.include_top_n.by_memory`*:: How many processes to include from the top
-by memory. The processes are sorted by the `system.process.memory.rss.bytes`
-field. The default is 0.
-
-*`process.cgroups.enabled`*:: When the `process` metricset is enabled, you can
-use this boolean configuration option to disable cgroup metrics. By default
-cgroup metrics collection is enabled.
-+
-The following example config disables cgroup metrics on Linux.
-+
-[source,yaml]
-----
-metricbeat.modules:
-- module: system
-  metricsets: ["process"]
-  process.cgroups.enabled: false
-----
-*`cpu_ticks`*:: When the `cpu` or `core` metricset is enabled, you can specify `cpu_ticks: true` to report CPU ticks in addition to CPU percentages stats. For example:
-+
-[source,yaml]
-----
-metricbeat.modules:
-- module: system
-  metricsets: ["cpu", "core"]
-  cpu_ticks: true
-----
+The System module allows you to monitor your servers. Because the System module
+always applies to the local server, the `hosts` config option is not needed.
 
 [float]
 === Dashboard

metricbeat/metricbeat.reference.yml

@@ -79,6 +79,10 @@ metricbeat.modules:
   # reported with the process metricset's events. Defaults to empty.
   #process.env.whitelist: []
 
+  # Include the cumulative CPU tick values with the process metrics. Defaults
+  # to false.
+  #process.include_cpu_ticks: false
+
   # Configure reverse DNS lookup on remote IP addresses in the socket metricset.
   #socket.reverse_lookup.enabled: false
   #socket.reverse_lookup.success_ttl: 60s

metricbeat/module/system/_meta/config.reference.yml

@@ -47,6 +47,10 @@
   # reported with the process metricset's events. Defaults to empty.
   #process.env.whitelist: []
 
+  # Include the cumulative CPU tick values with the process metrics. Defaults
+  # to false.
+  #process.include_cpu_ticks: false
+
   # Configure reverse DNS lookup on remote IP addresses in the socket metricset.
   #socket.reverse_lookup.enabled: false
   #socket.reverse_lookup.success_ttl: 60s

metricbeat/module/system/_meta/docs.asciidoc

@@ -1,66 +1,7 @@
 == System module
 
-The System module allows you to monitor your servers. Because the System module always applies to the local
-server, the `hosts` config option is not needed.
-
-[float]
-=== Module-specific configuration notes
-
-The System module has these additional config options:
-
-*`processes`*:: When the `process` metricset is enabled, you can use the `processes` option to define a list of
-regexp expressions to filter the processes that are reported. For more complex filtering, you should use the `processors` configuration option. See <<filtering-and-enhancing-data>> for more information.
-+
-The following example config returns metrics for all processes:
-+
-[source,yaml]
-----
-metricbeat.modules:
-- module: system
-  metricsets: ["process"]
-  processes: ['.*']
-----
-
-*`process.include_top_n`*:: These options allow you to filter out all processes
-that are not in the top N by CPU or memory, in order to reduce the number of
-documents created. If both the `by_cpu` and `by_memory` options are used, the
-union of the two sets is included.
-
-*`process.include_top_n.enabled`*:: Set to false to disable the top N feature and
-include all processes, regardless of the other options. The default is `true`,
-but nothing is filtered unless one of the other options (`by_cpu` or `by_memory`)
-is set to a non-zero value.
-
-*`process.include_top_n.by_cpu`*::  How many processes to include from the top
-by CPU. The processes are sorted by the `system.process.cpu.total.pct` field.
-The default is 0.
-
-*`process.include_top_n.by_memory`*:: How many processes to include from the top
-by memory. The processes are sorted by the `system.process.memory.rss.bytes`
-field. The default is 0.
-
-*`process.cgroups.enabled`*:: When the `process` metricset is enabled, you can
-use this boolean configuration option to disable cgroup metrics. By default
-cgroup metrics collection is enabled.
-+
-The following example config disables cgroup metrics on Linux.
-+
-[source,yaml]
-----
-metricbeat.modules:
-- module: system
-  metricsets: ["process"]
-  process.cgroups.enabled: false
-----
-*`cpu_ticks`*:: When the `cpu` or `core` metricset is enabled, you can specify `cpu_ticks: true` to report CPU ticks in addition to CPU percentages stats. For example:
-+
-[source,yaml]
-----
-metricbeat.modules:
-- module: system
-  metricsets: ["cpu", "core"]
-  cpu_ticks: true
-----
+The System module allows you to monitor your servers. Because the System module
+always applies to the local server, the `hosts` config option is not needed.
 
 [float]
 === Dashboard

metricbeat/module/system/core/_meta/docs.asciidoc

@@ -1,11 +1,26 @@
 === System core metricset
 
-The System `core` metricset provides load statistics for each CPU core.
+The System `core` metricset provides usage statistics for each CPU core.
 
 This metricset is available on:
 
-- Darwin
 - FreeBSD
 - Linux
+- macOS
 - OpenBSD
 - Windows
+
+[float]
+=== Configuration
+
+*`core.metrics`*:: This option controls what metrics are reported for each CPU
+core. The value is a list and two metric types are supported - `percentages` and
+`ticks`. The default value is `core.metrics: [percentages]`.
++
+[source,yaml]
+----
+metricbeat.modules:
+- module: system
+  metricsets: [core]
+  core.metrics: [percentages, ticks]
+----

metricbeat/module/system/cpu/_meta/docs.asciidoc

@@ -4,8 +4,24 @@ The System `cpu` metricset provides CPU statistics.
 
 This metricset is available on:
 
-- Darwin
 - FreeBSD
 - Linux
+- macOS
 - OpenBSD
 - Windows
+
+[float]
+=== Configuration
+
+*`cpu.metrics`*:: This option controls what CPU metrics are reported. The value
+is a list and three metric types are supported - `percentages`,
+`normalized_percentages`, and `ticks`. The default value is
+`cpu.metrics: [percentages]`.
++
+[source,yaml]
+----
+metricbeat.modules:
+- module: system
+  metricsets: [core]
+  core.metrics: [percentages, normalized_percentages, ticks]
+----

metricbeat/module/system/diskio/_meta/docs.asciidoc

@@ -1,11 +1,16 @@
 === System diskio metricset
 
-The System `diskio` metricset provides disk IO metrics collected from the operating
-system. One event is created for each disk mounted on the system.
+The System `diskio` metricset provides disk IO metrics collected from the
+operating system. One event is created for each disk mounted on the system.
 
 This metricset is available on:
 
-- macOS (requires 10.10+)
 - Linux
+- macOS (requires 10.10+)
 - Windows
 - FreeBSD (amd64)
+
+[float]
+=== Configuration
+
+There are no configuration options for this metricset.

metricbeat/module/system/filesystem/_meta/docs.asciidoc

@@ -5,9 +5,9 @@ system, one document is provided.
 
 This metricset is available on:
 
-- Darwin
 - FreeBSD
 - Linux
+- macOS
 - OpenBSD
 - Windows
 

metricbeat/module/system/fsstat/_meta/docs.asciidoc

@@ -4,8 +4,8 @@ The System `fsstat` metricset provides overall file system statistics.
 
 This metricset is available on:
 
-- Darwin
 - FreeBSD
 - Linux
+- macOS
 - OpenBSD
 - Windows

metricbeat/module/system/load/_meta/docs.asciidoc

@@ -4,7 +4,12 @@ The System `load` metricset provides load statistics.
 
 This metricset is available on:
 
- - Darwin
- - FreeBSD
- - Linux
- - OpenBSD
+- FreeBSD
+- Linux
+- macOS
+- OpenBSD
+
+[float]
+=== Configuration
+
+There are no configuration options for this metricset.

metricbeat/module/system/memory/_meta/docs.asciidoc

@@ -4,8 +4,13 @@ The System `memory` metricset provides memory statistics.
 
 This metricset is available on:
 
-- Darwin
 - FreeBSD
 - Linux
+- macOS
 - OpenBSD
 - Windows
+
+[float]
+=== Configuration
+
+There are no configuration options for this metricset.

metricbeat/module/system/network/_meta/docs.asciidoc

@@ -3,9 +3,20 @@
 The System `network` metricset provides network IO metrics collected from the
 operating system. One event is created for each network interface.
 
-By default metrics are reported from all network interfaces. To select which
-interfaces metrics are reported from, use the `interfaces` configuration
-option. The value must be an array of interface names. For example:
+This metricset is available on:
+
+- FreeBSD
+- Linux
+- macOS
+- Windows
+
+[float]
+=== Configuration
+
+*`interfaces`*:: By default metrics are reported from all network interfaces.
+To select which interfaces metrics are reported from, use the `interfaces`
+configuration option. The value must be an array of interface names. For
+example:
 
 [source,yaml]
 ----------------------------
@@ -15,9 +26,3 @@ metricbeat.modules:
   interfaces: [eth0]
 ----------------------------
 
-This metricset is available on:
-
-- Darwin
-- Linux
-- Windows
-- FreeBSD