From e8519c70aa344a9cc855a6e1b5847093c845adff Mon Sep 17 00:00:00 2001
From: Jaime Soriano Pastor <jaime.soriano@elastic.co>
Date: Fri, 10 Aug 2018 14:19:49 +0200
Subject: [PATCH] Metricbeat: Add compatibility notes where missing (#7939)

* Metricbeat: Add compatibility notes where missing, based on integration tests

* Added review suggestions
---
 metricbeat/docs/modules/ceph.asciidoc               | 5 +++++
 metricbeat/docs/modules/couchbase.asciidoc          | 5 +++++
 metricbeat/docs/modules/docker.asciidoc             | 7 ++++++-
 metricbeat/docs/modules/dropwizard.asciidoc         | 4 ++++
 metricbeat/docs/modules/elasticsearch.asciidoc      | 6 ++++++
 metricbeat/docs/modules/envoyproxy.asciidoc         | 5 +++++
 metricbeat/docs/modules/etcd.asciidoc               | 5 +++++
 metricbeat/docs/modules/jolokia.asciidoc            | 6 ++++++
 metricbeat/docs/modules/kafka.asciidoc              | 3 +++
 metricbeat/docs/modules/kibana.asciidoc             | 5 +++++
 metricbeat/docs/modules/kubernetes.asciidoc         | 5 +++++
 metricbeat/docs/modules/kvm.asciidoc                | 1 -
 metricbeat/docs/modules/logstash.asciidoc           | 5 +++++
 metricbeat/docs/modules/memcached.asciidoc          | 5 +++++
 metricbeat/docs/modules/munin.asciidoc              | 7 +++++++
 metricbeat/docs/modules/rabbitmq.asciidoc           | 7 +++++++
 metricbeat/module/ceph/_meta/docs.asciidoc          | 5 +++++
 metricbeat/module/couchbase/_meta/docs.asciidoc     | 5 +++++
 metricbeat/module/docker/_meta/docs.asciidoc        | 7 ++++++-
 metricbeat/module/dropwizard/_meta/docs.asciidoc    | 4 ++++
 metricbeat/module/elasticsearch/_meta/docs.asciidoc | 6 ++++++
 metricbeat/module/envoyproxy/_meta/docs.asciidoc    | 5 +++++
 metricbeat/module/etcd/_meta/docs.asciidoc          | 5 +++++
 metricbeat/module/jolokia/_meta/docs.asciidoc       | 6 ++++++
 metricbeat/module/kafka/_meta/docs.asciidoc         | 3 +++
 metricbeat/module/kibana/_meta/docs.asciidoc        | 5 +++++
 metricbeat/module/kubernetes/_meta/docs.asciidoc    | 5 +++++
 metricbeat/module/kvm/_meta/docs.asciidoc           | 1 -
 metricbeat/module/logstash/_meta/docs.asciidoc      | 5 +++++
 metricbeat/module/memcached/_meta/docs.asciidoc     | 5 +++++
 metricbeat/module/munin/_meta/docs.asciidoc         | 7 +++++++
 metricbeat/module/rabbitmq/_meta/docs.asciidoc      | 7 +++++++
 32 files changed, 158 insertions(+), 4 deletions(-)

diff --git a/metricbeat/docs/modules/ceph.asciidoc b/metricbeat/docs/modules/ceph.asciidoc
index b1d2f75886db..a9b096fdb159 100644
--- a/metricbeat/docs/modules/ceph.asciidoc
+++ b/metricbeat/docs/modules/ceph.asciidoc
@@ -10,6 +10,11 @@ beta[]
 The Ceph module collects metrics by submitting HTTP GET requests to
 the http://docs.ceph.com/docs/master/man/8/ceph-rest-api/[ceph-rest-api]. The default metricsets are `cluster_disk`, `cluster_health`, `monitor_health`, `pool_disk`, `osd_tree`.
 
+[float]
+=== Compatibility
+
+The Ceph module is tested with Ceph Jewel (10.2.10).
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/couchbase.asciidoc b/metricbeat/docs/modules/couchbase.asciidoc
index c8c47367beb6..20d69ae14549 100644
--- a/metricbeat/docs/modules/couchbase.asciidoc
+++ b/metricbeat/docs/modules/couchbase.asciidoc
@@ -10,6 +10,11 @@ beta[]
 This module periodically fetches metrics from https://www.couchbase.com/[Couchbase]
 servers. The default metricsets are `bucket`, `cluster`, `node`.
 
+[float]
+=== Compatibility
+
+The Couchbase module is tested with Couchbase 4.5.1.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/docker.asciidoc b/metricbeat/docs/modules/docker.asciidoc
index 5419685b6eb2..4ba7b5ee641b 100644
--- a/metricbeat/docs/modules/docker.asciidoc
+++ b/metricbeat/docs/modules/docker.asciidoc
@@ -7,7 +7,12 @@ This file is generated! See scripts/docs_collector.py
 
 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.
 
-The Docker module is currently not tested on Windows.
+[float]
+=== Compability
+
+The Docker module is currently tested on Linux and Mac with the community
+edition engine, versions 1.11 and 17.09.0-ce. It is not tested on Windows,
+but it should also work there.
 
 [float]
 === Module-specific configuration notes
diff --git a/metricbeat/docs/modules/dropwizard.asciidoc b/metricbeat/docs/modules/dropwizard.asciidoc
index 7a110f092926..9cd2bb27471d 100644
--- a/metricbeat/docs/modules/dropwizard.asciidoc
+++ b/metricbeat/docs/modules/dropwizard.asciidoc
@@ -9,6 +9,10 @@ beta[]
 
 This is the http://dropwizard.io[Dropwizard] module. The default metricset is `collector`.
 
+[float]
+=== Compability
+
+The Dropwizard module is tested with dropwizard metrics 3.1.0.
 
 
 [float]
diff --git a/metricbeat/docs/modules/elasticsearch.asciidoc b/metricbeat/docs/modules/elasticsearch.asciidoc
index 270b3906f43d..a382b6fc0916 100644
--- a/metricbeat/docs/modules/elasticsearch.asciidoc
+++ b/metricbeat/docs/modules/elasticsearch.asciidoc
@@ -11,6 +11,12 @@ The Elasticsearch module contains a minimal set of metrics to enable monitoring
 
 The default metricsets are `node` and `node_stats`.
 
+[float]
+=== Compability
+
+The Elasticsearch module is tested with Elasticsearch 6.3 and is expected to
+work with all 6.x versions.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/envoyproxy.asciidoc b/metricbeat/docs/modules/envoyproxy.asciidoc
index 030b71153cf8..a6fb7a1919de 100644
--- a/metricbeat/docs/modules/envoyproxy.asciidoc
+++ b/metricbeat/docs/modules/envoyproxy.asciidoc
@@ -13,6 +13,11 @@ This is the envoyproxy module.
 
 The default metricset is `server`.
 
+[float]
+=== Compability
+
+The envoyproxy module is tested with Envoy 1.7.0.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/etcd.asciidoc b/metricbeat/docs/modules/etcd.asciidoc
index 3b7184424b30..e4cba1a5340c 100644
--- a/metricbeat/docs/modules/etcd.asciidoc
+++ b/metricbeat/docs/modules/etcd.asciidoc
@@ -11,6 +11,11 @@ This is the Etcd Module. The Etcd module uses https://coreos.com/etcd/docs/lates
 
 The default metricsets are `leader`, `self` and `store`.
 
+[float]
+=== Compatibility
+
+The etcd module is tested with etcd 3.2.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/jolokia.asciidoc b/metricbeat/docs/modules/jolokia.asciidoc
index 6674ed18981f..16eb39c60d54 100644
--- a/metricbeat/docs/modules/jolokia.asciidoc
+++ b/metricbeat/docs/modules/jolokia.asciidoc
@@ -7,6 +7,12 @@ This file is generated! See scripts/docs_collector.py
 
 This is the Jolokia module.
 
+[float]
+=== Compatibility
+
+The Jolokia module is tested with Jolokia 1.5.0, it should work with any version
+since 1.2.2.
+
 
 
 [float]
diff --git a/metricbeat/docs/modules/kafka.asciidoc b/metricbeat/docs/modules/kafka.asciidoc
index faacaaea5b7d..b9b472645fe7 100644
--- a/metricbeat/docs/modules/kafka.asciidoc
+++ b/metricbeat/docs/modules/kafka.asciidoc
@@ -11,6 +11,9 @@ This is the Kafka module.
 
 The default metricsets are `consumergroup` and `partition`.
 
+[float]
+=== Compability
+
 This module is tested with Kafka 0.10.2 and 1.1.0.
 
 
diff --git a/metricbeat/docs/modules/kibana.asciidoc b/metricbeat/docs/modules/kibana.asciidoc
index 0aa7ce4c2425..ebb12ee30829 100644
--- a/metricbeat/docs/modules/kibana.asciidoc
+++ b/metricbeat/docs/modules/kibana.asciidoc
@@ -11,6 +11,11 @@ The Kibana module only tracks the high-level metrics. To monitor more Kibana met
 
 The default metricset is `status`.
 
+[float]
+=== Compatibility
+
+The Kibana module is tested with Kibana 6.3.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/kubernetes.asciidoc b/metricbeat/docs/modules/kubernetes.asciidoc
index d2398036c8db..5b12afca67a8 100644
--- a/metricbeat/docs/modules/kubernetes.asciidoc
+++ b/metricbeat/docs/modules/kubernetes.asciidoc
@@ -14,6 +14,11 @@ example configuration on how to do it.
 
 The default metricsets are `container`, `node`, `pod`, `system` and `volume`.
 
+[float]
+=== Compability
+
+The Kubernetes module is tested with Kubernetes 1.8.0, 1.9.4 and 1.10.0.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/kvm.asciidoc b/metricbeat/docs/modules/kvm.asciidoc
index b5acf8877dc9..05f235344ad3 100644
--- a/metricbeat/docs/modules/kvm.asciidoc
+++ b/metricbeat/docs/modules/kvm.asciidoc
@@ -10,7 +10,6 @@ experimental[]
 This is the kvm module.
 
 
-
 [float]
 === Example configuration
 
diff --git a/metricbeat/docs/modules/logstash.asciidoc b/metricbeat/docs/modules/logstash.asciidoc
index 999fee81aa33..f2a062bf3b62 100644
--- a/metricbeat/docs/modules/logstash.asciidoc
+++ b/metricbeat/docs/modules/logstash.asciidoc
@@ -11,6 +11,11 @@ This is the Logstash module.
 
 The default metricsets are `node` and `node_stats`.
 
+[float]
+=== Compability
+
+The logstash module is tested with logstash 6.3.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/memcached.asciidoc b/metricbeat/docs/modules/memcached.asciidoc
index 5b0a425e5c0d..76a61a1076f8 100644
--- a/metricbeat/docs/modules/memcached.asciidoc
+++ b/metricbeat/docs/modules/memcached.asciidoc
@@ -11,6 +11,11 @@ This is the Memcached module. These metricsets were tested with Memcached versio
 
 The default metricset is `stats`.
 
+[float]
+=== Compatibility
+
+The memcached module is tested with memcached 1.4.35.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/munin.asciidoc b/metricbeat/docs/modules/munin.asciidoc
index 08fd4fb272ad..a30361167bb8 100644
--- a/metricbeat/docs/modules/munin.asciidoc
+++ b/metricbeat/docs/modules/munin.asciidoc
@@ -11,6 +11,13 @@ This is the munin module.
 
 The default metricset is `node`.
 
+[float]
+=== Compatibility
+
+Munin module should be compatible with any implementation of the munin network
+protocol (http://guide.munin-monitoring.org/en/latest/master/network-protocol.html),
+it is tested with munin node 2.0.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/docs/modules/rabbitmq.asciidoc b/metricbeat/docs/modules/rabbitmq.asciidoc
index 409f773d24c9..8c623e9e4d0a 100644
--- a/metricbeat/docs/modules/rabbitmq.asciidoc
+++ b/metricbeat/docs/modules/rabbitmq.asciidoc
@@ -13,6 +13,13 @@ The default metricsets are `connection`, `node`, `queue` and `exchange`.
 
 If `management.path_prefix` is set in RabbitMQ configuration, `management_path_prefix` has to be set to the same value in this module configuration.
 
+[float]
+=== Compatibility
+
+The rabbitmq module is tested with RabbitMQ 3.7.4, and it should be compatible
+with any version supporting the management plugin. This plugin needs to be
+enabled.
+
 
 [float]
 === Example configuration
diff --git a/metricbeat/module/ceph/_meta/docs.asciidoc b/metricbeat/module/ceph/_meta/docs.asciidoc
index ec2e4442f365..8d46ba911f93 100644
--- a/metricbeat/module/ceph/_meta/docs.asciidoc
+++ b/metricbeat/module/ceph/_meta/docs.asciidoc
@@ -1,2 +1,7 @@
 The Ceph module collects metrics by submitting HTTP GET requests to
 the http://docs.ceph.com/docs/master/man/8/ceph-rest-api/[ceph-rest-api]. The default metricsets are `cluster_disk`, `cluster_health`, `monitor_health`, `pool_disk`, `osd_tree`.
+
+[float]
+=== Compatibility
+
+The Ceph module is tested with Ceph Jewel (10.2.10).
diff --git a/metricbeat/module/couchbase/_meta/docs.asciidoc b/metricbeat/module/couchbase/_meta/docs.asciidoc
index 08f8895a95ca..97aa22fc1ee0 100644
--- a/metricbeat/module/couchbase/_meta/docs.asciidoc
+++ b/metricbeat/module/couchbase/_meta/docs.asciidoc
@@ -1,2 +1,7 @@
 This module periodically fetches metrics from https://www.couchbase.com/[Couchbase]
 servers. The default metricsets are `bucket`, `cluster`, `node`.
+
+[float]
+=== Compatibility
+
+The Couchbase module is tested with Couchbase 4.5.1.
diff --git a/metricbeat/module/docker/_meta/docs.asciidoc b/metricbeat/module/docker/_meta/docs.asciidoc
index eaed945814d1..90c299a72608 100644
--- a/metricbeat/module/docker/_meta/docs.asciidoc
+++ b/metricbeat/module/docker/_meta/docs.asciidoc
@@ -1,6 +1,11 @@
 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.
 
-The Docker module is currently not tested on Windows.
+[float]
+=== Compability
+
+The Docker module is currently tested on Linux and Mac with the community
+edition engine, versions 1.11 and 17.09.0-ce. It is not tested on Windows,
+but it should also work there.
 
 [float]
 === Module-specific configuration notes
diff --git a/metricbeat/module/dropwizard/_meta/docs.asciidoc b/metricbeat/module/dropwizard/_meta/docs.asciidoc
index 31cef1041852..193b984ae57d 100644
--- a/metricbeat/module/dropwizard/_meta/docs.asciidoc
+++ b/metricbeat/module/dropwizard/_meta/docs.asciidoc
@@ -1,2 +1,6 @@
 This is the http://dropwizard.io[Dropwizard] module. The default metricset is `collector`.
 
+[float]
+=== Compability
+
+The Dropwizard module is tested with dropwizard metrics 3.1.0.
diff --git a/metricbeat/module/elasticsearch/_meta/docs.asciidoc b/metricbeat/module/elasticsearch/_meta/docs.asciidoc
index 9e6909c53cd2..3a47799f4fad 100644
--- a/metricbeat/module/elasticsearch/_meta/docs.asciidoc
+++ b/metricbeat/module/elasticsearch/_meta/docs.asciidoc
@@ -1,3 +1,9 @@
 The Elasticsearch module contains a minimal set of metrics to enable monitoring of Elasticsearch across multiple versions. To monitor more Elasticsearch metrics, use our {monitoringdoc}/xpack-monitoring.html[monitoring] feature.
 
 The default metricsets are `node` and `node_stats`.
+
+[float]
+=== Compability
+
+The Elasticsearch module is tested with Elasticsearch 6.3 and is expected to
+work with all 6.x versions.
diff --git a/metricbeat/module/envoyproxy/_meta/docs.asciidoc b/metricbeat/module/envoyproxy/_meta/docs.asciidoc
index 45ba44944984..cc900202a117 100644
--- a/metricbeat/module/envoyproxy/_meta/docs.asciidoc
+++ b/metricbeat/module/envoyproxy/_meta/docs.asciidoc
@@ -3,3 +3,8 @@
 This is the envoyproxy module.
 
 The default metricset is `server`.
+
+[float]
+=== Compability
+
+The envoyproxy module is tested with Envoy 1.7.0.
diff --git a/metricbeat/module/etcd/_meta/docs.asciidoc b/metricbeat/module/etcd/_meta/docs.asciidoc
index 06493114846d..cad1c1bbd604 100644
--- a/metricbeat/module/etcd/_meta/docs.asciidoc
+++ b/metricbeat/module/etcd/_meta/docs.asciidoc
@@ -1,3 +1,8 @@
 This is the Etcd Module. The Etcd module uses https://coreos.com/etcd/docs/latest/v2/api.html [Etcd v2 API] to collect metrics.
 
 The default metricsets are `leader`, `self` and `store`.
+
+[float]
+=== Compatibility
+
+The etcd module is tested with etcd 3.2.
diff --git a/metricbeat/module/jolokia/_meta/docs.asciidoc b/metricbeat/module/jolokia/_meta/docs.asciidoc
index e6756451731c..ec71c8d74a5b 100644
--- a/metricbeat/module/jolokia/_meta/docs.asciidoc
+++ b/metricbeat/module/jolokia/_meta/docs.asciidoc
@@ -1,2 +1,8 @@
 This is the Jolokia module.
 
+[float]
+=== Compatibility
+
+The Jolokia module is tested with Jolokia 1.5.0, it should work with any version
+since 1.2.2.
+
diff --git a/metricbeat/module/kafka/_meta/docs.asciidoc b/metricbeat/module/kafka/_meta/docs.asciidoc
index a8682ea194b8..05e52c5369ce 100644
--- a/metricbeat/module/kafka/_meta/docs.asciidoc
+++ b/metricbeat/module/kafka/_meta/docs.asciidoc
@@ -2,4 +2,7 @@ This is the Kafka module.
 
 The default metricsets are `consumergroup` and `partition`.
 
+[float]
+=== Compability
+
 This module is tested with Kafka 0.10.2 and 1.1.0.
diff --git a/metricbeat/module/kibana/_meta/docs.asciidoc b/metricbeat/module/kibana/_meta/docs.asciidoc
index a979535ac65a..a941ecb240dc 100644
--- a/metricbeat/module/kibana/_meta/docs.asciidoc
+++ b/metricbeat/module/kibana/_meta/docs.asciidoc
@@ -1,3 +1,8 @@
 The Kibana module only tracks the high-level metrics. To monitor more Kibana metrics, use our {monitoringdoc}/xpack-monitoring.html[monitoring] feature.
 
 The default metricset is `status`.
+
+[float]
+=== Compatibility
+
+The Kibana module is tested with Kibana 6.3.
diff --git a/metricbeat/module/kubernetes/_meta/docs.asciidoc b/metricbeat/module/kubernetes/_meta/docs.asciidoc
index 30909d4127fc..59fe65436703 100644
--- a/metricbeat/module/kubernetes/_meta/docs.asciidoc
+++ b/metricbeat/module/kubernetes/_meta/docs.asciidoc
@@ -6,3 +6,8 @@ service within the cluster, while the rest should be pointed to kubelet service.
 example configuration on how to do it.
 
 The default metricsets are `container`, `node`, `pod`, `system` and `volume`.
+
+[float]
+=== Compability
+
+The Kubernetes module is tested with Kubernetes 1.8.0, 1.9.4 and 1.10.0.
diff --git a/metricbeat/module/kvm/_meta/docs.asciidoc b/metricbeat/module/kvm/_meta/docs.asciidoc
index 99141215f113..3658a4ccae85 100644
--- a/metricbeat/module/kvm/_meta/docs.asciidoc
+++ b/metricbeat/module/kvm/_meta/docs.asciidoc
@@ -1,2 +1 @@
 This is the kvm module.
-
diff --git a/metricbeat/module/logstash/_meta/docs.asciidoc b/metricbeat/module/logstash/_meta/docs.asciidoc
index bddd411d4029..1627fa350270 100644
--- a/metricbeat/module/logstash/_meta/docs.asciidoc
+++ b/metricbeat/module/logstash/_meta/docs.asciidoc
@@ -1,3 +1,8 @@
 This is the Logstash module.
 
 The default metricsets are `node` and `node_stats`.
+
+[float]
+=== Compability
+
+The logstash module is tested with logstash 6.3.
diff --git a/metricbeat/module/memcached/_meta/docs.asciidoc b/metricbeat/module/memcached/_meta/docs.asciidoc
index 848df9e5d697..53b33a0e1117 100644
--- a/metricbeat/module/memcached/_meta/docs.asciidoc
+++ b/metricbeat/module/memcached/_meta/docs.asciidoc
@@ -1,3 +1,8 @@
 This is the Memcached module. These metricsets were tested with Memcached version 1.4.35.
 
 The default metricset is `stats`.
+
+[float]
+=== Compatibility
+
+The memcached module is tested with memcached 1.4.35.
diff --git a/metricbeat/module/munin/_meta/docs.asciidoc b/metricbeat/module/munin/_meta/docs.asciidoc
index d4148381d2eb..6476645f5e1f 100644
--- a/metricbeat/module/munin/_meta/docs.asciidoc
+++ b/metricbeat/module/munin/_meta/docs.asciidoc
@@ -1,3 +1,10 @@
 This is the munin module.
 
 The default metricset is `node`.
+
+[float]
+=== Compatibility
+
+Munin module should be compatible with any implementation of the munin network
+protocol (http://guide.munin-monitoring.org/en/latest/master/network-protocol.html),
+it is tested with munin node 2.0.
diff --git a/metricbeat/module/rabbitmq/_meta/docs.asciidoc b/metricbeat/module/rabbitmq/_meta/docs.asciidoc
index 7d4677f809e1..add71e58e9cd 100644
--- a/metricbeat/module/rabbitmq/_meta/docs.asciidoc
+++ b/metricbeat/module/rabbitmq/_meta/docs.asciidoc
@@ -3,3 +3,10 @@ The RabbitMQ module uses http://www.rabbitmq.com/management.html[HTTP API] creat
 The default metricsets are `connection`, `node`, `queue` and `exchange`.
 
 If `management.path_prefix` is set in RabbitMQ configuration, `management_path_prefix` has to be set to the same value in this module configuration.
+
+[float]
+=== Compatibility
+
+The rabbitmq module is tested with RabbitMQ 3.7.4, and it should be compatible
+with any version supporting the management plugin. This plugin needs to be
+enabled.