Skip to content

Commit 53bcb94

Browse files
author
Chris Cho
authored
DOCSP-18812: Change Streams Performance (#10)
* DOCSP-188812: Change Streams Performance info
1 parent 811e39e commit 53bcb94

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

source/source-connector/fundamentals/change-streams.txt

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,22 +21,16 @@ used in a {+mkc+} source connector.
2121
Change Streams
2222
--------------
2323

24-
Change streams are a feature of MongoDB that allow you to receive real-time
25-
updates on data changes. Change streams return
26-
**change event documents**. A change event document is a document in your
27-
**oplog** that contains idempotent instructions to recreate a change that
28-
occurred in your MongoDB deployment as well as the metadata related to that
29-
change.
24+
Change streams are a MongoDB feature that allow you to receive real-time
25+
updates on data changes. Change streams return **change event documents**.
3026

31-
The oplog is a special collection in MongoDB that keeps track of all changes
32-
within a MongoDB replica set. Change streams help you use the change event data
33-
stored in the oplog without you having to learn details about how the oplog
34-
works.
27+
A change event document contains idempotent instructions to describe a change
28+
that occurred in your MongoDB deployment and metadata related to that change.
29+
Change event documents are generated from data in the :term:`oplog`.
3530

36-
.. important:: You must have a replica set or a sharded cluster
31+
.. important:: Change streams only run on MongoDB replica sets and sharded clusters
3732

38-
Change streams are available for replica sets and sharded clusters. A
39-
standalone MongoDB instance cannot produce a change stream.
33+
A standalone MongoDB instance cannot produce a change stream.
4034

4135
To view a list of all configuration options for change streams, see the
4236
:ref:`<source-configuration-change-stream>` page.
@@ -88,6 +82,18 @@ descriptions of all fields,
8882
option. For more information, see the :ref:`<source-configuration-change-stream>`
8983
page.
9084

85+
Performance
86+
~~~~~~~~~~~
87+
88+
The oplog is a special capped collection which cannot use indexes. For more
89+
information on this limitation, see
90+
:manual:`Change Streams Production Recommendations </administration/change-streams-production-recommendations/#indexes>`.
91+
92+
If you need to improve change stream performance, use a faster disk for
93+
your MongoDB cluster and increase the size of your WiredTiger cache. To
94+
learn how to set your WiredTiger cache, see the guide on the
95+
:manual:`WiredTiger Storage Engine </core/wiredtiger/#memory-use>`.
96+
9197
Source Connectors
9298
-----------------
9399

0 commit comments

Comments
 (0)