Metricbeat: Add compatibility notes where missing (elastic#7939)

* Metricbeat: Add compatibility notes where missing, based on integration tests * Added review suggestions
dedemorton · Aug 31, 2018 · e8519c7 · e8519c7
1 parent 1f5e658
commit e8519c7
Show file tree

Hide file tree

Showing 32 changed files with 158 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,2 +1 @@
 This is the kvm module.
-
diff --git 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
@@ -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
@@ -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
@@ -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.
-Original file line number
+Diff line change
@@ Expand Up / @@ -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]
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,7 +10,6 @@ experimental[]
		This is the kvm module.



		[float]
		=== Example configuration

Expand Down