DOCSP-29449 add telemetry information (#128)

* DOCSP-29449 add telemetry information

* Staging fixes

* Tracking data

* Staging fixes

* Staging fixes

* Staging fixes

* Review feedback

* Review feedback

* Review feedback

* Review fixes

Author: Dave Cuthbert

source/includes/opts/disableTelemetry.rst

@@ -0,0 +1,4 @@
+Disables the collection of :ref:`telemetry data <c2c-telemetry>` for
+``mongosync``.
+
+.. include:: /includes/opts/telemetry-statement.rst

source/includes/opts/telemetry-statement.rst

@@ -0,0 +1,3 @@
+By default, ``mongosync`` collects anonymous, aggregated usage data to
+improve MongoDB products. When you run ``mongosync`` you can disable
+collection of this telemetry data.

source/reference/configuration.txt

@@ -14,12 +14,12 @@ Configuration
 
 You can configure :program:`mongosync` instances at startup using a
 configuration file.  The configuration file contains settings that are
-the equivalent of ``mongosync`` command-line options.
+the equivalent of ``mongosync`` command line options.
 
 Configuration File
 ==================
 
-Most :program:`mongosync` command-line options can be written to a YAML
+Most :program:`mongosync` command line options can be written to a YAML
 file. The configuration file specifies values for each setting using
 YAML format. 
 
@@ -56,34 +56,48 @@ Options
 
    .. include:: /includes/opts/cluster0.rst
 
-   To set the ``cluster0`` setting from the command-line,
-   see the :option:`--cluster0` option.
+   To set the ``cluster0`` setting from the command line, see the
+   :option:`--cluster0` option.
 
 .. setting:: cluster1
 
    *Type*: string
 
    .. include:: /includes/opts/cluster1.rst
 
-   To set the ``cluster1`` setting from the command-line,
+   To set the ``cluster1`` setting from the command line,
    see the :option:`--cluster1` option.
 
+.. setting:: disableTelemetry
+
+   *Type*: boolean
+
+   .. versionadded:: 1.4.0
+
+   .. include:: /includes/opts/disableTelemetry
+
+   To set the ``disableTelemetry`` setting from the command line,
+   see the :option:`--disableTelemetry` option.
+
+   For more information, see :ref:`User Data Collection
+   <c2c-telemetry>`.
+
 .. setting:: id
 
    *Type*: string
 
    .. include:: /includes/opts/id.rst
 
-   To set the ``id`` setting from the command-line,
-   see the :option:`--id` option.
+   To set the ``id`` setting from the command line, see the
+   :option:`--id` option.
 
 .. setting:: loadLevel
 
    *Type*: integer
 
    .. include:: /includes/opts/loadLevel.rst
 
-   To set the ``loadLevel`` setting from the command-line, see the
+   To set the ``loadLevel`` setting from the command line, see the
    :option:`--loadLevel` option.
 
 .. setting:: logPath
@@ -92,17 +106,17 @@ Options
 
    .. include:: /includes/opts/logPath.rst
 
-   To set the ``logPath`` setting from the command-line,
-   see the :option:`--logPath` option.
+   To set the ``logPath`` setting from the command line, see the
+   :option:`--logPath` option.
 
 .. setting:: port
 
    *Type*: integer
 
    .. include:: /includes/opts/port.rst
 
-   To set the ``port`` setting from the command-line,
-   see the :option:`--port` option.
+   To set the ``port`` setting from the command line, see the
+   :option:`--port` option.
 
 .. setting:: verbosity 
 
@@ -113,5 +127,5 @@ Options
 
    .. include:: /includes/opts/verbosity.rst
 
-   To set the ``verbosity`` setting from the command-line,
-   see the :option:`--verbosity` option.
+   To set the ``verbosity`` setting from the command line, see the
+   :option:`--verbosity` option.

source/reference/mongosync.txt

@@ -63,6 +63,18 @@ Global Options
 
    For more information, see :ref:`c2c-mongosync-config`.
 
+.. option:: --disableTelemetry
+
+   .. versionadded:: 1.4.0
+
+   .. include:: /includes/opts/disableTelemetry
+
+   To set the ``--disableTelemetry`` option from a configuration file,
+   see the :setting:`disableTelemetry` setting.
+
+   For more information, see :ref:`User Data Collection
+   <c2c-telemetry>`.
+
 .. option:: --help, -h
 
    Prints usage information to stdout.

source/reference/telemetry.txt

@@ -0,0 +1,55 @@
+.. _c2c-telemetry:
+
+=========
+Telemetry
+=========
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+
+.. include:: /includes/opts/telemetry-statement.rst
+
+Data Collection
+---------------
+
+The data ``mongosync`` reports includes:
+
+- State information when ``mongosync`` starts, starts committing, or
+  passes through intermediate states
+- Information about the source and destination clusters and the hardware
+  that hosts the ``mongosync`` instance
+- Initialization arguments
+- The number of source and destination writes
+- The estimated number of bytes ``mongosync`` copies
+- The estimated number of events ``mongosync`` applies
+
+``mongosync`` does not track:
+
+- IP addresses
+- Hostnames
+- Usernames
+- Login credentials
+- Connection strings
+- Data stored in MongoDB deployments
+- Personally identifiable information (PII)
+
+For more information, see MongoDB's `Privacy Policy
+<https://www.mongodb.com/legal/privacy-policy?tck=docs_mongosh>`__.
+
+Disable Telemetry Collection
+----------------------------
+
+To disable telemetry collection when you start ``mongosync``, set one of
+the following:
+
+- :setting:`disableTelemetry` in the :ref:`configuration file
+  <c2c-config>`
+- :option:`--disableTelemetry` on the :ref:`command line
+  <c2c-mongosync>`
+