Merge pull request #21982 from tchaikov/mgr-brag

mgr/telemetry: Add Ceph Telemetry module to send reports back to project
ceph · May 21, 2018 · 7f04b17 · 7f04b17
2 parents ec418e0 + 394b100
commit 7f04b17
Show file tree

Hide file tree

Showing 42 changed files with 478 additions and 1,632 deletions.
diff --git a/ceph.spec.in b/ceph.spec.in
@@ -1156,7 +1156,6 @@ fi
 %{_bindir}/rbd-replay-prep
 %endif
 %{_bindir}/ceph-post-file
-%{_bindir}/ceph-brag
 %{_tmpfilesdir}/ceph-common.conf
 %{_mandir}/man8/ceph-authtool.8*
 %{_mandir}/man8/ceph-conf.8*

diff --git a/debian/ceph-common.install b/debian/ceph-common.install
@@ -21,7 +21,6 @@ usr/bin/rbd
 usr/bin/rbdmap
 usr/bin/rbd-replay*
 usr/bin/ceph-post-file
-usr/bin/ceph-brag
 usr/sbin/mount.ceph sbin
 usr/lib/ceph/compressor/*
 usr/lib/ceph/crypto/* [amd64]

diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst
@@ -36,3 +36,4 @@ sensible.
     Influx plugin <influx>
     Hello plugin <hello>
     Telegraf plugin <telegraf>
+    Telemetry plugin <telemetry>
diff --git a/doc/mgr/telemetry.rst b/doc/mgr/telemetry.rst
@@ -0,0 +1,36 @@
+Telemetry plugin
+================
+The telemetry plugin sends anonymous data about the cluster, in which it is running, back to the Ceph project.
+
+The data being sent back to the project does not contain any sensitive data like pool names, object names, object contents or hostnames.
+
+It contains counters and statistics on how the cluster has been deployed, the version of Ceph, the distribition of the hosts and other parameters which help the project to gain a better understanding of the way Ceph is used.
+
+Data is sent over HTTPS to *telemetry.ceph.com*
+
+Enabling
+--------
+
+The *telemetry* module is enabled with::
+
+  ceph mgr module enable telemetry
+
+
+Interval
+--------
+The module compiles and sends a new report every 72 hours by default.
+
+Contact and Description
+-----------------------
+A contact and description can be added to the report, this is optional.
+
+  ceph telemetry config-set contact 'John Doe <john.doe@example.com>'
+  ceph telemetry config-set description 'My first Ceph cluster'
+
+Show report
+-----------
+The report is sent in JSON format, and can be printed::
+
+  ceph telemetry show
+
+So you can inspect the content if you have privacy concerns.
diff --git a/qa/tasks/mgr/test_module_selftest.py b/qa/tasks/mgr/test_module_selftest.py
@@ -55,6 +55,9 @@ def test_selftest_run(self):
         self._load_module("selftest")
         self.mgr_cluster.mon_manager.raw_cluster_cmd("mgr", "self-test", "run")
 
+    def test_telemetry(self):
+        self._selftest_plugin("telemetry")
+
     def test_selftest_config_update(self):
         """
         That configuration updates are seen by running mgr modules

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -1100,8 +1100,6 @@ configure_file(
   ${CMAKE_BINARY_DIR}/include/acconfig.h
 )
 
-add_subdirectory(brag)
-
 # Everything you need to spin up a cluster with vstart.sh
 add_custom_target(vstart-base DEPENDS
     ceph-osd

diff --git a/src/brag/CMakeLists.txt b/src/brag/CMakeLists.txt
diff --git a/src/brag/README.md b/src/brag/README.md