From aec0f9c18415cdfabc1a10e763dac39d59fa82aa Mon Sep 17 00:00:00 2001 From: Nicolas Ruflin Date: Mon, 23 Jul 2018 15:46:33 +0200 Subject: [PATCH] Fix duplicated module headers (#7650) * Fix duplicated module headers Closes https://github.com/elastic/beats/issues/7643 * fix metricset titles for munin and kvm * fix imssing kubernetes apiserver metricset doc * remove headers from modules / metricset generator and clean up traefik title --- metricbeat/docs/modules/kubernetes.asciidoc | 4 ++++ .../docs/modules/kubernetes/apiserver.asciidoc | 17 +++++++++++++++++ metricbeat/docs/modules/kvm.asciidoc | 2 -- metricbeat/docs/modules/munin.asciidoc | 2 -- metricbeat/docs/modules/uwsgi.asciidoc | 2 -- metricbeat/docs/modules_list.asciidoc | 3 ++- .../kubernetes/apiserver/_meta/docs.asciidoc | 1 + metricbeat/module/kvm/_meta/docs.asciidoc | 2 -- .../module/kvm/dommemstat/_meta/docs.asciidoc | 2 -- metricbeat/module/munin/_meta/docs.asciidoc | 2 -- .../module/munin/node/_meta/docs.asciidoc | 2 -- metricbeat/module/uwsgi/_meta/docs.asciidoc | 2 -- metricbeat/scripts/module/docs.asciidoc | 2 -- .../scripts/module/metricset/docs.asciidoc | 2 -- 14 files changed, 24 insertions(+), 21 deletions(-) create mode 100644 metricbeat/docs/modules/kubernetes/apiserver.asciidoc create mode 100644 metricbeat/module/kubernetes/apiserver/_meta/docs.asciidoc diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc index de0c5508608a..98817322dd01 100644 --- a/metricbeat/docs/modules/kubernetes.asciidoc +++ b/metricbeat/docs/modules/kubernetes.asciidoc @@ -68,6 +68,8 @@ This module supports TLS connection when using `ssl` config field, as described The following metricsets are available: +* <> + * <> * <> @@ -92,6 +94,8 @@ The following metricsets are available: * <> +include::kubernetes/apiserver.asciidoc[] + include::kubernetes/container.asciidoc[] include::kubernetes/event.asciidoc[] diff --git a/metricbeat/docs/modules/kubernetes/apiserver.asciidoc b/metricbeat/docs/modules/kubernetes/apiserver.asciidoc new file mode 100644 index 000000000000..f32fa961bdd9 --- /dev/null +++ b/metricbeat/docs/modules/kubernetes/apiserver.asciidoc @@ -0,0 +1,17 @@ +//// +This file is generated! See scripts/docs_collector.py +//// + +[[metricbeat-metricset-kubernetes-apiserver]] +=== Kubernetes apiserver metricset + +beta[] + +include::../../../module/kubernetes/apiserver/_meta/docs.asciidoc[] + + +==== Fields + +For a description of each field in the metricset, see the +<> section. + diff --git a/metricbeat/docs/modules/kvm.asciidoc b/metricbeat/docs/modules/kvm.asciidoc index 9230de760804..c551560643df 100644 --- a/metricbeat/docs/modules/kvm.asciidoc +++ b/metricbeat/docs/modules/kvm.asciidoc @@ -7,8 +7,6 @@ This file is generated! See scripts/docs_collector.py experimental[] -== kvm module - This is the kvm module. diff --git a/metricbeat/docs/modules/munin.asciidoc b/metricbeat/docs/modules/munin.asciidoc index 517211e06823..0622fe3405f7 100644 --- a/metricbeat/docs/modules/munin.asciidoc +++ b/metricbeat/docs/modules/munin.asciidoc @@ -7,8 +7,6 @@ This file is generated! See scripts/docs_collector.py experimental[] -== munin module - This is the munin module. The default metricset is `node`. diff --git a/metricbeat/docs/modules/uwsgi.asciidoc b/metricbeat/docs/modules/uwsgi.asciidoc index bb8df6c8582d..2f102716b838 100644 --- a/metricbeat/docs/modules/uwsgi.asciidoc +++ b/metricbeat/docs/modules/uwsgi.asciidoc @@ -7,8 +7,6 @@ This file is generated! See scripts/docs_collector.py beta[] -== uwsgi module - This is the uwsgi module. By default collects the `stats` metricset, using http://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html[StatsServer]. diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc index 499820463da1..75421cb5230d 100644 --- a/metricbeat/docs/modules_list.asciidoc +++ b/metricbeat/docs/modules_list.asciidoc @@ -58,7 +58,8 @@ This file is generated! See scripts/docs_collector.py |<> beta[] |image:./images/icon-no.png[No prebuilt dashboards] | .1+| .1+| |<> beta[] |<> |image:./images/icon-yes.png[Prebuilt dashboards are available] | -.12+| .12+| |<> +.13+| .13+| |<> beta[] +|<> |<> beta[] |<> |<> diff --git a/metricbeat/module/kubernetes/apiserver/_meta/docs.asciidoc b/metricbeat/module/kubernetes/apiserver/_meta/docs.asciidoc new file mode 100644 index 000000000000..bc9e31737a4c --- /dev/null +++ b/metricbeat/module/kubernetes/apiserver/_meta/docs.asciidoc @@ -0,0 +1 @@ +This is the `apiserver` metricset of the Kubernetes module. diff --git a/metricbeat/module/kvm/_meta/docs.asciidoc b/metricbeat/module/kvm/_meta/docs.asciidoc index b4d11cbf9f0b..99141215f113 100644 --- a/metricbeat/module/kvm/_meta/docs.asciidoc +++ b/metricbeat/module/kvm/_meta/docs.asciidoc @@ -1,4 +1,2 @@ -== kvm module - This is the kvm module. diff --git a/metricbeat/module/kvm/dommemstat/_meta/docs.asciidoc b/metricbeat/module/kvm/dommemstat/_meta/docs.asciidoc index 9b34db197ddb..89e2dfff5d96 100644 --- a/metricbeat/module/kvm/dommemstat/_meta/docs.asciidoc +++ b/metricbeat/module/kvm/dommemstat/_meta/docs.asciidoc @@ -1,3 +1 @@ -=== kvm dommemstat MetricSet - This is the dommemstat metricset of the module kvm. diff --git a/metricbeat/module/munin/_meta/docs.asciidoc b/metricbeat/module/munin/_meta/docs.asciidoc index d7e009b4c28f..d4148381d2eb 100644 --- a/metricbeat/module/munin/_meta/docs.asciidoc +++ b/metricbeat/module/munin/_meta/docs.asciidoc @@ -1,5 +1,3 @@ -== munin module - This is the munin module. The default metricset is `node`. diff --git a/metricbeat/module/munin/node/_meta/docs.asciidoc b/metricbeat/module/munin/node/_meta/docs.asciidoc index a20a538c7462..403f5fa93b9f 100644 --- a/metricbeat/module/munin/node/_meta/docs.asciidoc +++ b/metricbeat/module/munin/node/_meta/docs.asciidoc @@ -1,5 +1,3 @@ -=== munin node MetricSet - This is the node metricset of the module munin. [float] diff --git a/metricbeat/module/uwsgi/_meta/docs.asciidoc b/metricbeat/module/uwsgi/_meta/docs.asciidoc index af53032206ee..89c89dc533a1 100644 --- a/metricbeat/module/uwsgi/_meta/docs.asciidoc +++ b/metricbeat/module/uwsgi/_meta/docs.asciidoc @@ -1,5 +1,3 @@ -== uwsgi module - This is the uwsgi module. By default collects the `stats` metricset, using http://uwsgi-docs.readthedocs.io/en/latest/StatsServer.html[StatsServer]. diff --git a/metricbeat/scripts/module/docs.asciidoc b/metricbeat/scripts/module/docs.asciidoc index 3447dd2758a9..447c150bb222 100644 --- a/metricbeat/scripts/module/docs.asciidoc +++ b/metricbeat/scripts/module/docs.asciidoc @@ -1,4 +1,2 @@ -== {module} module - This is the {module} module. diff --git a/metricbeat/scripts/module/metricset/docs.asciidoc b/metricbeat/scripts/module/metricset/docs.asciidoc index 1334c28ab761..9be9dece382a 100644 --- a/metricbeat/scripts/module/metricset/docs.asciidoc +++ b/metricbeat/scripts/module/metricset/docs.asciidoc @@ -1,3 +1 @@ -=== {module} {metricset} MetricSet - This is the {metricset} metricset of the module {module}.