(DOCSP-25294) Port Source Metrics (#21)

biniona-mongodb · web-flow · commit de66d875b3d3 · 2022-09-14T17:23:32.000-04:00
diff --git a/source/monitoring-and-logging.txt b/source/monitoring-and-logging.txt
@@ -15,11 +15,11 @@ Monitoring and Logging
 
 
 
-Sink Connector JMX Metrics
---------------------------
+Available Metrics
+-----------------
 
-Use the attributes in the following table to monitor the behavior of your sink
-connector through {+jmx-long+} (JMX):
+Use the attributes in the tables in this section to monitor the behavior of your source and
+sink connectors through {+jmx-long+} (JMX).
 
 .. tip:: JMX Attributes
 
@@ -28,6 +28,9 @@ connector through {+jmx-long+} (JMX):
    `Standard MBeans Tutorial <https://docs.oracle.com/javase/tutorial/jmx/mbeans/standard.html>`__
    from Oracle.
 
+Sink Connector JMX Metrics
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 .. list-table::
    :header-rows: 1
    :widths: 40 60
@@ -53,11 +56,11 @@ connector through {+jmx-long+} (JMX):
        of the last record the task received.
 
    * - **in-task-put**
-     - The total number of times the Kafka Connect framework executed the
+     - The total number of times the {+kafka-connect+} framework executed the
        ``put()`` method of the MongoDB sink task.
 
    * - **in-task-put-duration**
-     - The total number of milliseconds the Kafka Connect framework spent
+     - The total number of milliseconds the {+kafka-connect+} framework spent
        executing the ``put()`` method of a MongoDB sink task.
 
    * - **in-task-put-duration-over-1-ms**
@@ -81,7 +84,7 @@ connector through {+jmx-long+} (JMX):
        with a duration that exceeded 10000 milliseconds.
 
    * - **in-connect-framework**
-     - The total number of times code in the Kafka Connect framework
+     - The total number of times code in the {+kafka-connect+} framework
        executed after the first invocation of the ``put()`` method of the
        MongoDB sink task.
 
@@ -92,23 +95,23 @@ connector through {+jmx-long+} (JMX):
        executing code in the MongoDB sink task towards the total.
 
    * - **in-connect-framework-duration-over-1-ms**
-     - The total number of times code in the Kafka Connect framework
+     - The total number of times code in the {+kafka-connect+} framework
        executed for a duration that exceeded 1 millisecond.
 
    * - **in-connect-framework-duration-over-10-ms**
-     - The total number of times code in the Kafka Connect framework
+     - The total number of times code in the {+kafka-connect+} framework
        executed for a duration that exceeded 10 milliseconds.
 
    * - **in-connect-framework-duration-over-100-ms**
-     - The total number of times code in the Kafka Connect framework
+     - The total number of times code in the {+kafka-connect+} framework
        executed for a duration that exceeded 100 milliseconds.
 
    * - **in-connect-framework-duration-over-1000-ms**
-     - The total number of times code in the Kafka Connect framework executed
+     - The total number of times code in the {+kafka-connect+} framework executed
        for a duration that exceeded 1000 milliseconds.
 
    * - **in-connect-framework-duration-over-10000-ms**
-     - The total number of times code in the Kafka Connect framework executed
+     - The total number of times code in the {+kafka-connect+} framework executed
        for a duration that exceeded 10000 milliseconds.
 
    * - **processing-phases**
@@ -196,3 +199,215 @@ connector through {+jmx-long+} (JMX):
    * - **batch-writes-failed-duration-over-10000-ms**
      - The total number of failed batch writes attempted by the MongoDB sink
        task with a duration that exceeded 10000 milliseconds.
+
+Source Connector JMX Metrics
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+   :widths: 40 60
+
+   * - Attribute Name
+     - Description
+
+   * - **records**
+     - The total number of records a MongoDB source task passed to the
+       {+kafka-connect+} framework.
+
+   * - **records-filtered**
+     - The number of records a MongoDB source task passed to the
+       {+kafka-connect+} framework that were then filtered by the framework.
+       A filtered record is not written to Kafka.
+
+   * - **records-acknowledged**
+     - The total number of records a MongoDB source task passed to the
+       {+kafka-connect+} framework that were then successfully
+       written to Kafka.
+
+   * - **mongodb-bytes-read**
+     - The total number of bytes a MongoDB source task read from the
+       MongoDB server.
+
+   * - **latest-mongodb-time-difference-secs**
+     - The number of seconds of the most recent time difference recorded between
+       a MongoDB server and the post-batch resume token held by a MongoDB
+       source task. This value is calculated by subtracting the timestamp
+       of the task's post-batch resume token from the ``operationTime`` value of
+       the most recent successful MongoDB command executed by the task.
+
+   * - **in-task-poll**
+     - The total number of times the {+kafka-connect+} framework executed
+       the ``poll()`` method of a MongoDB source task.
+
+   * - **in-task-poll-duration-ms**
+     - The total number of milliseconds the {+kafka-connect+} framework
+       spent executing the ``poll()`` method of a MongoDB source task.
+
+   * - **in-task-poll-duration-over-1-ms**
+     - The total number of MongoDB source task ``poll()`` method executions
+       with a duration that exceeded 1 millisecond.
+
+   * - **in-task-poll-duration-over-10-ms**
+     - The total number of MongoDB source task ``poll()`` method executions
+       with a duration that exceeded 10 milliseconds.
+
+   * - **in-task-poll-duration-over-100-ms**
+     - The total number of MongoDB source task ``poll()`` method executions
+       with a duration that exceeded 100 milliseconds.
+
+   * - **in-task-poll-duration-over-1000-ms**
+     - The total number of MongoDB source task ``poll()`` method executions
+       with a duration that exceeded 1000 milliseconds.
+
+   * - **in-task-poll-duration-over-10000-ms**
+     - The total number of MongoDB source task ``poll()`` method executions
+       with a duration that exceeded 10000 milliseconds.
+
+   * - **in-connect-framework**
+     - The total number of times code in the {+kafka-connect+} framework
+       executed after the first invocation of the ``poll()`` method of the
+       MongoDB source task.
+
+   * - **in-connect-framework-duration-ms**
+     - The total number of milliseconds spent executing code in the
+       {+kafka-connect+} framework since the framework first invoked the
+       ``poll()`` method of the MongoDB source task. This metric does
+       not count time executing code in the MongoDB sink task towards the total.
+
+   * - **in-connect-framework-duration-over-1-ms**
+     - The total number of times code in the {+kafka-connect+} framework
+       executed for a duration that exceeded 1 millisecond.
+
+   * - **in-connect-framework-duration-over-10-ms**
+     - The total number of times code in the {+kafka-connect+} framework
+       executed for a duration that exceeded 10 milliseconds.
+
+   * - **in-connect-framework-duration-over-100-ms**
+     - The total number of times code in the {+kafka-connect+} framework
+       executed for a duration that exceeded 100 milliseconds.
+
+   * - **in-connect-framework-duration-over-1000-ms**
+     - The total number of times code in the {+kafka-connect+} framework
+       executed for a duration that exceeded 1000 milliseconds.
+
+   * - **in-connect-framework-duration-over-10000-ms**
+     - The total number of times code in the {+kafka-connect+} framework
+       executed for a duration that exceeded 10000 milliseconds.
+
+   * - **initial-commands-successful**
+     - The total number of initial commands issued by a MongoDB source
+       task that succeeded. An initial command is a find or aggregate command
+       sent to a MongoDB server that retrieves the first set of documents in a
+       cursor. A ``getMore`` command is not an initial command.
+
+   * - **initial-commands-successful-duration-ms**
+     - The total number of milliseconds a MongoDB source task spent executing
+       initial commands that succeeded.
+
+   * - **initial-commands-successful-duration-over-1-ms**
+     - The total number of successful initial commands issued by a MongoDB
+       source task with a duration that exceeded 1 millisecond.
+
+   * - **initial-commands-successful-duration-over-10-ms**
+     - The total number of successful initial commands issued by a MongoDB
+       source task with a duration that exceeded 10 milliseconds. 
+
+   * - **initial-commands-successful-duration-over-100-ms**
+     - The total number of successful initial commands issued by a MongoDB
+       source task with a duration that exceeded 100 milliseconds.
+
+   * - **initial-commands-successful-duration-over-1000-ms**
+     - The total number of successful initial commands issued by a MongoDB
+       source task with a duration that exceeded 1000 milliseconds.
+
+   * - **initial-commands-successful-duration-over-10000-ms**
+     - The total number of successful initial commands issued by a MongoDB
+       source task with a duration that exceeded 10000 milliseconds.
+
+   * - **getmore-commands-successful**
+     - The total number of ``getMore`` commands issued by a MongoDB source
+       task that succeeded.
+
+   * - **getmore-commands-successful-duration-ms**
+     - The total number of milliseconds a MongoDB source task spent executing
+       ``getMore`` commands that succeeded.
+
+   * - **getmore-commands-successful-duration-over-1-ms**
+     - The total number of successful ``getMore`` commands issued by a
+       MongoDB source task with a duration that exceeded 1 millisecond.
+
+   * - **getmore-commands-successful-duration-over-10-ms**
+     - The total number of successful ``getMore`` commands issued by a MongoDB
+       source task with a duration that exceeded 10 milliseconds.
+
+   * - **getmore-commands-successful-duration-over-100-ms**
+     - The total number of successful ``getMore`` commands issued by a MongoDB
+       source task with a duration that exceeded 100 milliseconds.
+
+   * - **getmore-commands-successful-duration-over-1000-ms**
+     - The total number of successful ``getMore`` commands issued by a
+       MongoDB source task with a duration that exceeded 1000 milliseconds.
+
+   * - **getmore-commands-successful-duration-over-10000-ms**
+     - The total number of successful ``getMore`` commands issued by a MongoDB
+       source task with a duration that exceeded 10000 milliseconds.
+
+   * - **initial-commands-failed**
+     - The total number of initial commands issued by a MongoDB source
+       task that failed. An initial command is a find or aggregate command
+       sent to a MongoDB server that retrieves the first set of documents in a
+       cursor. A ``getMore`` command is not an initial command.
+
+   * - **initial-commands-failed-duration-ms**
+     - The total number of milliseconds a MongoDB source task spent
+       unsuccessfully attempting to issue initial commands to the MongoDB
+       server.
+
+   * - **initial-commands-failed-duration-over-1-ms**
+     - The total number of failed initial commands issued by a MongoDB
+       source task with a duration that exceeded 1 millisecond.
+
+   * - **initial-commands-failed-duration-over-10-ms**
+     - The total number of failed initial commands issued by a
+       MongoDB source task with a duration that exceeded 10 milliseconds.
+
+   * - **initial-commands-failed-duration-over-100-ms**
+     - The total number of failed initial commands issued by a MongoDB source
+       task with a duration that exceeded 100 milliseconds.
+
+   * - **initial-commands-failed-duration-over-1000-ms**
+     - The total number of failed initial commands issued by a MongoDB source
+       task with a duration that exceeded 1000 milliseconds.
+
+   * - **initial-commands-failed-duration-over-10000-ms**
+     - The total number of failed initial commands issued by a MongoDB
+       source task with a duration that exceeded 10000 milliseconds.
+
+   * - **getmore-commands-failed**
+     - The total number of ``getMore`` commands issued by a MongoDB source
+       task that failed.
+
+   * - **getmore-commands-failed-duration-ms**
+     - The total number of milliseconds a MongoDB source task spent
+       unsuccessfully attempting to issue ``getMore`` commands to the MongoDB
+       server.
+
+   * - **getmore-commands-failed-duration-over-1-ms**
+     - The total number of failed ``getMore`` commands issued by a MongoDB source
+       task with a duration that exceeded 1 millisecond.
+
+   * - **getmore-commands-failed-duration-over-10-ms**
+     - The total number of failed ``getMore`` commands issued by a MongoDB source
+       task with a duration that exceeded 10 milliseconds.
+
+   * - **getmore-commands-failed-duration-over-100-ms**
+     - The total number of failed ``getMore`` commands issued by a MongoDB source
+       task with a duration that exceeded 100 milliseconds.
+
+   * - **getmore-commands-failed-duration-over-1000-ms**
+     - The total number of failed ``getMore`` commands issued by a MongoDB source
+       task with a duration that exceeded 1000 milliseconds.
+
+   * - **getmore-commands-failed-duration-over-10000-ms**
+     - The total number of failed ``getMore`` commands issued by a MongoDB
+       source task with a duration that exceeded 10000 milliseconds.
