Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Metricbeat: Add compatibility notes where missing #7939

Merged
merged 2 commits into from
Aug 10, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/ceph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a dot at the end? I think also applies to more entries below. Should we also put a version number here? (10.2)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added, added version number as in the docker image we use too.



[float]
=== Example configuration
Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/couchbase.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions metricbeat/docs/modules/docker.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ 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.

[float]
=== Compability

The Docker module is currently not tested on Windows.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have any details around with which docker version we test?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added more details, though the versions are the ones in travis and jenkins.


[float]
Expand Down
4 changes: 4 additions & 0 deletions metricbeat/docs/modules/dropwizard.asciidoc
Original file line number Diff 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
6 changes: 6 additions & 0 deletions metricbeat/docs/modules/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/envoyproxy.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/etcd.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions metricbeat/docs/modules/jolokia.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
3 changes: 3 additions & 0 deletions metricbeat/docs/modules/kafka.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/kibana.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/kubernetes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 0 additions & 1 deletion metricbeat/docs/modules/kvm.asciidoc
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
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/logstash.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions metricbeat/docs/modules/memcached.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions metricbeat/docs/modules/munin.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions metricbeat/docs/modules/rabbitmq.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions metricbeat/module/ceph/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions metricbeat/module/couchbase/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions metricbeat/module/docker/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
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]
=== Compability

The Docker module is currently not tested on Windows.

[float]
Expand Down
4 changes: 4 additions & 0 deletions metricbeat/module/dropwizard/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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
6 changes: 6 additions & 0 deletions metricbeat/module/elasticsearch/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions metricbeat/module/envoyproxy/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 5 additions & 0 deletions metricbeat/module/etcd/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 6 additions & 0 deletions metricbeat/module/jolokia/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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.

3 changes: 3 additions & 0 deletions metricbeat/module/kafka/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
5 changes: 5 additions & 0 deletions metricbeat/module/kibana/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions metricbeat/module/kubernetes/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 0 additions & 1 deletion metricbeat/module/kvm/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
This is the kvm module.

5 changes: 5 additions & 0 deletions metricbeat/module/logstash/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions metricbeat/module/memcached/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions metricbeat/module/munin/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions metricbeat/module/rabbitmq/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.