[7.x] Add integration links metricbeat docs (#28110) (#28195)

* Add integration links metricbeat docs (#28110) * Link to integration docs from Metricbeat modules * Fix broken links in Filebeat module docs * Run make update
elastic · Oct 6, 2021 · 200a789 · 200a789
1 parent 01db990
commit 200a789
Show file tree

Hide file tree

Showing 103 changed files with 345 additions and 31 deletions.
diff --git a/filebeat/docs/modules/haproxy.asciidoc b/filebeat/docs/modules/haproxy.asciidoc
@@ -6,7 +6,7 @@ This file is generated! See scripts/docs_collector.py
 :modulename: haproxy
 :has-dashboards: true
 
-== haproxy module
+== HAproxy module
 
 include::{libbeat-dir}/shared/integration-link.asciidoc[]
 

diff --git a/filebeat/docs/modules/mysqlenterprise.asciidoc b/filebeat/docs/modules/mysqlenterprise.asciidoc
@@ -13,8 +13,6 @@ This file is generated! See scripts/docs_collector.py
 
 beta[]
 
-include::{libbeat-dir}/shared/integration-link.asciidoc[]
-
 This is a module for different types of MySQL logs. Currently focusing on data from the MySQL Enterprise Audit Plugin in JSON format.
 
 To configure the the Enterprise Audit Plugin to output in JSON format please follow the directions in the https://dev.mysql.com/doc/refman/8.0/en/audit-log-file-formats.html[MySQL Documentation.]

diff --git a/filebeat/docs/modules/nats.asciidoc b/filebeat/docs/modules/nats.asciidoc
@@ -6,11 +6,11 @@ This file is generated! See scripts/docs_collector.py
 :modulename: nats
 :has-dashboards: false
 
-== nats module
+== NATS module
 
 include::{libbeat-dir}/shared/integration-link.asciidoc[]
 
-This is the nats module.
+This is the NATS module.
 
 include::../include/what-happens.asciidoc[]
 
@@ -37,7 +37,7 @@ include::../include/var-paths.asciidoc[]
 [float]
 === Dashboard
 
-The Nats module comes with a predefined dashboard. For example:
+The +{modulename}+ module comes with a predefined dashboard. For example:
 
 image::./images/filebeat_nats_dashboard.png[]
 

diff --git a/filebeat/module/haproxy/_meta/docs.asciidoc b/filebeat/module/haproxy/_meta/docs.asciidoc
@@ -1,7 +1,7 @@
 :modulename: haproxy
 :has-dashboards: true
 
-== haproxy module
+== HAproxy module
 
 include::{libbeat-dir}/shared/integration-link.asciidoc[]
 

diff --git a/filebeat/module/nats/_meta/docs.asciidoc b/filebeat/module/nats/_meta/docs.asciidoc
@@ -1,11 +1,11 @@
 :modulename: nats
 :has-dashboards: false
 
-== nats module
+== NATS module
 
 include::{libbeat-dir}/shared/integration-link.asciidoc[]
 
-This is the nats module.
+This is the NATS module.
 
 include::../include/what-happens.asciidoc[]
 
@@ -32,7 +32,7 @@ include::../include/var-paths.asciidoc[]
 [float]
 === Dashboard
 
-The Nats module comes with a predefined dashboard. For example:
+The +{modulename}+ module comes with a predefined dashboard. For example:
 
 image::./images/filebeat_nats_dashboard.png[]
 

diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc
@@ -38486,7 +38486,7 @@ type: keyword
 --
 
 [[exported-fields-linux]]
-== linux fields
+== Linux fields
 
 linux module
 

diff --git a/metricbeat/docs/modules/activemq.asciidoc b/metricbeat/docs/modules/activemq.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: activemq
+
 [[metricbeat-module-activemq]]
 [role="xpack"]
 == ActiveMQ module

diff --git a/metricbeat/docs/modules/aerospike.asciidoc b/metricbeat/docs/modules/aerospike.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: aerospike
+
 [[metricbeat-module-aerospike]]
 == Aerospike module
 

diff --git a/metricbeat/docs/modules/airflow.asciidoc b/metricbeat/docs/modules/airflow.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: airflow
+
 [[metricbeat-module-airflow]]
 [role="xpack"]
 == Airflow module

diff --git a/metricbeat/docs/modules/apache.asciidoc b/metricbeat/docs/modules/apache.asciidoc
@@ -2,9 +2,15 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: apache
+
 [[metricbeat-module-apache]]
 == Apache module
 
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
 This module periodically fetches metrics from https://httpd.apache.org/[Apache
 HTTPD] servers. The default metricset is `status`.
 

diff --git a/metricbeat/docs/modules/appsearch.asciidoc b/metricbeat/docs/modules/appsearch.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: appsearch
+
 [[metricbeat-module-appsearch]]
 [role="xpack"]
 == App Search module

diff --git a/metricbeat/docs/modules/aws.asciidoc b/metricbeat/docs/modules/aws.asciidoc
@@ -2,12 +2,18 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: aws
+
 [[metricbeat-module-aws]]
 [role="xpack"]
 == AWS module
 
 :libbeat-xpack-dir: ../../../x-pack/libbeat
 
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
 This module periodically fetches monitoring metrics from AWS CloudWatch using
 https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html[GetMetricData API] for AWS services.
 

diff --git a/metricbeat/docs/modules/awsfargate.asciidoc b/metricbeat/docs/modules/awsfargate.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: awsfargate
+
 [[metricbeat-module-awsfargate]]
 [role="xpack"]
 == AWS Fargate module

diff --git a/metricbeat/docs/modules/azure.asciidoc b/metricbeat/docs/modules/azure.asciidoc
@@ -2,11 +2,18 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: azure
+
 [[metricbeat-module-azure]]
 [role="xpack"]
 == Azure module
 
-This is the azure module.
+//override value inherited for modulename
+:modulename: azure_metrics
+
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
 
 The Azure Monitor feature collects and aggregates logs and metrics from a variety of sources into a common data platform where it can be used for analysis, visualization, and alerting.
 

diff --git a/metricbeat/docs/modules/beat.asciidoc b/metricbeat/docs/modules/beat.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: beat
+
 [[metricbeat-module-beat]]
 == Beat module
 

diff --git a/metricbeat/docs/modules/ceph.asciidoc b/metricbeat/docs/modules/ceph.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: ceph
+
 [[metricbeat-module-ceph]]
 == Ceph module
 

diff --git a/metricbeat/docs/modules/cloudfoundry.asciidoc b/metricbeat/docs/modules/cloudfoundry.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: cloudfoundry
+
 [[metricbeat-module-cloudfoundry]]
 [role="xpack"]
 == Cloudfoundry module

diff --git a/metricbeat/docs/modules/cockroachdb.asciidoc b/metricbeat/docs/modules/cockroachdb.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: cockroachdb
+
 [[metricbeat-module-cockroachdb]]
 [role="xpack"]
 == CockroachDB module

diff --git a/metricbeat/docs/modules/consul.asciidoc b/metricbeat/docs/modules/consul.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: consul
+
 [[metricbeat-module-consul]]
 == Consul module
 

diff --git a/metricbeat/docs/modules/coredns.asciidoc b/metricbeat/docs/modules/coredns.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: coredns
+
 [[metricbeat-module-coredns]]
 [role="xpack"]
 == Coredns module

diff --git a/metricbeat/docs/modules/couchbase.asciidoc b/metricbeat/docs/modules/couchbase.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: couchbase
+
 [[metricbeat-module-couchbase]]
 == Couchbase module
 

diff --git a/metricbeat/docs/modules/couchdb.asciidoc b/metricbeat/docs/modules/couchdb.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: couchdb
+
 [[metricbeat-module-couchdb]]
 == CouchDB module
 

diff --git a/metricbeat/docs/modules/docker.asciidoc b/metricbeat/docs/modules/docker.asciidoc
@@ -2,9 +2,15 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: docker
+
 [[metricbeat-module-docker]]
 == Docker module
 
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
 This module fetches metrics from https://www.docker.com/[Docker] containers. The default metricsets are: `container`, `cpu`, `diskio`, `healthcheck`, `info`, `memory` and `network`. The `image` metricset is not enabled by default.
 
 [float]

diff --git a/metricbeat/docs/modules/dropwizard.asciidoc b/metricbeat/docs/modules/dropwizard.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: dropwizard
+
 [[metricbeat-module-dropwizard]]
 == Dropwizard module
 

diff --git a/metricbeat/docs/modules/elasticsearch.asciidoc b/metricbeat/docs/modules/elasticsearch.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: elasticsearch
+
 [[metricbeat-module-elasticsearch]]
 == Elasticsearch module
 

diff --git a/metricbeat/docs/modules/enterprisesearch.asciidoc b/metricbeat/docs/modules/enterprisesearch.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: enterprisesearch
+
 [[metricbeat-module-enterprisesearch]]
 [role="xpack"]
 == enterprisesearch module

diff --git a/metricbeat/docs/modules/envoyproxy.asciidoc b/metricbeat/docs/modules/envoyproxy.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: envoyproxy
+
 [[metricbeat-module-envoyproxy]]
 == Envoyproxy module
 

diff --git a/metricbeat/docs/modules/etcd.asciidoc b/metricbeat/docs/modules/etcd.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: etcd
+
 [[metricbeat-module-etcd]]
 == Etcd module
 

diff --git a/metricbeat/docs/modules/gcp.asciidoc b/metricbeat/docs/modules/gcp.asciidoc
@@ -2,12 +2,18 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: gcp
+
 [[metricbeat-module-gcp]]
 [role="xpack"]
 == Google Cloud Platform module
 
 beta[]
 
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
 This module periodically fetches monitoring metrics from Google Cloud Platform using
 https://cloud.google.com/monitoring/api/metrics_gcp[Stackdriver Monitoring API] for Google Cloud Platform services.
 

diff --git a/metricbeat/docs/modules/golang.asciidoc b/metricbeat/docs/modules/golang.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: golang
+
 [[metricbeat-module-golang]]
 == Golang module
 

diff --git a/metricbeat/docs/modules/graphite.asciidoc b/metricbeat/docs/modules/graphite.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: graphite
+
 [[metricbeat-module-graphite]]
 == Graphite module
 

diff --git a/metricbeat/docs/modules/haproxy.asciidoc b/metricbeat/docs/modules/haproxy.asciidoc
@@ -2,9 +2,15 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: haproxy
+
 [[metricbeat-module-haproxy]]
 == HAProxy module
 
+include::{libbeat-dir}/shared/integration-link.asciidoc[]
+
+:modulename!:
+
 This module collects stats from http://www.haproxy.org/[HAProxy]. It supports
 collection from TCP sockets, UNIX sockets, or HTTP with or without basic
 authentication.

diff --git a/metricbeat/docs/modules/http.asciidoc b/metricbeat/docs/modules/http.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: http
+
 [[metricbeat-module-http]]
 == HTTP module
 

diff --git a/metricbeat/docs/modules/ibmmq.asciidoc b/metricbeat/docs/modules/ibmmq.asciidoc
@@ -2,6 +2,8 @@
 This file is generated! See scripts/mage/docs_collector.go
 ////
 
+:modulename: ibmmq
+
 [[metricbeat-module-ibmmq]]
 [role="xpack"]
 == IBM MQ module
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,8 +13,6 @@ This file is generated! See scripts/docs_collector.py @@
     beta[]
-    include::{libbeat-dir}/shared/integration-link.asciidoc[]
     This is a module for different types of MySQL logs. Currently focusing on data from the MySQL Enterprise Audit Plugin in JSON format.
     To configure the the Enterprise Audit Plugin to output in JSON format please follow the directions in the https://dev.mysql.com/doc/refman/8.0/en/audit-log-file-formats.html[MySQL Documentation.]
@@ Expand Down @@