-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
replSetGetStatus.txt
953 lines (728 loc) · 35.3 KB
/
replSetGetStatus.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
================
replSetGetStatus
================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. dbcommand:: replSetGetStatus
The ``replSetGetStatus`` command returns the status of the replica
set from the point of view of the server that processed the command.
``replSetGetStatus`` must be run against the :term:`admin database`.
The command has the following prototype form:
.. code-block:: javascript
db.adminCommand( { replSetGetStatus: 1 } )
Starting in MongoDB 3.4, when running on a :doc:`secondary
</core/replica-set-secondary>` member, you can optionally include
``initialSync: 1`` to return :ref:`initial sync
<replica-set-initial-sync>` status information:
.. code-block:: javascript
db.adminCommand( { replSetGetStatus: 1, initialSync: 1 } )
Data provided by this command derives from data included in
heartbeats sent to the server by other members of the replica set.
Because of the frequency of heartbeats, these data can be several
seconds out of date.
The :binary:`~bin.mongo` shell provides the :method:`rs.status()`
helper; however, you cannot specify the ``initialSync: 1`` option
using the helper.
The :binary:`~bin.mongod` instance must have replication enabled and be a
member of a replica set for :dbcommand:`replSetGetStatus` to return
successfully.
.. _rs-status-output:
Example
-------
.. tabs::
tabs:
- id: primary
name: Primary
content: |
The following example runs the :dbcommand:`replSetGetStatus`
command on the :term:`admin database` of the replica set
primary:
.. code-block:: javascript
db.adminCommand( { replSetGetStatus : 1 } )
The command returns the following output for an example replica set primary:
.. code-block:: javascript
{
"set" : "replset",
"date" : ISODate("2018-12-06T16:57:52.480Z"),
"myState" : 1,
"term" : NumberLong(1),
"syncingTo" : "",
"syncSourceHost" : "",
"syncSourceId" : -1,
"heartbeatIntervalMillis" : NumberLong(2000),
"optimes" : {
"lastCommittedOpTime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"readConcernMajorityOpTime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"appliedOpTime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"durableOpTime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
}
},
"members" : [
{
"_id" : 0,
"name" : "m1.example.net:27017",
"health" : 1,
"state" : 1,
"stateStr" : "PRIMARY",
"uptime" : 123,
"optime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"optimeDate" : ISODate("2018-12-06T16:57:51Z"),
"syncingTo" : "",
"syncSourceHost" : "",
"syncSourceId" : -1,
"infoMessage" : "could not find member to sync from",
"electionTime" : Timestamp(1544115363, 1),
"electionDate" : ISODate("2018-12-06T16:56:03Z"),
"configVersion" : 1,
"self" : true,
"lastHeartbeatMessage" : ""
},
{
"_id" : 1,
"name" : "m2.example.net:27017",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 120,
"optime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"optimeDurable" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"optimeDate" : ISODate("2018-12-06T16:57:51Z"),
"optimeDurableDate" : ISODate("2018-12-06T16:57:51Z"),
"lastHeartbeat" : ISODate("2018-12-06T16:57:51.963Z"),
"lastHeartbeatRecv" : ISODate("2018-12-06T16:57:52.082Z"),
"pingMs" : NumberLong(0),
"lastHeartbeatMessage" : "",
"syncingTo" : "m1.example.net:27017",
"syncSourceHost" : "m1.example.net:27017",
"syncSourceId" : 0,
"infoMessage" : "",
"configVersion" : 1
},
{
"_id" : 2,
"name" : "m3.example.net:27017",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 120,
"optime" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"optimeDurable" : {
"ts" : Timestamp(1544115471, 2),
"t" : NumberLong(1)
},
"optimeDate" : ISODate("2018-12-06T16:57:51Z"),
"optimeDurableDate" : ISODate("2018-12-06T16:57:51Z"),
"lastHeartbeat" : ISODate("2018-12-06T16:57:51.963Z"),
"lastHeartbeatRecv" : ISODate("2018-12-06T16:57:52.082Z"),
"pingMs" : NumberLong(0),
"lastHeartbeatMessage" : "",
"syncingTo" : "m1.example.net:27017",
"syncSourceHost" : "m1.example.net:27017",
"syncSourceId" : 0,
"infoMessage" : "",
"configVersion" : 1
}
],
"ok" : 1,
"operationTime" : Timestamp(1544115471, 2),
"$clusterTime" : {
"clusterTime" : Timestamp(1544115471, 2),
"signature" : {
"hash" : BinData(0,"aE8X8Wcbyp0Begv7aPnhlkDa1/0="),
"keyId" : NumberLong("6631924993926103041")
}
}
}
- id: secondary
name: Secondary
content: |
The following example runs the :dbcommand:`replSetGetStatus`
command on the :term:`admin database` of the replica set
primary. In this example, the optional ``initialSync: 1`` is
included in the command (you can omit if you do not want to
return the initial sync status):
.. code-block:: javascript
db.adminCommand( { replSetGetStatus : 1, initialSync: 1 } )
The command returns the following output for an example replica set secondary:
.. code-block:: javascript
{
"set" : "replset",
"date" : ISODate("2018-12-06T17:16:20.037Z"),
"myState" : 2,
"term" : NumberLong(1),
"syncingTo" : "m2.example.net:27017",
"syncSourceHost" : "m2.example.net:27017",
"syncSourceId" : 1,
"heartbeatIntervalMillis" : NumberLong(2000),
"optimes" : {
"lastCommittedOpTime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"readConcernMajorityOpTime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"appliedOpTime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"durableOpTime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
}
},
"initialSyncStatus" : {
"failedInitialSyncAttempts" : 0,
"maxFailedInitialSyncAttempts" : 10,
"initialSyncStart" : ISODate("2018-12-06T17:15:57.546Z"),
"initialSyncEnd" : ISODate("2018-12-06T17:15:58.221Z"),
"initialSyncElapsedMillis" : 675,
"initialSyncAttempts" : [
{
"durationMillis" : 439,
"status" : "OK",
"syncSource" : "m2.example.net:27017"
}
],
"fetchedMissingDocs" : 0,
"appliedOps" : 0,
"initialSyncOplogStart" : Timestamp(1544116550, 2),
"initialSyncOplogEnd" : Timestamp(1544116550, 2),
"databases" : {
"databasesCloned" : 3,
"admin" : {
"collections" : 4,
"clonedCollections" : 4,
"start" : ISODate("2018-12-06T17:15:57.783Z"),
"end" : ISODate("2018-12-06T17:15:58.031Z"),
"elapsedMillis" : 248,
"admin.system.roles" : {
"documentsToCopy" : 1,
"documentsCopied" : 1,
"indexes" : 2,
"fetchedBatches" : 1,
"start" : ISODate("2018-12-06T17:15:57.784Z"),
"end" : ISODate("2018-12-06T17:15:57.862Z"),
"elapsedMillis" : 78
},
...
},
...
"test" : {
"collections" : 1,
"clonedCollections" : 1,
"start" : ISODate("2018-12-06T17:15:58.155Z"),
"end" : ISODate("2018-12-06T17:15:58.208Z"),
"elapsedMillis" : 53,
"test.foo" : {
"documentsToCopy" : 3,
"documentsCopied" : 3,
"indexes" : 1,
"fetchedBatches" : 1,
"start" : ISODate("2018-12-06T17:15:58.157Z"),
"end" : ISODate("2018-12-06T17:15:58.208Z"),
"elapsedMillis" : 51
}
}
}
},
"members" : [
{
"_id" : 0,
"name" : "m1.example.net:27017",
"health" : 1,
"state" : 1,
"stateStr" : "PRIMARY",
"uptime" : 22,
"optime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"optimeDurable" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"optimeDate" : ISODate("2018-12-06T17:16:15Z"),
"optimeDurableDate" : ISODate("2018-12-06T17:16:15Z"),
"lastHeartbeat" : ISODate("2018-12-06T17:16:18.307Z"),
"lastHeartbeatRecv" : ISODate("2018-12-06T17:16:19.420Z"),
"pingMs" : NumberLong(0),
"lastHeartbeatMessage" : "",
"syncingTo" : "",
"syncSourceHost" : "",
"syncSourceId" : -1,
"infoMessage" : "",
"electionTime" : Timestamp(1544115363, 1),
"electionDate" : ISODate("2018-12-06T16:56:03Z"),
"configVersion" : 1
},
{
"_id" : 1,
"name" : "m2.example.net:27017",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 22,
"optime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"optimeDurable" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"optimeDate" : ISODate("2018-12-06T17:16:15Z"),
"optimeDurableDate" : ISODate("2018-12-06T17:16:15Z"),
"lastHeartbeat" : ISODate("2018-12-06T17:16:18.307Z"),
"lastHeartbeatRecv" : ISODate("2018-12-06T17:16:19.421Z"),
"pingMs" : NumberLong(0),
"lastHeartbeatMessage" : "",
"syncingTo" : "m1.example.net:27017",
"syncSourceHost" : "m1.example.net:27017",
"syncSourceId" : 0,
"infoMessage" : "",
"configVersion" : 1
},
{
"_id" : 2,
"name" : "m3.example.net:27017",
"health" : 1,
"state" : 2,
"stateStr" : "SECONDARY",
"uptime" : 24,
"optime" : {
"ts" : Timestamp(1544116575, 1),
"t" : NumberLong(1)
},
"optimeDate" : ISODate("2018-12-06T17:16:15Z"),
"syncingTo" : "m2.example.net:27017",
"syncSourceHost" : "m2.example.net:27017",
"syncSourceId" : 1,
"infoMessage" : "",
"configVersion" : 1,
"self" : true,
"lastHeartbeatMessage" : ""
}
],
"ok" : 1
}
Output
------
The :command:`replSetGetStatus` command returns a document with the
following fields:
.. data:: replSetGetStatus.set
The ``set`` value is the name of the replica set, configured in the
:setting:`~replication.replSetName` setting. This is the same value as
:rsconf:`_id` in :method:`rs.conf()`.
.. data:: replSetGetStatus.date
An :term:`ISODate` formatted date and time that reflects the current
time according to the server that processed the
:command:`replSetGetStatus` command. Compare this to the values of
:data:`replSetGetStatus.members[n].lastHeartbeat` to find the
operational latency between this server and the other members of the
replica set.
.. data:: replSetGetStatus.myState
An integer between ``0`` and ``10`` that represents the :doc:`replica
state </reference/replica-states>` of the current member.
.. data:: replSetGetStatus.term
.. versionadded:: 3.2
The election count for the replica set, as known to this replica set
member. The :data:`~replSetGetStatus.term` is used by the
distributed consensus algorithm to ensure correctness.
If using :rsconf:`protocolVersion: 0 <protocolVersion>`, instead of
:rsconf:`protocolVersion: 1 <protocolVersion>`, returns ``-1``.
.. data:: replSetGetStatus.syncingTo
.. deprecated:: 3.6.6, 3.4.16
Starting in MongoDB 3.6.6 (and 3.4.16), MongoDB deprecates
:data:`~replSetGetStatus.syncingTo`. See
:data:`replSetGetStatus.syncSourceHost` instead.
The ``syncingTo`` field holds the hostname of the member from
which this instance syncs. If this instance is a primary, returns
an empty string ``""``.
.. data:: replSetGetStatus.syncSourceHost
.. versionadded:: 3.6.6, 3.4.16
The :data:`~replSetGetStatus.syncSourceHost` field holds the
hostname of the member from which this instance syncs.
If this instance is a primary,
:data:`~replSetGetStatus.syncSourceHost` is an empty string and
the :data:`~replSetGetStatus.syncSourceId` ``-1``.
.. data:: replSetGetStatus.syncSourceId
.. versionadded:: 3.6.6, 3.4.16
The :data:`~replSetGetStatus.syncSourceId` field holds the
:data:`replSetGetStatus.members[n]._id` of the member from which
this instance syncs.
If this instance is a primary,
:data:`~replSetGetStatus.syncSourceHost` is an empty string and
the :data:`~replSetGetStatus.syncSourceId` ``-1``.
.. data:: replSetGetStatus.heartbeatIntervalMillis
.. versionadded:: 3.2
The frequency in milliseconds of the heartbeats.
.. data:: replSetGetStatus.optimes
.. versionadded:: 3.4
The ``optimes`` field holds a document that contains
:term:`optimes <optime>` used to inspect replication progress.
.. data:: replSetGetStatus.optimes.lastCommittedOpTime
Information, from the viewpoint of this member, regarding the
most recent operation that has been written to a majority of
replica set members.
The value is a document that contains:
- ``ts``, the :ref:`Timestamp <document-bson-type-timestamp>` of
the operation.
- ``t``, the :data:`~replSetGetStatus.term` in which the
operation was originally generated on the primary.
If using :rsconf:`protocolVersion: 0 <protocolVersion>`, ``t``
is equal to ``-1``.
.. data:: replSetGetStatus.optimes.readConcernMajorityOpTime
Information, from the viewpoint of this member, regarding the
most recent operation that can fulfill read concern
:readconcern:`"majority"` queries; i.e. the most recent
:data:`~replSetGetStatus.optimes.lastCommittedOpTime` that can
fulfill :readconcern:`"majority"` queries.
:data:`~replSetGetStatus.optimes.readConcernMajorityOpTime` is
either less than or equal to
:data:`~replSetGetStatus.optimes.lastCommittedOpTime`.
The value is a document that contains:
- ``ts``, the :ref:`Timestamp <document-bson-type-timestamp>` of
the operation.
- ``t``, the :data:`~replSetGetStatus.term` in which the
operation was originally generated on the primary.
If using :rsconf:`protocolVersion: 0 <protocolVersion>`, ``t``
is equal to ``-1``.
.. data:: replSetGetStatus.optimes.appliedOpTime
Information, from the viewpoint of this member, regarding the
most recent operation that has been applied to this member of the
replica set.
For :rsconf:`protocolVersion: 1 <protocolVersion>`, the value is
a document that contains:
- ``ts``, the :ref:`Timestamp <document-bson-type-timestamp>` of
the operation.
- ``t``, the :data:`~replSetGetStatus.term` in which the
operation was originally generated on the primary.
For :rsconf:`protocolVersion: 0 <protocolVersion>`, the value is
the :ref:`Timestamp <document-bson-type-timestamp>` of the
operation.
.. data:: replSetGetStatus.optimes.durableOpTime
Information,, from the viewpoint of this member, regarding the
most recent operation that has been written to the journal of
this member of the replica set.
For :rsconf:`protocolVersion: 1 <protocolVersion>`, the value is
a document that contains:
- ``ts``, the :ref:`Timestamp <document-bson-type-timestamp>` of
the operation.
- ``t``, the :data:`~replSetGetStatus.term` in which the
operation was originally generated on the primary.
For :rsconf:`protocolVersion: 0 <protocolVersion>`, the value is
the :ref:`Timestamp <document-bson-type-timestamp>` of the
operation.
.. data:: replSetGetStatus.initialSyncStatus
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
A document provides information on the progress and status of
:ref:`initial sync <replica-set-initial-sync>` on this secondary.
.. note::
Some fields that relate to the progress of an on-going initial
sync only appear while the initial sync is in progress and do not
appear once the initial sync completes.
.. data:: replSetGetStatus.initialSyncStatus.failedInitialSyncAttempts
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The number of times the :ref:`initial sync
<replica-set-initial-sync>` failed and had to restart on this
secondary.
.. data:: replSetGetStatus.initialSyncStatus.maxFailedInitialSyncAttempts
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The maximum number of times the :ref:`initial sync
<replica-set-initial-sync>` can restart on this secondary
before the member shuts down.
.. data:: replSetGetStatus.initialSyncStatus.initialSyncStart
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The start timestamp of the :ref:`initial sync
<replica-set-initial-sync>` for this secondary.
.. data:: replSetGetStatus.initialSyncStatus.initialSyncEnd
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The end timestamp of the :ref:`initial sync
<replica-set-initial-sync>` for this secondary.
.. data:: replSetGetStatus.initialSyncStatus.initialSyncElapsedMillis
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The number of milliseconds between
:data:`~replSetGetStatus.initialSyncStatus.initialSyncStart`
and :data:`~replSetGetStatus.initialSyncStatus.initialSyncEnd`.
.. data:: replSetGetStatus.initialSyncStatus.initialSyncAttempts
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
Array of documents where each document corresponds to a single
:ref:`initial sync <replica-set-initial-sync>` attempt. See also
:data:`~replSetGetStatus.initialSyncStatus.failedInitialSyncAttempts`.
Each document contains the following information for the initial sync attempt:
.. code-block:: javascript
{
"durationMillis" : <duration in milliseconds>,
"status" : <exit status>,
"syncSource" : <source node from which this secondary performs initial sync>
}
.. data:: replSetGetStatus.initialSyncStatus.fetchedMissingDocs
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The number of missing (i.e. uncloned) documents that were fetched
from the sync source in order to apply to those documents the
updates that occurred after the :ref:`initial sync
<replica-set-initial-sync>` started.
As part of the initial sync process, the secondary uses the oplog
to update its data set to reflect the current state of the
replica set.
.. data:: replSetGetStatus.initialSyncStatus.appliedOps
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The number of ops that occurred after the :ref:`initial sync
<replica-set-initial-sync>` started and were applied after cloning
the databases.
As part of the initial sync process, the secondary uses the oplog
to update its data set to reflect the current state of the
replica set.
.. data:: replSetGetStatus.initialSyncStatus.initialSyncOplogStart
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The start timestamp of the oplog application stage of the
:ref:`initial sync <replica-set-initial-sync>` where the
secondary applies changes that occurred after the initial sync
start.
As part of the initial sync process, the secondary uses the oplog
to update its data set to reflect the current state of the
replica set.
.. data:: replSetGetStatus.initialSyncStatus.initialSyncOplogEnd
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
The end timestamp of the oplog application stage of the
:ref:`initial sync <replica-set-initial-sync>` where the
secondary applies changes that occurred after the initial sync
start.
As part of the initial sync process, the secondary uses the oplog
to update its data set to reflect the current state of the
replica set.
.. data:: replSetGetStatus.initialSyncStatus.databases
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
Detail on the databases cloned during :ref:`initial sync
<replica-set-initial-sync>`.
.. data:: replSetGetStatus.initialSyncStatus.databases.databasesCloned
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
Number of databases cloned during :ref:`initial sync
<replica-set-initial-sync>`.
.. data:: replSetGetStatus.initialSyncStatus.databases.<dbname>
.. versionadded:: 3.4
*Available only if the command is run with the initialSync: 1
option on a secondary*
For each database, a document that returns information regarding
the progress of the cloning of that database.
.. code-block:: javascript
{
"collections" : <number of collections to clone in the database>,
"clonedCollections" : <number of collections cloned to date>,
"start" : <start date and time for the database clone>,
"end" : <end date and time for the database clone>,
"elapsedMillis" : <duration of the database clone>,
"<db>.<collection>" : {
"documentsToCopy" : <number of documents to copy>,
"documentsCopied" : <number of documents copied to date>,
"indexes" : <number of indexes>,
"fetchedBatches" : <number of batches of documents fetched to date>,
"start" : <start date and time for the collection clone>,
"end" : <end date and time for the collection clone>,
"elapsedMillis" : <duration of the collection clone>,
}
}
.. data:: replSetGetStatus.members
The ``members`` field holds an array that contains a document for
every member in the replica set.
.. data:: replSetGetStatus.members[n]._id
The ``_id`` field holds the identifier for the member.
.. data:: replSetGetStatus.members[n].name
The ``name`` field holds the name of the server.
.. data:: replSetGetStatus.members[n].self
The ``self`` field is only included in the document for the
current ``mongod`` instance in the members array. Its value is
``true``.
.. data:: replSetGetStatus.members[n].health
The ``health`` value is only present for the other members of the
replica set (i.e. not the member that returns
:method:`rs.status`). This field conveys if the member is up (i.e.
``1``) or down (i.e. ``0``).
.. data:: replSetGetStatus.members[n].state
The value of :data:`~replSetGetStatus.members[n].state` is an
integer between ``0`` and ``10`` that represents the
:doc:`replica state </reference/replica-states>` of the member.
.. data:: replSetGetStatus.members[n].stateStr
A string that describes :data:`~replSetGetStatus.members[n].state`.
.. data:: replSetGetStatus.members[n].uptime
The :data:`~replSetGetStatus.members[n].uptime` field holds a value
that reflects the number of seconds that this member has been
online.
This value does not appear for the member that returns the
:method:`rs.status()` data.
.. data:: replSetGetStatus.members[n].optime
Information regarding the last operation from the operation log that
this member has applied.
.. versionchanged:: 3.2
If using :rsconf:`protocolVersion: 1 <protocolVersion>`,
``optime`` returns a document that contains:
- ``ts``, the :ref:`Timestamp <document-bson-type-timestamp>` of
the last operation applied to this member of the replica set
from the :term:`oplog`.
- ``t``, the :data:`~replSetGetStatus.term` in which the last
applied operation was originally generated on the primary.
If using :rsconf:`protocolVersion: 0 <protocolVersion>`, ``optime``
returns the :ref:`Timestamp <document-bson-type-timestamp>` of
the last operation applied to this member of the replica set from
the :term:`oplog`.
.. data:: replSetGetStatus.members[n].optimeDurable
.. versionadded:: 3.4
Information regarding the last operation from the operation log
that this member has applied to its journal.
If using :rsconf:`protocolVersion: 1 <protocolVersion>`,
the value is a document that contains:
- ``ts``, the :ref:`Timestamp <document-bson-type-timestamp>` of
the operation.
- ``t``, the :data:`~replSetGetStatus.term` in which this
operation was originally generated on the primary.
If using :rsconf:`protocolVersion: 0 <protocolVersion>`, the
value is the :ref:`Timestamp <document-bson-type-timestamp>` of the
operation.
.. data:: replSetGetStatus.members[n].optimeDate
An :term:`ISODate` formatted date string that reflects the last
entry from the :term:`oplog` that this member applied. If this
differs significantly from
:data:`~replSetGetStatus.members[n].lastHeartbeat` this member is
either experiencing "replication lag" *or* there have not been any
new operations since the last update. Compare
``members.optimeDate`` between all of the members of the set.
.. data:: replSetGetStatus.members[n].optimeDurableDate
.. versionadded:: 3.4
An :term:`ISODate` formatted date string that reflects the last
entry from the :term:`oplog` that this member applied to its
journal.
.. data:: replSetGetStatus.members[n].syncingTo
.. deprecated:: 3.6.6, 3.4.16
Starting in MongoDB 3.6.6 (and 3.4.16), MongoDB deprecates
:data:`~replSetGetStatus.members[n].syncingTo`. See
:data:`replSetGetStatus.members[n].syncSourceHost` instead.
The ``syncingTo`` field holds the hostname of the member from
which this instance is syncing. If the member is a primary,
returns an empty string ``""``.
.. data:: replSetGetStatus.members[n].syncSourceHost
.. versionadded:: 3.6.6, 3.4.16
The :data:`~replSetGetStatus.members[n].syncSourceHost` field
holds the hostname of the member from which this instance syncs.
If the ``replSetGetStatus.members[n]`` is a primary,
:data:`~replSetGetStatus.members[n].syncSourceHost` is an empty
string and the :data:`~replSetGetStatus.members[n].syncSourceId`
``-1``.
.. data:: replSetGetStatus.members[n].syncSourceId
.. versionadded:: 3.6.6, 3.4.16
The :data:`~replSetGetStatus.members[n].syncSourceId` field holds
the :data:`replSetGetStatus.members[n]._id` value of the
:data:`~replSetGetStatus.members[n].syncSourceHost`.
If the ``replSetGetStatus.members[n]`` is a primary,
:data:`~replSetGetStatus.members[n].syncSourceHost` is an empty
string and the :data:`~replSetGetStatus.members[n].syncSourceId`
``-1``.
.. data:: replSetGetStatus.members[n].electionTime
For the current primary, information regarding the election
:ref:`Timestamp <document-bson-type-timestamp>` from the
operation log. See :doc:`/core/replica-set-high-availability` for more
information about elections.
.. data:: replSetGetStatus.members[n].electionDate
For the current primary, an :term:`ISODate` formatted date string
that reflects the election date. See
:doc:`/core/replica-set-high-availability` for more information about
elections.
.. data:: replSetGetStatus.members[n].self
Indicates which replica set member processed the
:command:`replSetGetStatus` command.
.. data:: replSetGetStatus.members[n].lastHeartbeat
An :term:`ISODate` formatted date and time that reflects the last
time the server that processed the :command:`replSetGetStatus`
command received a response from a heartbeat that it sent to this
member (``members[n]``).
Compare this value to the values of the :data:`~replSetGetStatus.date` and
:data:`~replSetGetStatus.members[n].lastHeartBeatRecv` fields to
track latency between these replica set members.
This value is only available for replica set members other than the server specified by :data:`replSetGetStatus.members[n].self`.
.. data:: replSetGetStatus.members[n].lastHeartbeatRecv
An :term:`ISODate` formatted date and time that reflects the last
time the server that processed the :command:`replSetGetStatus`
command received a heartbeat request from this member
(``members[n]``).
Compare this value to the values of the
:data:`~replSetGetStatus.date` and
:data:`~replSetGetStatus.members[n].lastHeartBeat` fields to track
latency between these replica set members.
This value is only available for replica set members other than the server specified by :data:`replSetGetStatus.members[n].self`.
.. data:: replSetGetStatus.members[n].lastHeartbeatMessage
When the last heartbeat included an extra message, the
:data:`~replSetGetStatus.members[n].lastHeartbeatMessage` contains
a string representation of that message.
.. data:: replSetGetStatus.members[n].pingMs
The ``pingMs`` represents the number of milliseconds (ms) that a
round-trip packet takes to travel between the remote member and
the local instance.
This value does not appear for the member that returns the
:method:`rs.status()` data.
.. data:: replSetGetStatus.members[n].syncingTo
The ``syncingTo`` field is only present on the output of
:method:`rs.status()` on :term:`secondary` and recovering members,
and holds the hostname of the member from which this instance is
syncing.
.. data:: replSetGetStatus.members[n].configVersion
.. versionadded:: 3.0
The ``configVersion`` value is the :rsconf:`replica
set configuration version <version>`.
See also :ref:`command-response` for details on the ``ok`` status
field, the ``operationTime`` field and the ``$clusterTime`` field.