Skip to content

Commit f933c53

Browse files
biniona-mongodbbiniona-mongodb
authored
(DOCSP-25221) - Sink Connector JMX Metrics Table (#19)
1 parent 6b2b0cb commit f933c53

File tree

5 files changed

+203
-3
lines changed

5 files changed

+203
-3
lines changed

‎snooty.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ pipeline-size = "2.4 GB"
2626
stable-api = "Stable API"
2727
default-heartbeat-topic = "__mongodb_heartbeats"
2828
query-api = "MongoDB Query API"
29+
jmx-long = "Java Management Extensions"
30+
jmx-hover = ":abbr:`JMX ({+jmx-long+})`"
2931

3032
write-exception-version="1"
3133
write-concern-exception-version="1"

‎source/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ MongoDB Kafka Connector
1919
Sink Connector </sink-connector>
2020
Source Connector </source-connector>
2121
Security and Authentication </security-and-authentication>
22+
Monitoring and Logging </monitoring-and-logging>
2223
Migrate from the Community Connector <migrate-from-kafka-connect-mongodb>
2324
Troubleshooting </troubleshooting>
2425
How to Contribute </contribute>

‎source/monitoring-and-logging.txt

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,198 @@
1+
.. _kafka-monitoring-logging:
2+
3+
======================
4+
Monitoring and Logging
5+
======================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
16+
17+
18+
Sink Connector JMX Metrics
19+
--------------------------
20+
21+
Use the attributes in the following table to monitor the behavior of your sink
22+
connector through {+jmx-long+} (JMX):
23+
24+
.. tip:: JMX Attributes
25+
26+
{+jmx-hover+} represents an individual metric as an attribute of an ``MBean``.
27+
To learn more about attributes and ``MBeans``, see the
28+
`Standard MBeans Tutorial <https://docs.oracle.com/javase/tutorial/jmx/mbeans/standard.html>`__
29+
from Oracle.
30+
31+
.. list-table::
32+
:header-rows: 1
33+
:widths: 40 60
34+
35+
* - Attribute Name
36+
- Description
37+
38+
* - **records**
39+
- The total number of Kafka records a MongoDB sink task received.
40+
41+
* - **records-successful**
42+
- The total number of Kafka records a MongoDB sink task successfully
43+
wrote to MongoDB.
44+
45+
* - **records-failed**
46+
- The total number of Kafka records a MongoDB sink task failed to write
47+
to MongoDB.
48+
49+
* - **latest-kafka-time-difference-ms**
50+
- The number of milliseconds of the most recent time difference recorded
51+
between a MongoDB sink task and Kafka. This value is calculated by
52+
subtracting the current time of the connector's clock and the timestamp
53+
of the last record the task received.
54+
55+
* - **in-task-put**
56+
- The total number of times the Kafka Connect framework executed the
57+
``put()`` method of the MongoDB sink task.
58+
59+
* - **in-task-put-duration**
60+
- The total number of milliseconds the Kafka Connect framework spent
61+
executing the ``put()`` method of a MongoDB sink task.
62+
63+
* - **in-task-put-duration-over-1-ms**
64+
- The total number of MongoDB sink task ``put()`` method executions
65+
with a duration that exceeded 1 millisecond.
66+
67+
* - **in-task-put-duration-over-10-ms**
68+
- The total number of MongoDB sink task ``put()`` method executions
69+
with a duration that exceeded 10 milliseconds.
70+
71+
* - **in-task-put-duration-over-100-ms**
72+
- The total number of MongoDB sink task ``put()`` method executions
73+
with a duration that exceeded 100 milliseconds.
74+
75+
* - **in-task-put-duration-over-1000-ms**
76+
- The total number of MongoDB sink task ``put()`` method executions
77+
with a duration that exceeded 1000 milliseconds.
78+
79+
* - **in-task-put-duration-over-10000-ms**
80+
- The total number of MongoDB sink task ``put()`` method executions
81+
with a duration that exceeded 10000 milliseconds.
82+
83+
* - **in-connect-framework**
84+
- The total number of times code in the Kafka Connect framework
85+
executed after the first invocation of the ``put()`` method of the
86+
MongoDB sink task.
87+
88+
* - **in-connect-framework-duration**
89+
- The total number of milliseconds spent executing code in the Kafka
90+
Connect framework since the framework first invoked the ``put()``
91+
method of the MongoDB sink task. This metric does not count time
92+
executing code in the MongoDB sink task towards the total.
93+
94+
* - **in-connect-framework-duration-over-1-ms**
95+
- The total number of times code in the Kafka Connect framework
96+
executed for a duration that exceeded 1 millisecond.
97+
98+
* - **in-connect-framework-duration-over-10-ms**
99+
- The total number of times code in the Kafka Connect framework
100+
executed for a duration that exceeded 10 milliseconds.
101+
102+
* - **in-connect-framework-duration-over-100-ms**
103+
- The total number of times code in the Kafka Connect framework
104+
executed for a duration that exceeded 100 milliseconds.
105+
106+
* - **in-connect-framework-duration-over-1000-ms**
107+
- The total number of times code in the Kafka Connect framework executed
108+
for a duration that exceeded 1000 milliseconds.
109+
110+
* - **in-connect-framework-duration-over-10000-ms**
111+
- The total number of times code in the Kafka Connect framework executed
112+
for a duration that exceeded 10000 milliseconds.
113+
114+
* - **processing-phases**
115+
- The total number of times a MongoDB sink task executed the processing
116+
phase on a batch of records from Kafka. The processing phase of a
117+
MongoDB sink task is the set of actions that starts after records are
118+
obtained from Kafka and ends before records are written to MongoDB.
119+
120+
* - **processing-phases-duration**
121+
- The total number of milliseconds a MongoDB sink task spent processing
122+
records before writing them to MongoDB.
123+
124+
* - **processing-phases-duration-over-1-ms**
125+
- The total number of MongoDB sink task processing phase executions with
126+
a duration that exceeded 1 millisecond.
127+
128+
* - **processing-phases-duration-over-10-ms**
129+
- The total number of MongoDB sink task processing phase executions with
130+
a duration that exceeded 10 milliseconds.
131+
132+
* - **processing-phases-duration-over-100-ms**
133+
- The total number of MongoDB sink task processing phase executions with
134+
a duration that exceeded 100 milliseconds.
135+
136+
* - **processing-phases-duration-over-1000-ms**
137+
- The total number of MongoDB sink task processing phase executions with
138+
a duration that exceeded 1000 milliseconds.
139+
140+
* - **processing-phases-duration-over-10000-ms**
141+
- The total number of MongoDB sink task processing phase executions with
142+
a duration that exceeded 10000 milliseconds.
143+
144+
* - **batch-writes-successful**
145+
- The total number of batches a MongoDB sink task successfully wrote
146+
to the MongoDB server.
147+
148+
* - **batch-writes-successful-duration**
149+
- The total number of milliseconds a MongoDB sink task spent successfully
150+
writing to the MongoDB server.
151+
152+
* - **batch-writes-successful-duration-over-1-ms**
153+
- The total number of successful batch writes performed by the MongoDB
154+
sink task with a duration that exceeded 1 millisecond.
155+
156+
* - **batch-writes-successful-duration-over-10-ms**
157+
- The total number of successful batch writes performed by the MongoDB
158+
sink task with a duration that exceeded 10 milliseconds.
159+
160+
* - **batch-writes-successful-duration-over-100-ms**
161+
- The total number of successful batch writes performed by the MongoDB
162+
sink task with a duration that exceeded 100 milliseconds.
163+
164+
* - **batch-writes-successful-duration-over-1000-ms**
165+
- The total number of successful batch writes performed by the MongoDB
166+
sink task with a duration that exceeded 1000 milliseconds.
167+
168+
* - **batch-writes-successful-duration-over-10000-ms**
169+
- The total number of successful batch writes performed by the MongoDB
170+
sink task with a duration that exceeded 10000 milliseconds.
171+
172+
* - **batch-writes-failed**
173+
- The total number of batches a MongoDB sink task failed to write
174+
to the MongoDB server.
175+
176+
* - **batch-writes-failed-duration**
177+
- The total number of milliseconds a MongoDB sink task spent
178+
unsuccessfully attempting to write batches to the MongoDB server.
179+
180+
* - **batch-writes-failed-duration-over-1-ms**
181+
- The total number of failed batch writes attempted by the MongoDB
182+
sink task with a duration that exceeded 1 millisecond.
183+
184+
* - **batch-writes-failed-duration-over-10-ms**
185+
- The total number of failed batch writes attempted by the MongoDB
186+
sink task with a duration that exceeded 10 milliseconds.
187+
188+
* - **batch-writes-failed-duration-over-100-ms**
189+
- The total number of failed batch writes attempted by the MongoDB sink
190+
task with a duration that exceeded 100 milliseconds.
191+
192+
* - **batch-writes-failed-duration-over-1000-ms**
193+
- The total number of failed batch writes attempted by the MongoDB sink
194+
task with a duration that exceeded 1000 milliseconds.
195+
196+
* - **batch-writes-failed-duration-over-10000-ms**
197+
- The total number of failed batch writes attempted by the MongoDB sink
198+
task with a duration that exceeded 10000 milliseconds.

‎source/sink-connector/configuration-properties/all-properties.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,4 +175,3 @@ To view only the options related to time series collections, see the
175175
.. include:: /sink-connector/configuration-properties/time-series.txt
176176
:start-after: sink-configuration-time-series-table-start
177177
:end-before: sink-configuration-time-series-table-end
178-

‎source/source-connector/configuration-properties.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ See the following categories for a list of related configuration properties:
5858
* - :ref:`All Properties <source-configuration-all-properties>`
5959
- View all preceding categories of configuration properties on one page.
6060

61-
See the `Confluent Source Connector configuration documentation <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html>`__
62-
for more information on these settings.
61+
See the `Confluent Source Connector configuration documentation <https://docs.confluent.io/platform/current/installation/configuration/connect/source-connect-configs.html>`__
62+
for more information on these settings.
6363

6464
.. toctree::
6565
:caption: Sink Connector Configuration Properties

0 commit comments

Comments
 (0)