From b4a99a27e8c49973c9181c674f64b1feec093235 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Thu, 18 Mar 2021 11:07:59 +0100 Subject: [PATCH] Fix NumberLong inconsistencies --- source/reference/command/serverStatus.txt | 376 +++++++++++----------- 1 file changed, 188 insertions(+), 188 deletions(-) diff --git a/source/reference/command/serverStatus.txt b/source/reference/command/serverStatus.txt index 7eb073bd25e..3738ff293a5 100644 --- a/source/reference/command/serverStatus.txt +++ b/source/reference/command/serverStatus.txt @@ -149,10 +149,10 @@ Instance Information "advisoryHostFQDNs" : , "version" : , "process" : <"mongod"|"mongos">, - "pid" : , + "pid" : NumberLong(), "uptime" : , - "uptimeMillis" : , - "uptimeEstimate" : , + "uptimeMillis" : NumberLong(), + "uptimeEstimate" : NumberLong(), "localTime" : ISODate(""), .. serverstatus:: host @@ -471,34 +471,34 @@ primary: "electionMetrics" : { "stepUpCmd" : { - "called" : , - "successful" : + "called" : NumberLong(), + "successful" : NumberLong() }, "priorityTakeover" : { - "called" : , - "successful" : + "called" : NumberLong(), + "successful" : NumberLong() }, "catchUpTakeover" : { - "called" : , - "successful" : + "called" : NumberLong(), + "successful" : NumberLong() }, "electionTimeout" : { - "called" : , - "successful" : + "called" : NumberLong(), + "successful" : NumberLong() }, "freezeTimeout" : { - "called" : , - "successful" : + "called" : NumberLong(), + "successful" : NumberLong() }, - "numStepDownsCausedByHigherTerm" : , - "numCatchUps" : , - "numCatchUpsSucceeded" : , - "numCatchUpsAlreadyCaughtUp" : , - "numCatchUpsSkipped" : , - "numCatchUpsTimedOut" : , - "numCatchUpsFailedWithError" :, - "numCatchUpsFailedWithNewTerm" : , - "numCatchUpsFailedWithReplSetAbortPrimaryCatchUpCmd" : , + "numStepDownsCausedByHigherTerm" : NumberLong(), + "numCatchUps" : NumberLong(), + "numCatchUpsSucceeded" : NumberLong(), + "numCatchUpsAlreadyCaughtUp" : NumberLong(), + "numCatchUpsSkipped" : NumberLong(), + "numCatchUpsTimedOut" : NumberLong(), + "numCatchUpsFailedWithError" : NumberLong(), + "numCatchUpsFailedWithNewTerm" : NumberLong(), + "numCatchUpsFailedWithReplSetAbortPrimaryCatchUpCmd" : NumberLong(), "averageCatchUpOps" : } @@ -541,10 +541,10 @@ primary: Metrics on elections called by the :binary:`~bin.mongod` instance because it has not been able to reach the primary within :rsconf:`settings.electionTimeoutMillis`. - + The :serverstatus:`~electionMetrics.electionTimeout` includes both the number of elections called and the number of elections that succeeded. - + .. seealso:: :rsconf:`settings.electionTimeoutMillis` *Available starting in 4.2.1 (and 4.0.13)* @@ -554,7 +554,7 @@ primary: Metrics on elections called by the :binary:`~bin.mongod` instance after its :dbcommand:`freeze period ` (during which the member cannot seek an election) has expired. - + The :serverstatus:`electionMetrics.freezeTimeout` includes both the number of elections called and the number of elections that succeeded. @@ -690,12 +690,12 @@ flowControl "flowControl" : { "enabled" : , "targetRateLimit" : , - "timeAcquiringMicros" : , + "timeAcquiringMicros" : NumberLong(), "locksPerKiloOp" : , // Available in 4.4+. In 4.2, returned locksPerOp instead. "sustainerRate" : , "isLagged" : , "isLaggedCount" : , - "isLaggedTimeMicros" : , + "isLaggedTimeMicros" : NumberLong() }, .. serverstatus:: flowControl @@ -819,10 +819,10 @@ freeMonitoring "freeMonitoring" : { "state" : , - "retryIntervalSecs" : , + "retryIntervalSecs" : NumberLong(), "lastRunTime" : , - "registerErrors" : , - "metricsErrors" : + "registerErrors" : NumberLong(), + "metricsErrors" : NumberLong() }, .. serverstatus:: freeMonitoring @@ -869,7 +869,7 @@ globalLock .. code-block:: javascript "globalLock" : { - "totalTime" : , + "totalTime" : NumberLong(), "currentQueue" : { "total" : , "readers" : , @@ -1285,9 +1285,9 @@ mirroredReads A document that reports on :ref:`mirrored reads `. To return :serverstatus:`mirroredReads` information, you must explicitly specify the inclusion: - + .. code-block:: javascript - + db.runCommand( { serverStatus: 1, mirroredReads: 1 } ) .. serverstatus:: mirroredReads.seen @@ -1317,11 +1317,11 @@ network .. code-block:: javascript "network" : { - "bytesIn" : , - "bytesOut" : , - "numSlowDNSOperations" : , - "numSlowSSLOperations" : , - "numRequests" : , + "bytesIn" : NumberLong(), + "bytesOut" : NumberLong(), + "numSlowDNSOperations" : NumberLong(), + "numSlowSSLOperations" : NumberLong(), + "numRequests" : NumberLong(), "tcpFastOpen" : { "kernelSetting" : NumberLong(), "serverSupported" : , @@ -1460,7 +1460,7 @@ network .. serverstatus:: network.serviceExecutors.passthrough.threadsRunning .. versionadded:: 5.0 - + Number of threads running in the ``passthrough`` service executor. .. serverstatus:: network.serviceExecutors.passthrough.clientsInTotal @@ -1497,7 +1497,7 @@ network .. serverstatus:: network.serviceExecutors.fixed.threadsRunning .. versionadded:: 5.0 - + Number of threads running in the ``fixed`` service executor. .. serverstatus:: network.serviceExecutors.fixed.clientsInTotal @@ -1580,7 +1580,7 @@ opReadConcernCounters } .. serverstatus:: opReadConcernCounters - + *Removed in version 5.0*. Replaced by :serverstatus:`readConcernCounters`. @@ -1707,7 +1707,7 @@ opWriteConcernCounters .. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst .. code-block:: javascript - + "insert" : { "wmajority" : NumberLong(), "wnum" : { @@ -1766,11 +1766,12 @@ opWriteConcernCounters .. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst .. code-block:: javascript - + "update" : { "wmajority" : NumberLong(), "wnum" : { "" : NumberLong(), + ... }, "wtag" : { "" : NumberLong(), @@ -1778,12 +1779,12 @@ opWriteConcernCounters }, "none" : NumberLong() }, - + .. list-table:: :header-rows: 1 :widths: 20 80 - * - + * - - Description * - ``"wmajority"`` @@ -1824,9 +1825,9 @@ opWriteConcernCounters .. include:: /includes/extracts/serverStatus-opWriteConcernCounters.rst .. code-block:: javascript - + "delete" : { - "wmajority" : NumberLong() + "wmajority" : NumberLong(), "wnum" : { "" : NumberLong(), ... @@ -1842,7 +1843,7 @@ opWriteConcernCounters :header-rows: 1 :widths: 20 80 - * - + * - - Description * - ``"wmajority"`` @@ -1913,7 +1914,7 @@ opcounters :binary:`~bin.mongod` instance last started. .. include:: /includes/extracts/4.2-changes-opcounters-type.rst - + .. serverstatus:: opcounters.query The total number of queries received since the :binary:`~bin.mongod` @@ -2045,23 +2046,23 @@ readConcernCounters "readConcernCounters" : { "nonTransactionOps" : { - "none" : , - "local" : , - "available" : , - "majority" : , + "none" : NumberLong(), + "local" : NumberLong(), + "available" : NumberLong(), + "majority" : NumberLong(), "snapshot" : { - "withClusterTime" : , - "withoutClusterTime" : + "withClusterTime" : NumberLong(), + "withoutClusterTime" : NumberLong() }, - "linearizable" : + "linearizable" : NumberLong() }, "transactionOps" : { - "none" : , - "local" : , - "majority" : , + "none" : NumberLong(), + "local" : NumberLong(), + "majority" : NumberLong(), "snapshot" : { - "withClusterTime" : , - "withoutClusterTime" : + "withClusterTime" : NumberLong(), + "withoutClusterTime" : NumberLong() } } }, @@ -2176,11 +2177,11 @@ oplogTruncation .. code-block:: javascript "oplogTruncation" : { - "totalTimeProcessingMicros" : , + "totalTimeProcessingMicros" : NumberLong(), "processingMethod" : , "oplogMinRetentionHours" : - "totalTimeTruncatingMicros" : , - "truncateCount" : + "totalTimeTruncatingMicros" : NumberLong(), + "truncateCount" : NumberLong() }, .. serverstatus:: oplogTruncation @@ -2204,7 +2205,7 @@ oplogTruncation The total time taken, in microseconds, to scan or sample the oplog to determine the oplog truncation points. - + :serverstatus:`~oplogTruncation.totalTimeProcessingMicros` is only meaningful if the :binary:`~bin.mongod` instance started on existing data files (i.e. not meaningful for :doc:`/core/inmemory`). @@ -2223,11 +2224,11 @@ oplogTruncation The method used at start up to determine the oplog truncation points. The value can be either ``"sampling"`` or ``"scanning"``. - + :serverstatus:`~oplogTruncation.processingMethod` is only meaningful if the :binary:`~bin.mongod` instance started on existing data files (i.e. not meaningful for :doc:`/core/inmemory`). - + .. versionchanged:: 4.4 Also available in :doc:`/core/inmemory`. @@ -2247,18 +2248,18 @@ oplogTruncation Only visible if the :binary:`~bin.mongod` is a member of a replica set *and*: - - - The :binary:`~bin.mongod` was started with the - :option:`--oplogMinRetentionHours + + - The :binary:`~bin.mongod` was started with the + :option:`--oplogMinRetentionHours ` command line option *or* the :setting:`storage.oplogMinRetentionHours` configuration file - option, - + option, + *or* - The minimum retention period was configured after startup using :dbcommand:`replSetResizeOplog`. - + .. serverstatus:: oplogTruncation.totalTimeTruncatingMicros The cumulative time spent, in microseconds, performing oplog truncations. @@ -2408,32 +2409,32 @@ security "mechanisms" : { "MONGODB-X509" : { "speculativeAuthenticate" : { - "received" : , - "successful" : + "received" : NumberLong(), + "successful" : NumberLong() }, "authenticate" : { - "received" : , - "successful" : + "received" : NumberLong(), + "successful" : NumberLong() } }, "SCRAM-SHA-1" : { "speculativeAuthenticate" : { - "received" : , - "successful" : + "received" : NumberLong(), + "successful" : NumberLong() }, "authenticate" : { - "received" : , - "successful" : + "received" : NumberLong(), + "successful" : NumberLong() } }, "SCRAM-SHA-256" : { "speculativeAuthenticate" : { - "received" : , - "successful" : + "received" : NumberLong(), + "successful" : NumberLong() }, "authenticate" : { - "received" : , - "successful" : + "received" : NumberLong(), + "successful" : NumberLong() } } } @@ -2446,7 +2447,7 @@ security .. serverstatus:: security A document that reports on: - + - The number of times a given authentication mechanism has been used to authenticate against the :binary:`~bin.mongod` or :binary:`~bin.mongos` instance. (New in MongoDB 4.4) @@ -2472,7 +2473,7 @@ security parameter. The ``mechanisms`` document includes a field for each authentication mechanism supported by your :binary:`~bin.mongod` or :binary:`~bin.mongos` instance. - + The following example shows the shape of the ``mechanisms`` document for a deployment that only supports :doc:`x.509 ` authentication. @@ -2567,10 +2568,10 @@ sharding { "configsvrConnectionString" : "csRS/cfg1.example.net:27019,cfg2.example.net:27019,cfg2.example.net:27019", "lastSeenConfigServerOpTime" : { - "ts" : Timestamp(1517462189, 1), - "t" : NumberLong(1) + "ts" : , + "t" : NumberLong() }, - "maxChunkSizeInBytes" : NumberLong(67108864) + "maxChunkSizeInBytes" : NumberLong() } .. serverstatus:: sharding @@ -2613,7 +2614,7 @@ shardingStatistics .. tabs:: tabs: - + - id: shard name: Shard content: | @@ -3147,7 +3148,7 @@ shardingStatistics State of the donor shard for the current resharding operation. Number is set to 0 when a new resharding operation starts. - + .. list-table:: :header-rows: 1 :widths: 15 20 40 @@ -3366,7 +3367,7 @@ shardedIndexConsistency .. code-block:: javascript "shardedIndexConsistency" : { - "numShardedCollectionsWithInconsistentIndexes" : + "numShardedCollectionsWithInconsistentIndexes" : NumberLong() }, .. serverstatus:: shardedIndexConsistency @@ -3468,19 +3469,19 @@ transactions .. code-block:: javascript "transactions" : { - "retriedCommandsCount" : , - "retriedStatementsCount" : , - "transactionsCollectionWriteCount" : , - "currentActive" : , - "currentInactive" : , - "currentOpen" : , - "totalAborted" : , - "totalCommitted" : , - "totalStarted" : , - "totalPrepared" : , - "totalPreparedThenCommitted" : , - "totalPreparedThenAborted" : , - "currentPrepared" : , + "retriedCommandsCount" : NumberLong(), + "retriedStatementsCount" : NumberLong(), + "transactionsCollectionWriteCount" : NumberLong(), + "currentActive" : NumberLong(), + "currentInactive" : NumberLong(), + "currentOpen" : NumberLong(), + "totalAborted" : NumberLong(), + "totalCommitted" : NumberLong(), + "totalStarted" : NumberLong(), + "totalPrepared" : NumberLong(), + "totalPreparedThenCommitted" : NumberLong(), + "totalPreparedThenAborted" : NumberLong(), + "currentPrepared" : NumberLong(), "lastCommittedTransaction" : // Starting in 4.2.2 (and 4.0.9) }, @@ -3493,50 +3494,50 @@ transactions .. code-block:: javascript "transactions" : { - "currentOpen" : , // Starting in 4.2.1 - "currentActive" : , // Starting in 4.2.1 - "currentInactive" : , // Starting in 4.2.1 - "totalStarted" : , - "totalCommitted" : , - "totalAborted" : , + "currentOpen" : NumberLong(), // Starting in 4.2.1 + "currentActive" : NumberLong(), // Starting in 4.2.1 + "currentInactive" : NumberLong(), // Starting in 4.2.1 + "totalStarted" : NumberLong(), + "totalCommitted" : NumberLong(), + "totalAborted" : NumberLong(), "abortCause" : { - : , - " : , + : NumberLong(), + " : NumberLong(), ... }, - "totalContactedParticipants" : , - "totalParticipantsAtCommit" : , - "totalRequestsTargeted" : , + "totalContactedParticipants" : NumberLong(), + "totalParticipantsAtCommit" : NumberLong(), + "totalRequestsTargeted" : NumberLong(), "commitTypes" : { "noShards" : { - "initiated" : , - "successful" : , - "successfulDurationMicros" : , + "initiated" : NumberLong(), + "successful" : NumberLong(), + "successfulDurationMicros" : NumberLong() }, "singleShard" : { - "initiated" : , - "successful" : , - "successfulDurationMicros" : , + "initiated" : NumberLong(), + "successful" : NumberLong(), + "successfulDurationMicros" : NumberLong() }, "singleWriteShard" : { - "initiated" : , - "successful" : , - "successfulDurationMicros" : , + "initiated" : NumberLong(), + "successful" : NumberLong(), + "successfulDurationMicros" : NumberLong() }, "readOnly" : { - "initiated" : , - "successful" : , - "successfulDurationMicros" : , + "initiated" : NumberLong(), + "successful" : NumberLong(), + "successfulDurationMicros" : NumberLong() }, "twoPhaseCommit" : { - "initiated" : , - "successful" : , - "successfulDurationMicros" :, + "initiated" : NumberLong(), + "successful" : NumberLong(), + "successfulDurationMicros" : NumberLong() }, "recoverWithToken" : { - "initiated" : , - "successful" : , - "successfulDurationMicros" : , + "initiated" : NumberLong(), + "successful" : NumberLong(), + "successfulDurationMicros" : NumberLong() } } }, @@ -3627,7 +3628,7 @@ transactions .. serverstatus:: transactions.currentOpen *Available on mongod in 4.0.2+ and mongos in 4.2.1+* - + The total number of open transactions. A transaction is opened when the first command is run as a part of that transaction, and stays open until the transaction either commits or aborts. @@ -3719,7 +3720,7 @@ transactions |mongos-only| Breakdown of the commits by types. For example: - + .. code-block:: javascript :copyable: false @@ -3784,7 +3785,7 @@ transactions - Commits of transactions that included writes to multiple shards - + * - ``recoverWithToken`` - Commits that recovered the outcome of transactions from @@ -3800,7 +3801,7 @@ transactions - Description * - ``initiated`` - + - Total number of times that commits of this type were initiated. @@ -3814,7 +3815,7 @@ transactions this type. .. versionadded:: 4.2 - + .. serverstatus:: transactions.totalPrepared |mongod-only| @@ -3904,7 +3905,7 @@ transactions fit within a single oplog entry. See :ref:`txn-oplog-size-limit` for details. - + transportSecurity ~~~~~~~~~~~~~~~~~ @@ -3913,11 +3914,11 @@ transportSecurity .. code-block:: javascript "transportSecurity" : { - "1.0" : , - "1.1" : , - "1.2" : , - "1.3" : , - "unknown" : + "1.0" : NumberLong(), + "1.1" : NumberLong(), + "1.2" : NumberLong(), + "1.3" : NumberLong(), + "unknown" : NumberLong() }, .. serverstatus:: transportSecurity. @@ -4581,13 +4582,12 @@ metrics "metrics" : { "aggStageCounters" : { - "" : - } + "" : NumberLong() }, "commands": { "": { - "failed": , - "total": + "failed": NumberLong(), + "total": NumberLong() } }, "cursor" : { @@ -4615,8 +4615,8 @@ metrics }, "wtimeouts" : NumberLong(), "default" : { - "unsatisfiable" : , - "wtimeouts" : + "unsatisfiable" : NumberLong(), + "wtimeouts" : NumberLong() } }, "operation" : { @@ -4648,54 +4648,54 @@ metrics "networkInterface" : }, "apply" : { - "attemptsToBecomeSecondary" : , + "attemptsToBecomeSecondary" : NumberLong(), "batches" : { "num" : , "totalMillis" : }, - "ops" : + "ops" : NumberLong() }, "buffer" : { - "count" : , - "maxSizeBytes" : , - "sizeBytes" : + "count" : NumberLong(), + "maxSizeBytes" : NumberLong(), + "sizeBytes" : NumberLong() }, "initialSync" : { - "completed" : , - "failedAttempts" : , - "failures" : + "completed" : NumberLong(), + "failedAttempts" : NumberLong(), + "failures" : NumberLong() }, "network" : { - "bytes" : , + "bytes" : NumberLong(), "getmores" : { "num" : , "totalMillis" : }, - "notPrimaryLegacyUnacknowledgedWrites" : , - "notPrimaryUnacknowledgedWrites" : , + "notPrimaryLegacyUnacknowledgedWrites" : NumberLong(), + "notPrimaryUnacknowledgedWrites" : NumberLong(), "oplogGetMoresProcessed" : { - "num" : , - "totalMillis" : + "num" : , + "totalMillis" : }, - "ops" : , - "readersCreated" : , + "ops" : NumberLong(), + "readersCreated" : NumberLong(), "replSetUpdatePosition" : { - "num" : + "num" : NumberLong() } }, "reconfig" : { "numAutoReconfigsForRemovalOfNewlyAddedFields" : - + NumberLong() }, "stepDown" : { - "userOperationsKilled" : , - "userOperationsRunning" : + "userOperationsKilled" : NumberLong(), + "userOperationsRunning" : NumberLong() }, "syncSource" : { - "numSelections" : , - "numTimesChoseSame" : , - "numTimesChoseDifferent" : , - "numTimesCouldNotFind" : + "numSelections" : NumberLong(), + "numTimesChoseSame" : NumberLong(), + "numTimesChoseDifferent" : NumberLong(), + "numTimesCouldNotFind" : NumberLong() } }, "storage" : { @@ -4737,7 +4737,7 @@ metrics commands `. For each command, the :dbcommand:`serverStatus` reports the total number of executions and the number of failed executions. - + Starting in MongoDB 4.0.13 and 4.2.1, :serverstatus:`metrics.commands` include ``replSetStepDownWithForce`` (i.e. the :dbcommand:`replSetStepDown` @@ -4761,7 +4761,7 @@ metrics :ref:`aggregation pipeline ` was used to update documents on this :binary:`~bin.mongod`. Subtract this value from the total number of updates to get the number of - updates made with :ref:`document ` + updates made with :ref:`document ` syntax. The ``pipeline`` counter is only available for ``update`` and @@ -4769,10 +4769,10 @@ metrics .. serverstatus:: metrics.commands.findAndModify.pipeline - The number of times :method:`~db.collection.findAndModify()` was + The number of times :method:`~db.collection.findAndModify()` was used in an :ref:`aggregation pipeline ` - to update documents on this :binary:`~bin.mongod`. + to update documents on this :binary:`~bin.mongod`. The ``pipeline`` counter is only available for ``update`` and ``findAndModify`` operations. @@ -4788,7 +4788,7 @@ metrics .. serverstatus:: metrics.commands.findAndModify.arrayFilters The number of times an :ref:`arrayFilter ` - was used with :method:`~db.collection.findAndModify()` to update + was used with :method:`~db.collection.findAndModify()` to update documents on this :binary:`~bin.mongod`. The ``arrayFilters`` counter is only available for ``update`` and @@ -4860,11 +4860,11 @@ metrics specific to operations where a default write concern was used (meaning, a non-``clientSupplied`` write concern). The possible origins of a default write concern are: - + - ``implicitDefault`` - ``customDefault`` - ``getLastErrorDefaults`` - + Refer to the following table for information on each possible write concern origin, or ``provenance``: @@ -4879,7 +4879,7 @@ metrics Number of times a non-``clientSupplied`` write concern timed out. - + .. serverstatus:: metrics.operation @@ -4958,7 +4958,7 @@ metrics .. serverstatus:: metrics.repl.apply.batchSize .. versionadded:: 4.0.6 (Also available in 3.6.11+) - + The total number of oplog operations applied. The :serverstatus:`metrics.repl.apply.batchSize` is incremented with the number of operations in a batch at the batch boundaries instead of @@ -4987,7 +4987,7 @@ metrics The total number of :term:`oplog` operations applied. :serverstatus:`metrics.repl.apply.ops` is incremented after each - operation. + operation. .. seealso:: :serverstatus:`metrics.repl.apply.batchSize` @@ -5056,9 +5056,9 @@ metrics The number of empty ``oplog`` batches a secondary receives from its sync source. A secondary receives an empty batch if it is fully synced with its source and either: - + - The ``getmore`` times out waiting for more data, or - + - The sync source's majority commit point has advanced since the last batch sent to this secondary. @@ -5067,7 +5067,7 @@ metrics secondary. Otherwise, for a primary, this number is ``0``. .. versionadded:: 4.4 - + .. serverstatus:: metrics.repl.network.notPrimaryLegacyUnacknowledgedWrites The number of unacknowledged (``w: 0``) legacy write operations (see