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

Cherry-pick #16254 to 7.x: [Metricbeat] Update Ceph module to support new API #16404

Merged
merged 2 commits into from
Feb 19, 2020
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
110 changes: 110 additions & 0 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3706,6 +3706,116 @@ type: long

--

[float]
=== mgr_cluster_disk

see: cluster_disk


[float]
=== mgr_cluster_health

see: cluster_health


[float]
=== mgr_osd_perf

OSD performance metrics of Ceph cluster



*`ceph.mgr_osd_perf.id`*::
+
--
OSD ID

type: long

--

*`ceph.mgr_osd_perf.stats.commit_latency_ms`*::
+
--
Commit latency in ms

type: long

--

*`ceph.mgr_osd_perf.stats.apply_latency_ms`*::
+
--
Apply latency in ms

type: long

--

*`ceph.mgr_osd_perf.stats.commit_latency_ns`*::
+
--
Commit latency in ns

type: long

--

*`ceph.mgr_osd_perf.stats.apply_latency_ns`*::
+
--
Apply latency in ns

type: long

--

[float]
=== mgr_osd_pool_stats

OSD pool stats of Ceph cluster



*`ceph.mgr_osd_pool_stats.pool_name`*::
+
--
Pool name

type: keyword

--

*`ceph.mgr_osd_pool_stats.pool_id`*::
+
--
Pool ID

type: long

--

*`ceph.mgr_osd_pool_stats.client_io_rate`*::
+
--
Client I/O rates

type: object

--

[float]
=== mgr_osd_tree

see: osd_tree


[float]
=== mgr_pool_disk

see: pool_disk


[float]
=== monitor_health

Expand Down
28 changes: 27 additions & 1 deletion metricbeat/docs/modules/ceph.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ the http://docs.ceph.com/docs/master/man/8/ceph-rest-api/[ceph-rest-api]. The de
[float]
=== Compatibility

The Ceph module is tested with Ceph Jewel (10.2.10).
The Ceph module is tested with Ceph Jewel (10.2.10) and Ceph Nautilus (14.2.7).

Metricsets with the `mgr_` prefix are compatible with Ceph releases using the Ceph Manager Daemon.

[float]
=== Dashboard
Expand Down Expand Up @@ -52,6 +54,18 @@ The following metricsets are available:

* <<metricbeat-metricset-ceph-cluster_status,cluster_status>>

* <<metricbeat-metricset-ceph-mgr_cluster_disk,mgr_cluster_disk>>

* <<metricbeat-metricset-ceph-mgr_cluster_health,mgr_cluster_health>>

* <<metricbeat-metricset-ceph-mgr_osd_perf,mgr_osd_perf>>

* <<metricbeat-metricset-ceph-mgr_osd_pool_stats,mgr_osd_pool_stats>>

* <<metricbeat-metricset-ceph-mgr_osd_tree,mgr_osd_tree>>

* <<metricbeat-metricset-ceph-mgr_pool_disk,mgr_pool_disk>>

* <<metricbeat-metricset-ceph-monitor_health,monitor_health>>

* <<metricbeat-metricset-ceph-osd_df,osd_df>>
Expand All @@ -66,6 +80,18 @@ include::ceph/cluster_health.asciidoc[]

include::ceph/cluster_status.asciidoc[]

include::ceph/mgr_cluster_disk.asciidoc[]

include::ceph/mgr_cluster_health.asciidoc[]

include::ceph/mgr_osd_perf.asciidoc[]

include::ceph/mgr_osd_pool_stats.asciidoc[]

include::ceph/mgr_osd_tree.asciidoc[]

include::ceph/mgr_pool_disk.asciidoc[]

include::ceph/monitor_health.asciidoc[]

include::ceph/osd_df.asciidoc[]
Expand Down
23 changes: 23 additions & 0 deletions metricbeat/docs/modules/ceph/mgr_cluster_disk.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-ceph-mgr_cluster_disk]]
=== Ceph mgr_cluster_disk metricset

beta[]

include::../../../module/ceph/mgr_cluster_disk/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-ceph,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/ceph/mgr_cluster_disk/_meta/data.json[]
----
23 changes: 23 additions & 0 deletions metricbeat/docs/modules/ceph/mgr_cluster_health.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-ceph-mgr_cluster_health]]
=== Ceph mgr_cluster_health metricset

beta[]

include::../../../module/ceph/mgr_cluster_health/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-ceph,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/ceph/mgr_cluster_health/_meta/data.json[]
----
23 changes: 23 additions & 0 deletions metricbeat/docs/modules/ceph/mgr_osd_perf.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-ceph-mgr_osd_perf]]
=== Ceph mgr_osd_perf metricset

beta[]

include::../../../module/ceph/mgr_osd_perf/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-ceph,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/ceph/mgr_osd_perf/_meta/data.json[]
----
23 changes: 23 additions & 0 deletions metricbeat/docs/modules/ceph/mgr_osd_pool_stats.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-ceph-mgr_osd_pool_stats]]
=== Ceph mgr_osd_pool_stats metricset

