Skip to content

Commit 0c3813e

Browse files
authored
[Kafka] Terminology update - use MongoDB cluster instead of server (#150)
* change MongoDB server mentions to MongoDB cluster using a constant
1 parent 0194e84 commit 0c3813e

File tree

10 files changed

+64
-14
lines changed

10 files changed

+64
-14
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,4 @@ mongodb-port-mapping="35001"
4545
jmx-port-mapping="35000"
4646
sandbox-directory="kafka-edu/docs-examples/mongodb-kafka-base/"
4747
win-sandbox-directory="kafka-edu\\docs-examples\\mongodb-kafka-base\\"
48+
cluster = "MongoDB cluster"

source/compatibility.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Compatibility
55
=============
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: version, backwards, conflict, platforms
13+
714
MongoDB Compatibility
815
---------------------
916

source/facets.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[[facets]]
2+
category = "target_product"
3+
value = "kafka-connector"

source/monitoring.txt

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Monitoring
55
==========
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: logging, audit, metrics
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -509,11 +516,11 @@ Sink Connector JMX Metrics
509516

510517
* - **batch-writes-successful**
511518
- The total number of batches a MongoDB sink task successfully wrote
512-
to the MongoDB server.
519+
to the {+cluster+}.
513520

514521
* - **batch-writes-successful-duration-ms**
515522
- The total number of milliseconds a MongoDB sink task spent successfully
516-
writing to the MongoDB server.
523+
writing to the {+cluster+}.
517524

518525
* - **batch-writes-successful-duration-over-1-ms**
519526
- The total number of successful batch writes performed by the MongoDB
@@ -537,11 +544,11 @@ Sink Connector JMX Metrics
537544

538545
* - **batch-writes-failed**
539546
- The total number of batches a MongoDB sink task failed to write
540-
to the MongoDB server.
547+
to the {+cluster+}.
541548

542549
* - **batch-writes-failed-duration-ms**
543550
- The total number of milliseconds a MongoDB sink task spent
544-
unsuccessfully attempting to write batches to the MongoDB server.
551+
unsuccessfully attempting to write batches to the {+cluster+}.
545552

546553
* - **batch-writes-failed-duration-over-1-ms**
547554
- The total number of failed batch writes attempted by the MongoDB
@@ -603,7 +610,7 @@ Source Connector JMX Metrics
603610

604611
* - **mongodb-bytes-read**
605612
- The total number of bytes a MongoDB source task read from the
606-
MongoDB server.
613+
{+cluster+}.
607614

608615
.. _kafka-monitoring-averge-record-size-span:
609616

@@ -621,7 +628,7 @@ Source Connector JMX Metrics
621628

622629
* - **latest-mongodb-time-difference-secs**
623630
- The number of seconds of the most recent time difference recorded between
624-
a MongoDB server and the post-batch resume token held by a MongoDB
631+
a {+cluster+} and the post-batch resume token held by a MongoDB
625632
source task. This value is calculated by subtracting the timestamp
626633
of the task's post-batch resume token from the ``operationTime`` value of
627634
the most recent successful MongoDB command executed by the task.
@@ -688,7 +695,7 @@ Source Connector JMX Metrics
688695
* - **initial-commands-successful**
689696
- The total number of initial commands issued by a MongoDB source
690697
task that succeeded. An initial command is a find or aggregate command
691-
sent to a MongoDB server that retrieves the first set of documents in a
698+
sent to a {+cluster+} that retrieves the first set of documents in a
692699
cursor. A ``getMore`` command is not an initial command.
693700

694701
* - **initial-commands-successful-duration-ms**
@@ -746,7 +753,7 @@ Source Connector JMX Metrics
746753
* - **initial-commands-failed**
747754
- The total number of initial commands issued by a MongoDB source
748755
task that failed. An initial command is a find or aggregate command
749-
sent to a MongoDB server that retrieves the first set of documents in a
756+
sent to a {+cluster+} that retrieves the first set of documents in a
750757
cursor. A ``getMore`` command is not an initial command.
751758

752759
* - **initial-commands-failed-duration-ms**

source/security-and-authentication/mongodb-aws-auth.txt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
MongoDB AWS-based Authentication
55
================================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: AWS, IAM, credentials
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -24,8 +31,8 @@ AWS IAM credentials, see the guide on :atlas:`How to Set Up Unified AWS Access <
2431

2532
.. important::
2633

27-
You must use {+connector+} version 1.5 of later to connect to a MongoDB
28-
server set up to authenticate using your AWS IAM credentials. AWS IAM
34+
You must use {+connector+} version 1.5 of later to connect to a {+cluster+}
35+
set up to authenticate using your AWS IAM credentials. AWS IAM
2936
credential authentication is available in MongoDB server version 4.4
3037
and later.
3138

source/sink-connector/configuration-properties/time-series.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
Kafka Time Series Properties
55
============================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
711
.. contents:: On this page
812
:local:
913
:backlinks: none
@@ -137,7 +141,7 @@ Settings
137141
| **Description:**
138142
| The expected interval between subsequent measurements of your
139143
source data. For more information on this setting, see the
140-
MongoDB Server Manual page on :manual:`Granularity for Time
144+
MongoDB server manual page on :manual:`Granularity for Time
141145
Series Data </core/timeseries/timeseries-granularity/>`.
142146
|
143147
| *Optional*

source/source-connector/configuration-properties/mongodb-connection.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
MongoDB Source Connection Properties
55
====================================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: communicate
13+
714
.. contents:: On this page
815
:local:
916
:backlinks: none
@@ -81,7 +88,7 @@ Settings
8188
| **Description:**
8289
| The {+stable-api+} version you want to use with your MongoDB
8390
cluster. For more information on the {+stable-api+} and versions of
84-
MongoDB Server that support it, see the :manual:`{+stable-api+} </reference/stable-api/>`
91+
MongoDB server that support it, see the :manual:`{+stable-api+} </reference/stable-api/>`
8592
guide.
8693
|
8794
| **Default**: ``""``

source/source-connector/usage-examples/custom-pipeline.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@
44
Customize a Pipeline to Filter Change Events
55
============================================
66

7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: code example, aggregate, publishing
13+
714
This usage example demonstrates how to configure a **pipeline** to
815
customize the data that your {+source-connector+} consumes. A pipeline is a
916
MongoDB aggregation pipeline composed of instructions to the database to
@@ -12,7 +19,7 @@ filter or transform data.
1219
MongoDB notifies the connector of data changes that match your aggregation
1320
pipeline on a **change stream**. A change stream is a sequence of events that
1421
describe data changes a client made to a MongoDB deployment in real-time.
15-
For more information, see the MongoDB Server manual entry on
22+
For more information, see the MongoDB server manual entry on
1623
:manual:`Change Streams </changeStreams/>`.
1724

1825

source/tutorials/facets.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
2+
[[facets]]
3+
category = "genre"
4+
value = "tutorial"

source/tutorials/tutorial-setup.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
Kafka Connector Tutorial Setup
55
==============================
66

7+
.. meta::
8+
:keywords: environment, ports
9+
710
The tutorials in this section run on a development environment using Docker to
811
package the dependencies and configurations required to run the
912
{+connector-long+}. Make sure you complete the development environment setup
@@ -122,7 +125,7 @@ Set Up Your Development Environment with Docker
122125

123126
.. tip:: Connect To Development Environment MongoDB
124127

125-
You can connect to the MongoDB server running in your
128+
You can connect to the {+cluster+} running in your
126129
development environment with the following connection string:
127130

128131
.. code-block:: text

0 commit comments

Comments
 (0)