Skip to content

Commit

Permalink
Ceph: describe exposed ports (elastic#17566) (elastic#17581)
Browse files Browse the repository at this point in the history
(cherry picked from commit 0713a1b)
  • Loading branch information
mtojek authored Apr 8, 2020
1 parent c93902b commit c8be4c4
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 2 deletions.
19 changes: 18 additions & 1 deletion metricbeat/docs/modules/ceph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@ This file is generated! See scripts/mage/docs_collector.go
== Ceph module

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`.
the https://docs.ceph.com/docs/jewel/man/8/ceph-rest-api/[ceph-rest-api]. The default metricsets are `cluster_disk`, `cluster_health`, `monitor_health`, `pool_disk`, `osd_tree`.

Metricsets connecting to the Ceph REST API uses by default the service exposed on port 5000.
Metricsets using the Ceph Manager Daemon communicate with the API exposed by default on port 8003 (SSL encryption).

[float]
=== Compatibility
Expand All @@ -33,11 +36,25 @@ in <<configuration-metricbeat>>. Here is an example configuration:
[source,yaml]
----
metricbeat.modules:
# Metricsets depending on the Ceph REST API (default port: 5000)
- module: ceph
metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk", "osd_tree"]
period: 10s
hosts: ["localhost:5000"]
enabled: true
# Metricsets depending on the Ceph Manager Daemon (default port: 8003)
- module: ceph
metricsets:
- mgr_cluster_disk
- mgr_osd_perf
- mgr_pool_disk
- mgr_osd_pool_stats
- mgr_osd_tree
period: 1m
hosts: [ "https://localhost:8003" ]
#username: "user"
#password: "secret"
----

This module supports TLS connections when using `ssl` config field, as described in <<configuration-ssl>>.
Expand Down
14 changes: 14 additions & 0 deletions metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -177,12 +177,26 @@ metricbeat.modules:
#xpack.enabled: false

#--------------------------------- Ceph Module ---------------------------------
# Metricsets depending on the Ceph REST API (default port: 5000)
- module: ceph
metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk", "osd_tree"]
period: 10s
hosts: ["localhost:5000"]
enabled: true

# Metricsets depending on the Ceph Manager Daemon (default port: 8003)
- module: ceph
metricsets:
- mgr_cluster_disk
- mgr_osd_perf
- mgr_pool_disk
- mgr_osd_pool_stats
- mgr_osd_tree
period: 1m
hosts: [ "https://localhost:8003" ]
#username: "user"
#password: "secret"

#-------------------------------- Consul Module --------------------------------
- module: consul
metricsets:
Expand Down
14 changes: 14 additions & 0 deletions metricbeat/module/ceph/_meta/config.reference.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Metricsets depending on the Ceph REST API (default port: 5000)
- module: ceph
metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk", "osd_tree"]
period: 10s
hosts: ["localhost:5000"]
enabled: true

# Metricsets depending on the Ceph Manager Daemon (default port: 8003)
- module: ceph
metricsets:
- mgr_cluster_disk
- mgr_osd_perf
- mgr_pool_disk
- mgr_osd_pool_stats
- mgr_osd_tree
period: 1m
hosts: [ "https://localhost:8003" ]
#username: "user"
#password: "secret"
5 changes: 4 additions & 1 deletion metricbeat/module/ceph/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
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`.
the https://docs.ceph.com/docs/jewel/man/8/ceph-rest-api/[ceph-rest-api]. The default metricsets are `cluster_disk`, `cluster_health`, `monitor_health`, `pool_disk`, `osd_tree`.

Metricsets connecting to the Ceph REST API uses by default the service exposed on port 5000.
Metricsets using the Ceph Manager Daemon communicate with the API exposed by default on port 8003 (SSL encryption).

[float]
=== Compatibility
Expand Down
14 changes: 14 additions & 0 deletions x-pack/metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -338,12 +338,26 @@ metricbeat.modules:
#xpack.enabled: false

#--------------------------------- Ceph Module ---------------------------------
# Metricsets depending on the Ceph REST API (default port: 5000)
- module: ceph
metricsets: ["cluster_disk", "cluster_health", "monitor_health", "pool_disk", "osd_tree"]
period: 10s
hosts: ["localhost:5000"]
enabled: true

# Metricsets depending on the Ceph Manager Daemon (default port: 8003)
- module: ceph
metricsets:
- mgr_cluster_disk
- mgr_osd_perf
- mgr_pool_disk
- mgr_osd_pool_stats
- mgr_osd_tree
period: 1m
hosts: [ "https://localhost:8003" ]
#username: "user"
#password: "secret"

#----------------------------- Cloudfoundry Module -----------------------------
- module: cloudfoundry
metricsets:
Expand Down

0 comments on commit c8be4c4

Please sign in to comment.