beta[]

include::../../../module/ceph/mgr_osd_pool_stats/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-ceph,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/ceph/mgr_osd_pool_stats/_meta/data.json[]
----
23 changes: 23 additions & 0 deletions metricbeat/docs/modules/ceph/mgr_osd_tree.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-ceph-mgr_osd_tree]]
=== Ceph mgr_osd_tree metricset

beta[]

include::../../../module/ceph/mgr_osd_tree/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-ceph,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/ceph/mgr_osd_tree/_meta/data.json[]
----
23 changes: 23 additions & 0 deletions metricbeat/docs/modules/ceph/mgr_pool_disk.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-ceph-mgr_pool_disk]]
=== Ceph mgr_pool_disk metricset

beta[]

include::../../../module/ceph/mgr_pool_disk/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-ceph,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../module/ceph/mgr_pool_disk/_meta/data.json[]
----
8 changes: 7 additions & 1 deletion metricbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,15 @@ This file is generated! See scripts/mage/docs_collector.go
.2+| .2+| |<<metricbeat-metricset-beat-state,state>>
|<<metricbeat-metricset-beat-stats,stats>>
|<<metricbeat-module-ceph,Ceph>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.7+| .7+| |<<metricbeat-metricset-ceph-cluster_disk,cluster_disk>>
.13+| .13+| |<<metricbeat-metricset-ceph-cluster_disk,cluster_disk>>
|<<metricbeat-metricset-ceph-cluster_health,cluster_health>>
|<<metricbeat-metricset-ceph-cluster_status,cluster_status>>
|<<metricbeat-metricset-ceph-mgr_cluster_disk,mgr_cluster_disk>> beta[]
|<<metricbeat-metricset-ceph-mgr_cluster_health,mgr_cluster_health>> beta[]
|<<metricbeat-metricset-ceph-mgr_osd_perf,mgr_osd_perf>> beta[]
|<<metricbeat-metricset-ceph-mgr_osd_pool_stats,mgr_osd_pool_stats>> beta[]
|<<metricbeat-metricset-ceph-mgr_osd_tree,mgr_osd_tree>> beta[]
|<<metricbeat-metricset-ceph-mgr_pool_disk,mgr_pool_disk>> beta[]
|<<metricbeat-metricset-ceph-monitor_health,monitor_health>>
|<<metricbeat-metricset-ceph-osd_df,osd_df>>
|<<metricbeat-metricset-ceph-osd_tree,osd_tree>>
Expand Down
6 changes: 6 additions & 0 deletions metricbeat/include/list_common.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ HEALTHCHECK --interval=1s --retries=300 \
CMD curl -s -H "Accept: application/json" localhost:5000/api/v0.1/health \
| jq .output.health.health_services[0].mons[0] \
| grep health
EXPOSE 5000

ENV NETWORK_AUTO_DETECT 4
ENV DEMO_DAEMONS osd,rest_api
Expand Down
19 changes: 19 additions & 0 deletions metricbeat/module/ceph/_meta/Dockerfile.nautilus
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
ARG CEPH_VERSION
FROM ceph/daemon:${CEPH_VERSION}

RUN yum -q install -y jq && yum clean all && rm -fr /var/cache/yum

# Wait for the health endpoint to have monitors information
ADD healthcheck.sh /
HEALTHCHECK --interval=1s --retries=300 CMD /healthcheck.sh

EXPOSE 5000 8003 9283

ENV NETWORK_AUTO_DETECT 4
ENV CEPH_DAEMON demo
ENV CEPH_DEMO_UID beats
ENV CEPH_DEMO_BUCKET beats
ENV CEPH_DEMO_ACCESS_KEY demo
ENV CEPH_DEMO_SECRET_KEY demo

CMD ["demo"]
20 changes: 20 additions & 0 deletions metricbeat/module/ceph/_meta/config-mgr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
- module: ceph
metricsets:
- mgr_cluster_health
period: 10s
hosts: [ "https://localhost:8003" ]
#username: "user"
#password: "secret"

- module: ceph
metricsets:
- mgr_cluster_disk
- mgr_cluster_health
- mgr_osd_disk
- mgr_osd_perf
# - mgr_osd_pool_stats
# - mgr_osd_tree
period: 1m
hosts: [ "https://localhost:8003" ]
#username: "user"
#password: "secret"
4 changes: 3 additions & 1 deletion metricbeat/module/ceph/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ the http://docs.ceph.com/docs/master/man/8/ceph-rest-api/[ceph-rest-api]. The de
[float]
=== Compatibility

The Ceph module is tested with Ceph Jewel (10.2.10).
The Ceph module is tested with Ceph Jewel (10.2.10) and Ceph Nautilus (14.2.7).

Metricsets with the `mgr_` prefix are compatible with Ceph releases using the Ceph Manager Daemon.

[float]
=== Dashboard
Expand Down
Loading