Skip to content

Commit 6f6cc29

Browse files
authored
(DOCSP-51331) changeEvent timestamp fields (#13091)
* (DOCSP-51331) changeEvent timestamp fields - Add warning to not modify certain expected fields * (DOCSP-51331) Copy review. * (DOCSP-51331) Create include - Break change event time fields info into includes file. - Reframe info as an 'important' directive
1 parent a940ab8 commit 6f6cc29

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

content/atlas/source/atlas-stream-processing/sp-agg-source.txt

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
.. _streams-agg-pipeline-source:
21
.. _atlas-sp-agg-source:
32

43
========================================
@@ -411,8 +410,12 @@ The ``$source`` stage takes a document with the following fields:
411410
- document
412411
- Optional
413412
- Specifies an aggregation pipeline to filter change stream output
414-
at the point of origin. This pipeline must conform to the parameters
415-
described in :manual:`Modify Change Stream Output </changeStreams/#modify-change-stream-output>`.
413+
before passing it on for further processing. This pipeline must
414+
conform to the parameters described in
415+
:manual:`Modify Change Stream Output
416+
</changeStreams/#modify-change-stream-output>`.
417+
418+
.. include:: /includes/atlas-stream-processing/change-event-time.rst
416419

417420
* - ``config.maxAwaitTimeMS``
418421
- integer
@@ -603,6 +606,8 @@ The ``$source`` stage takes a document with the following fields:
603606
at the point of origin. This pipeline must conform to the parameters
604607
described in :manual:`Modify Change Stream Output </changeStreams/#modify-change-stream-output>`.
605608

609+
.. include:: /includes/atlas-stream-processing/change-event-time.rst
610+
606611
* - ``config.maxAwaitTimeMS``
607612
- integer
608613
- Optional
@@ -779,6 +784,11 @@ The ``$source`` stage takes a document with the following fields:
779784
at the point of origin. This pipeline must conform to the parameters
780785
described in :ref:`<change-stream-modify-output>`.
781786

787+
Note that {+atlas-sp+} expects to receive the ``wallTime`` and
788+
``clusterTime`` fields from each ingested Change Event. To
789+
ensure proper processing of Change Stream data, do not modify
790+
these fields in ``$source.config.pipeline``.
791+
782792
* - ``config.maxAwaitTimeMS``
783793
- integer
784794
- Optional
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. important::
2+
Each Change Event includes ``wallTime`` and ``clusterTime``
3+
fields. {+atlas-sp+} stages after ``$source`` expect to receive
4+
these fields as the processor ingested them. To ensure proper
5+
processing of Change Stream data, do not modify these fields in
6+
``$source.config.pipeline``.

0 commit comments

Comments
 (0)