MongoDB Server Parameters
On this page
- Synopsis
Parameters
- Authentication Parameters
- General Parameters
- Logging Parameters
- Diagnostic Parameters
- Logical Session
- Replication Parameters
- Sharding Parameters
- Storage Parameters
- WiredTiger Parameters
- Auditing Parameters
- Transaction Parameters
Synopsis
MongoDB provides a number of configuration options that you can set using:
the
setParametercommand:copycopied
db.adminCommand( { setParameter: 1, <parameter>: <value> } )the
setParameterconfiguration setting:copycopied
setParameter: <parameter1>: <value1> ...the
--setParametercommand-line option formongodandmongos:copycopied
mongod --setParameter <parameter>=<value> mongos --setParameter <parameter>=<value>
For additional configuration options, see Configuration File Options, mongod and mongos.
Parameters
Authentication Parameters
authenticationMechanismsChanged in version 4.0: Remove support for the deprecated
MONGODB-CRauthentication mechanism.Available for bothmongodandmongos.Specifies the list of authentication mechanisms the server accepts. Set this to one or more of the following values. If you specify multiple values, use a comma-separated list and no spaces. For descriptions of the authentication mechanisms, see Authentication.ValueDescriptionSCRAM-SHA-1RFC 5802 standard Salted Challenge Response Authentication Mechanism using the SHA-1 hash function.SCRAM-SHA-256RFC 7677 standard Salted Challenge Response Authentication Mechanism using the SHA-256 hash function.Requires featureCompatibilityVersion set to4.0.New in version 4.0.MONGODB-X509MongoDB TLS/SSL certificate authentication.GSSAPI (Kerberos)External authentication using Kerberos. This mechanism is available only in MongoDB Enterprise.PLAIN (LDAP SASL)External authentication using LDAP. You can also usePLAINfor authenticating in-database users.PLAINtransmits passwords in plain text. This mechanism is available only in MongoDB Enterprise.You can only setauthenticationMechanismsduring start-up.For example, to specify bothPLAINandSCRAM-SHA-256as the authentication mechanisms, use the following command:copycopiedmongod --setParameter authenticationMechanisms=PLAIN,SCRAM-SHA-256 --authclusterAuthModeAvailable for both
mongodandmongos.Set theclusterAuthModeto eithersendX509orx509. Useful during rolling upgrade to use x509 for membership authentication to minimize downtime.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .copycopieddb.adminCommand( { setParameter: 1, clusterAuthMode: "sendX509" } )enableLocalhostAuthBypassAvailable for both
mongodandmongos.Specify0orfalseto disable localhost authentication bypass. Enabled by default.enableLocalhostAuthBypassis not available usingsetParameterdatabase command. Use thesetParameteroption in the configuration file or the--setParameteroption on the command line.See Localhost Exception for more information.KeysRotationIntervalSecNew in version 3.6.**Default: 7776000 seconds (90 days)Specifies the number of seconds for which an HMAC signing key is valid before rotating to the next one. This parameter is intended primarily to facilitate authentication testing.You can only set
KeysRotationIntervalSecduring start-up, and cannot change this setting with thesetParameterdatabase command.ldapUserCacheInvalidationIntervalFor use with MongoDB deployments using LDAP Authorization. Available for
mongodinstances only.The interval (in seconds) that themongodinstance waits between external user cache flushes. After MongoDB flushes the external user cache, MongoDB reacquires authorization data from the LDAP server the next time an LDAP-authorized user issues an operation.Increasing the value specified increases the amount of time MongoDB and the LDAP server can be out of sync, but reduces the load on the LDAP server. Conversely, decreasing the value specified decreases the time MongoDB and the LDAP server can be out of sync while increasing the load on the LDAP server.Defaults to 30 seconds.ldapUseConnectionPoolNew in version 4.0.9.Specifies whether MongoDB should use connection pooling when connecting to the LDAP server for authentication/authorization.Starting in version 4.2, MongoDB uses the following default values:true on Windows.true on Linux where MongoDB Enterprise binaries are linked against
libldap_r.false on Linux where MongoDB Enterprise binaries are linked againstlibldap.In earlier versions (versions 4.0.9+), the default value isfalse.You can only setldapUseConnectionPoolduring start-up, and cannot change this setting with thesetParameterdatabase command.ldapConnectionPoolUseLatencyForHostPriorityNew in version 4.2.1 and 4.0.13**Default: trueA boolean that determines whether the LDAP connection pool (see
ldapUseConnectionPool) should use latency of the LDAP servers to determine the connection order (from lowest latency to highest).You can only setldapConnectionPoolUseLatencyForHostPriorityduring start-up, and cannot change this setting during runtime with thesetParameterdatabase command.ldapConnectionPoolMinimumConnectionsPerHostNew in version 4.2.1 and 4.0.13**Default: 1The minimum number of connections to keep open to each LDAP server.You can only set
ldapConnectionPoolMinimumConnectionsPerHostduring start-up, and cannot change this setting during runtime with thesetParameterdatabase command.ldapConnectionPoolMaximumConnectionsPerHostNew in version 4.2.1 and 4.0.13**Changed in version 4.4 Changed default value to
2. In previous versions, the default is unset.Default: 2The maximum number of connections to keep open to each LDAP server.You can only setldapConnectionPoolMaximumConnectionsPerHostduring start-up, and cannot change this setting during runtime with thesetParameterdatabase command.ldapConnectionPoolMaximumConnectionsInProgressPerHostNew in version 4.2.1 and 4.0.13The maximum number of in-progress connect operations to each LDAP server.You can only set
ldapConnectionPoolMaximumConnectionsInProgressPerHostduring start-up, and cannot change this setting with thesetParameterdatabase command.ldapConnectionPoolHostRefreshIntervalMillisNew in version 4.2.1 and 4.0.13**Default: 60000The number of milliseconds in-between health checks of the pooled LDAP connections.You can only set
ldapConnectionPoolHostRefreshIntervalMillisduring start-up, and cannot change this setting with thesetParameterdatabase command.ldapConnectionPoolIdleHostTimeoutSecsNew in version 4.2.1 and 4.0.13**Default: 300The maximum number of seconds that the pooled connections to an LDAP server can remain idle before being closed.You can only set
ldapConnectionPoolIdleHostTimeoutSecsduring start-up, and cannot change this setting with thesetParameterdatabase command.ocspEnabledNew in version 4.4: Available on Linux and macOS.Default: trueThe flag that enables or disables OCSP.You can only set
ocspEnabledduring startup in theconfiguration fileor with the--setParameteroption on the command line. For example, the following disables OCSP:copycopiedmongod --setParameter ocspEnabled=false ...SEE ALSOocspValidationRefreshPeriodSecstlsOCSPStaplingTimeoutSecstlsOCSPVerifyTimeoutSecsocspValidationRefreshPeriodSecsNew in version 4.4: Available on Linux.The number of seconds to wait before refreshing the stapled OCSP status response. Specify a number greater than or equal to 1.You can only set
ocspValidationRefreshPeriodSecsduring startup in theconfiguration fileor with the--setParameteroption on the command line. For example, the following sets the parameter to 3600 seconds:copycopiedmongod --setParameter ocspValidationRefreshPeriodSecs=3600 ...SEE ALSOocspEnabledtlsOCSPStaplingTimeoutSecstlsOCSPVerifyTimeoutSecsopensslCipherConfigNew in version 3.6.**Changed in version 4.0: With the use of native TLS/SSL libraries, the parameter
opensslCipherConfigis supported for Linux/BSD and no longer supported in Windows and macOS. See MongoDB 4.0 TLS/SSL.Specify the cipher string for OpenSSL when using TLS/SSL encryption. For a list of cipher strings, see https://www.openssl.org/docs/man1.0.2/apps/ciphers.htmlCIPHER-STRINGSYou can only setopensslCipherConfigduring start-up, and cannot change this setting using thesetParameterdatabase command.For version 4.2 and greater, the use ofTLSoptions is preferred overSSLoptions. The TLS options have the same functionality as theSSLoptions.copycopiedmongod --setParameter opensslCipherConfig='HIGH:!EXPORT:!aNULL@STRENGTH' --tlsMode requireTLS --tlsCertificateKeyFile Certs/server.pemFor versions 4.0 and earlier:copycopiedmongod --setParameter opensslCipherConfig='HIGH:!EXPORT:!aNULL@STRENGTH' --sslMode requireSSL --sslPEMKeyFile Certs/server.pemopensslDiffieHellmanParametersNew in version 3.6.**Available on Linux onlySpecify the path to the PEM file that contains the OpenSSL Diffie-Hellman parameters. Specifying the OpenSSL Diffie-Hellman parameters enables support for Ephemeral Diffie-Hellman (DHE) cipher suites during TLS/SSL encryption.Ephemeral Diffie-Hellman (DHE) cipher suites (and Ephemeral Elliptic Curve Diffie-Hellman (ECDHE) cipher suites) provide Forward Secrecy. Forward Secrecy cipher suites create an ephemeral session key that is protected by the server’s private key but never transmitted. This ensures that even if a server’s private key is compromised, you cannot decrypt past sessions with the compromised key.NOTEStarting in MongoDB 4.2, if
opensslDiffieHellmanParametersis unset but ECDHE is enabled, MongoDB enables DHE usingffdhe3072Diffie-Hellman parameter, as defined in RFC 7919appendix-A.2. Theffdhe3072is a strong parameter (i.e. size is greater than 1024). Strong parameters are not supported with Java 6 and 7 unless extended support has been purchased from Oracle.You can only setopensslDiffieHellmanParametersduring startup, and cannot change this setting using thesetParameterdatabase command.If for performance reasons, you need to disable support for DHE cipher suites, use theopensslCipherConfigparameter:copycopiedmongod --setParameter opensslCipherConfig='HIGH:!EXPORT:!aNULL:!DHE:!kDHE@STRENGTH' ...saslauthdPathNOTEAvailable only in MongoDB Enterprise (except MongoDB Enterprise for Windows).Available for both
mongodandmongos.Specify the path to the Unix Domain Socket of thesaslauthdinstance to use for proxy authentication.saslHostNameAvailable for both
mongodandmongos.saslHostNameoverrides MongoDB’s default hostname detection for the purpose of configuring SASL and Kerberos authentication.saslHostNamedoes not affect the hostname of themongodormongosinstance for any purpose beyond the configuration of SASL and Kerberos.You can only setsaslHostNameduring start-up, and cannot change this setting using thesetParameterdatabase command.NOTEsaslHostNamesupports Kerberos authentication and is only included in MongoDB Enterprise. For more information, see the following:Linux: Configure MongoDB with Kerberos Authentication on LinuxWindows: Configure MongoDB with Kerberos Authentication on WindowssaslServiceNameAvailable for both
mongodandmongos.Allows users to override the default Kerberos service name component of the Kerberos principal name, on a per-instance basis. If unspecified, the default value ismongodb.MongoDB only permits settingsaslServiceNameat startup. ThesetParametercommand can not change this setting.saslServiceNameis only available in MongoDB Enterprise.IMPORTANTEnsure that your driver supports alternate service names.scramIterationCountDefault:
10000Available for bothmongodandmongos.Changes the number of hashing iterations used for all newSCRAM-SHA-1passwords. More iterations increase the amount of time required for clients to authenticate to MongoDB, but makes passwords less susceptible to brute-force attempts. The default value is ideal for most common use cases and requirements.If you modify this value, it does not change the iteration count for existing passwords. ThescramIterationCountvalue must be5000or greater.For example, the following sets thescramIterationCountto12000.copycopiedmongod --setParameter scramIterationCount=12000Or, if using thesetParametercommand within themongoshell:copycopieddb.adminCommand( { setParameter: 1, scramIterationCount: 12000 } )SEE ALSOdb.changeUserPassword()db.createUser()db.updateUser()scramSHA256IterationCountNew in version 4.0.**Default:
15000Available for bothmongodandmongos.Changes the number of hashing iterations used for all newSCRAM-SHA-256passwords. More iterations increase the amount of time required for clients to authenticate to MongoDB, but makes passwords less susceptible to brute-force attempts. The default value is ideal for most common use cases and requirements.If you modify this value, it does not change iteration count for existing passwords. ThescramSHA256IterationCountvalue must be5000or greater.For example, the following sets thescramSHA256IterationCountto20000.copycopiedmongod --setParameter scramSHA256IterationCount=20000Or, if using thesetParametercommand within themongoshell:copycopieddb.adminCommand( { setParameter: 1, scramSHA256IterationCount: 20000 } )SEE ALSOdb.changeUserPassword()db.createUser()db.updateUser()sslModeAvailable for both
mongodandmongos.Set thenet.ssl.modeto eitherpreferSSLorrequireSSL. Useful during rolling upgrade to TLS/SSL to minimize downtime.For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .copycopieddb.adminCommand( { setParameter: 1, sslMode: "preferSSL" } )SEE ALSOtlsModetlsModeNew in version 4.2.Available for both
mongodandmongos.Set to either:preferTLS``requireTLSThetlsModeparameter is useful during rolling upgrade to TLS/SSL to minimize downtime.copycopieddb.adminCommand( { setParameter: 1, tlsMode: "preferTLS" } )For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .SEE ALSOsslModetlsOCSPStaplingTimeoutSecsNew in version 4.4: Available for Linux.The maximum number of seconds the
mongod/mongosinstance should wait to receive the OCSP status response for its certificates.Specify an integer greater than or equal to (>=) 1. If unset,tlsOCSPStaplingTimeoutSecsuses thetlsOCSPVerifyTimeoutSecsvalue.You can only settlsOCSPStaplingTimeoutSecsduring startup in theconfiguration fileor with the--setParameteroption on the command line. For example, the following sets thetlsOCSPStaplingTimeoutSecsto 20 seconds:copycopiedmongod --setParameter tlsOCSPStaplingTimeoutSecs=20 ...SEE ALSOocspEnabledocspValidationRefreshPeriodSecstlsOCSPVerifyTimeoutSecstlsOCSPVerifyTimeoutSecsNew in version 4.4: Available for Linux and Windows.Default: 5The maximum number of seconds that the
mongod/mongosshould wait for the OCSP response when verifying client certificates.Specify an integer greater than or equal to (>=) 1. Default is unlimited.You can only settlsOCSPVerifyTimeoutSecsduring startup in theconfiguration fileor with the--setParameteroption on the command line. For example, the following sets thetlsOCSPVerifyTimeoutSecsto 20 seconds:copycopiedmongod --setParameter tlsOCSPVerifyTimeoutSecs=20 ...SEE ALSOocspEnabledocspValidationRefreshPeriodSecstlsOCSPStaplingTimeoutSecstlsWithholdClientCertificateDefault: falseNew in version 4.2.Available for both
mongodandmongos.A TLS certificate is set for amongodormongoseither by the--tlsClusterFileoption or by the--tlsCertificateKeyFileoption when--tlsClusterFileis not set. If the TLS certificate is set, by default, the instance sends the certificate when initiating intra-cluster communications with othermongodormongosinstances in the deployment. SettlsWithholdClientCertificateto1ortrueto direct the instance to withhold sending its TLS certificate during these communications. Use this option with--tlsAllowConnectionsWithoutCertificates(to allow inbound connections without certificates) on all members of the deployment.tlsWithholdClientCertificateis mutually exclusive with--clusterAuthMode x509.tlsX509ClusterAuthDNOverrideNew in version 4.2.Available for both
mongodandmongos.An alternative Distinguished Name (DN) that the instance can also use to identify members of the deployment.For a MongoDB deployment that uses x.509 certificates forclusterAuthMode, deployment members identify each other using x.509 certificates (net.tls.clusterFile, if specified, andnet.tls.certificateKeyFile) during intra-cluster communications. For members of the same deployment, theDNfrom their certificates must have the same Organization attributes (O’s), the Organizational Unit attributes (OU’s), and the Domain Components (DC’s).IftlsX509ClusterAuthDNOverrideis set for a member, the member can also use the override value when comparing theDNcomponents (O’s,OU’s, andDC’s) of the presented certificates. That is the member checks the presented certificates against itsnet.tls.clusterFile/net.tls.certificateKeyFile. If the DN does not match, the member checks the presented certificate against thetlsX509ClusterAuthDNOverridevalue.NOTEIf set, you must set this parameter on all members of the deployment.You can use this parameter for a rolling update of certificates to new certificates that contain a newDNvalue. See Rolling Update of x.509 Cluster Certificates that Contain New DN.For more information about membership certificate requirements, see Member Certificate Requirements for details.tlsX509ExpirationWarningThresholdDaysNew in version 4.4.**Default : 30Available for both
mongodandmongos.Starting in MongoDB 4.4,mongod/mongoslogs a warning on connection if the presented x.509 certificate expires within30days of themongod/mongossystem clock. Use thetlsX509ExpirationWarningThresholdDaysparameter to control the certificate expiration warning threshold:Increase the parameter value to trigger warnings farther ahead of the certificate expiration date.Decrease the parameter value to trigger warnings closer to the certificate expiration date.Set the parameter to0to disable the warning.This parameter has a minimum value of0.You can only settlsX509ExpirationWarningThresholdDaysduringmongod/mongosstartup using either:ThesetParameterconfiguration setting, orThemongod --setParameter/mongos --setParametercommand line option.See x.509 Certificates Nearing Expiry Trigger Warnings for more information on x.509 expiration warnings in MongoDB 4.4.For more information on x.509 certificate validity, see RFC 5280 4.1.2.5.sslWithholdClientCertificateDefault: falseDeprecated since version 4.2: Use
tlsWithholdClientCertificateinstead.Available for bothmongodandmongos.A TLS certificate is set for amongodormongoseither by the--tlsClusterFileoption or by the--tlsCertificateKeyFileoption when--tlsClusterFileis not set. If the TLS certificate is set, by default, the instance sends the certificate when initiating intra-cluster communications with othermongodormongosinstances in the deployment. SetsslWithholdClientCertificateto1ortrueto direct the instance to withhold sending its TLS certificate during these communications. Use this option with--tlsAllowConnectionsWithoutCertificates(to allow inbound connections without certificates) on all members of the deployment.sslWithholdClientCertificateis mutually exclusive with--clusterAuthMode x509.userCacheInvalidationIntervalSecsDefault: 30Available for
mongosonly.On amongosinstance, specifies the interval (in seconds) at which themongosinstance checks to determine whether the in-memory cache of user objects has stale data, and if so, clears the cache. If there are no changes to user objects,mongoswill not clear the cache.This parameter has a minimum value of1second and a maximum value of86400seconds (24 hours).authFailedDelayMsDefault: 0Available for both
mongodandmongos.New in version 3.4.ENTERPRISE FEATUREAvailable in MongoDB Enterprise only.The number of milliseconds to wait before informing clients that their authentication attempt has failed. This parameter may be in the range0to5000, inclusive.Setting this parameter makes brute-force login attacks on a database more time-consuming. However, clients waiting for a response from the MongoDB server still consume server resources, and this may adversely impact benign login attempts if the server is denying access to many other clients simultaneously.allowRolesFromX509CertificatesDefault: trueAvailable for both
mongodandmongos.Available starting in MongoDB 4.0.11 (and 3.6.14 and 3.4.22)A boolean flag that allows or disallows the retrieval of authorization roles from client x.509 certificates.You can only setallowRolesFromX509Certificatesduring startup in the config file or on the command line.General Parameters
connPoolMaxShardedConnsPerHostDefault: 200Available for both
mongodandmongos.Sets the maximum size of the legacy connection pools for communication to the shards. The size of a pool does not prevent the creation of additional connections, but does prevent the connection pools from retaining connections above this limit.NOTEThe parameter is separate from the connections in TaskExecutor pools. SeeShardingTaskExecutorPoolMaxSize.Increase theconnPoolMaxShardedConnsPerHostvalue only if the number of connections in a connection pool has a high level of churn or if the total number of created connections increase.You can only setconnPoolMaxShardedConnsPerHostduring startup in the config file or on the command line. For example:copycopiedmongos --setParameter connPoolMaxShardedConnsPerHost=250connPoolMaxShardedInUseConnsPerHostNew in version 3.6.3.Available for both
mongodandmongos.Sets the maximum number of in-use connections at any given time for the legacy sharded cluster connection pools.By default, the parameter is unset.You can only setconnPoolMaxShardedConnsPerHostduring startup in the config file or on the command line. For example:copycopiedmongos --setParameter connPoolMaxShardedInUseConnsPerHost=100SEE ALSOconnPoolMaxShardedConnsPerHostshardedConnPoolIdleTimeoutMinutesNew in version 3.6.3.Available for both
mongodandmongos.Sets the time limit that a connection in the legacy sharded cluster connection pool can remain idle before being closed.By default, the parameter is unset.You can only setshardedConnPoolIdleTimeoutMinutesduring startup in the config file or on the command line. For example:copycopiedmongos --setParameter shardedConnPoolIdleTimeoutMinutes=10SEE ALSOconnPoolMaxShardedConnsPerHostconnPoolMaxConnsPerHostDefault: 200Available for both
mongodandmongos.Sets the maximum size of the legacy connection pools for outgoing connections to othermongodinstances in the global connection pool. The size of a pool does not prevent the creation of additional connections, but does prevent a connection pool from retaining connections in excess of the value ofconnPoolMaxConnsPerHost.NOTEThe parameter is separate from the connections in TaskExecutor pools. SeeShardingTaskExecutorPoolMaxSize.Only adjust this setting if your driver does not pool connections and you’re using authentication in the context of a sharded cluster.You can only setconnPoolMaxConnsPerHostduring startup in the config file or on the command line. For example:copycopiedmongod --setParameter connPoolMaxConnsPerHost=250connPoolMaxInUseConnsPerHostNew in version 3.6.3.Available for both
mongodandmongos.Sets the maximum number of in-use connections at any given time for for outgoing connections to othermongodinstances in the legacy global connection pool.By default, the parameter is unset.You can only setconnPoolMaxInUseConnsPerHostduring startup in the config file or on the command line. For example:copycopiedmongod --setParameter connPoolMaxInUseConnsPerHost=100SEE ALSOconnPoolMaxConnsPerHostglobalConnPoolIdleTimeoutMinutesNew in version 3.6.3.Available for both
mongodandmongos.Sets the time limit that connection in the legacy global connection pool can remain idle before being closed.By default, the parameter is unset.You can only setglobalConnPoolIdleTimeoutMinutesduring startup in the config file or on the command line. For example:copycopiedmongos --setParameter globalConnPoolIdleTimeoutMinutes=10SEE ALSOconnPoolMaxShardedConnsPerHostcursorTimeoutMillisDefault: 600000 (i.e. 10 minutes)Available for both
mongodandmongos.Sets the expiration threshold in milliseconds for idle cursors before MongoDB removes them; i.e. MongoDB removes cursors that have been idle for the specifiedcursorTimeoutMillis.For example, the following sets thecursorTimeoutMillisto300000milliseconds (i.e. 5 minutes).copycopiedmongod --setParameter cursorTimeoutMillis=300000Or, if using thesetParametercommand within themongoshell:copycopieddb.adminCommand( { setParameter: 1, cursorTimeoutMillis: 300000 } )SettingcursorTimeoutMillisto less than or equal to0results in all cursors being immediately eligible for timeout. Generally, the timeout value should be greater than the average amount of time for a query to return results. Use tools like thecursor.explain()cursor modifier to analyze the average query time and select an appropriate timeout period.failIndexKeyTooLongRemoved in 4.4IMPORTANTMongoDB 4.4 removes the deprecated
failIndexKeyTooLongparameter. Attempting to use this parameter with MongoDB 4.4 will result in an error.MongoDB 4.2 deprecates thefailIndexKeyTooLongparameter and removes theIndex Key Length Limitfor featureCompatibilityVersion (fCV) set to"4.2"or greater.For MongoDB 2.6 through MongoDB versions with featureCompatibilityVersion (fCV) set to"4.0"or earlier,Index Key Length Limitapplies. If you attempt to insert or update a document whose index field exceeds theIndex Key Length Limit, the operation will fail and return an error to the client.To avoid this issue, consider using hashed indexes or indexing a computed value. If you have an existing data set and want to disable this behavior so you can upgrade and then gradually resolve these indexing issues, you can usefailIndexKeyTooLongto disable this behavior.SettingfailIndexKeyTooLongtofalseis a temporary workaround, not a permanent solution to the problem of oversized index keys. WithfailIndexKeyTooLongset tofalse, queries can return incomplete results if they use indexes that skip over documents whose indexed fields exceed theIndex Key Length Limit.failIndexKeyTooLongdefaults totrue.Issue the following command to disable the index key length validation:copycopieddb.adminCommand( { setParameter: 1, failIndexKeyTooLong: false } )You can also setfailIndexKeyTooLongat startup time with the following option:copycopiedmongod --setParameter failIndexKeyTooLong=falsenotablescanAvailable for
mongodonly.Specify whether all queries must use indexes. If1, MongoDB will not execute queries that require a collection scan and will return an error.Consider the following example which setsnotablescanto1or true:copycopieddb.adminCommand( { setParameter: 1, notablescan: 1 } )Settingnotablescanto1can be useful for testing application queries, for example, to identify queries that scan an entire collection and cannot use an index.To detect unindexed queries withoutnotablescan, consider reading the Evaluate Performance of Current Operations and Optimize Query Performance sections and using thelogLevelparameter, mongostat and profiling.Don’t run productionmongodinstances withnotablescanbecause preventing collection scans can potentially affect queries in all databases, including administrative queries.ttlMonitorEnabledAvailable for
mongodonly.To support TTL Indexes,mongodinstances have a background thread that is responsible for deleting documents from collections with TTL indexes.To disable this worker thread for amongod, setttlMonitorEnabledtofalse, as in the following operations:copycopieddb.adminCommand( { setParameter: 1, ttlMonitorEnabled: false } )Alternately, you may disable the thread at startup time by starting themongodinstance with the following option:copycopiedmongod --setParameter ttlMonitorEnabled=falsetcpFastOpenServerNew in version 4.4.Available for both
mongodandmongos.Default:trueEnables support for accepting inbound TCP Fast Open (TFO) connections to themongod/mongosfrom a client. TFO requires both the client andmongod/mongoshost machine support and enable TFO:WindowsThe following Windows operating systems support TFO:Microsoft Windows Server 2016 and later.Microsoft Windows 10 Update 1607 and later.macOSmacOS 10.11 (El Capitan) and later support TFO.LinuxLinux operating systems running Linux Kernel 3.7 or later can support inbound TFO.Set the value of/proc/sys/net/ipv4/tcp_fastopento enable inbound TFO connections:Set to2to enable only inbound TFO connections.Set to3to enable inbound and outbound TFO connections.This parameter has no effect if the host operating system does not support or is not configured to support TFO connections.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.See Support for TCP Fast Open for more information on MongoDB TFO support.SEE ALSORFC7413.tcpFastOpenClientNew in version 4.4.Available for both
mongodandmongos.Default:trueLinux Operating System OnlyEnables support for outbound TCP Fast Open (TFO) connections from themongod/mongosto a client. TFO requires both the client and themongod/mongoshost machine support and enable TFO.Linux operating systems running Linux Kernel 4.11 or later can support outbound TFO.Set the value of/proc/sys/net/ipv4/tcp_fastopento enable outbound TFO connections:1to enable only outbound TFO connections.3to enable inbound and outbound TFO connections.This parameter has no effect if the host operating system does not support or is not configured to support TFO connections.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.See Support for TCP Fast Open for more information on MongoDB TFO support.SEE ALSORFC7413.tcpFastOpenQueueSizeNew in version 4.4.Available for both
mongodandmongos.Default:1024As part of establishing a TCP Fast Open (TFO) connection, the client submits a valid TFO cookie to themongod/mongosbefore completion of the standard TCP 3-way handshake. Themongod/mongoskeeps a queue of all such pending TFO connections.ThetcpFastOpenQueueSizeparameter sets the size of the queue of pending TFO connections. While the queue is full, themongod/mongosfalls back to the normal three-way handshake for incoming client requests and ignores the presence of TFO cookies. Once the queue size falls back below the limit, themongod/mongosbegins accepting new TFO cookies.Increasing the default queue size may improve the effect of TFO on network performance. However, large queue sizes also increase the risk of server resource exhaustion due to excessive incoming TFO requests.Decreasing the default queue size may reduce the risk of resource server resource exhaustion due to excessive incoming TFO requests. However, small queue sizes may also reduce the effect of TFO on network performance.The minimum queue size is0. A queue of0effectively disables TFO.This parameter has no effect on host operating systems that do not support or are not configured for TFO connections. See Support for TCP Fast Open for more information on MongoDB TFO support.SEE ALSORFC7413 TCP Fast Open Section 5: Security ConsiderationsRFC7413 TCP Fast Open Section 6: TFO ApplicabilitydisableJavaScriptJITChanged in version 4.0: The JavaScript engine’s JIT compiler is now disabled by default.Available for
mongodonly.The MongoDB JavaScript engine uses SpiderMonkey, which implements Just-in-Time (JIT) compilation for improved performance when running scripts.To enable the JIT, setdisableJavaScriptJITtofalse, as in the following example:copycopieddb.adminCommand( { setParameter: 1, disableJavaScriptJIT: false } )NOTE$wherewill reuse existing JavaScript interpreter contexts, so changes todisableJavaScriptJITmay not take effect immediately for these operations.Alternately, you may enable the JIT at startup time by starting themongodinstance with the following option:copycopiedmongod --setParameter disableJavaScriptJIT=falsemaxIndexBuildMemoryUsageMegabytesNew in version 3.4.**Default:200 (For versions 4.2.3 and later)500 (For versions 4.2.2 and earlier)Limits the amount of memory that simultaneous index builds on one collection may consume for the duration of the builds. The specified amount of memory is shared between all indexes built using a single
createIndexescommand or its shell helperdb.collection.createIndexes().The memory consumed by an index build is separate from the WiredTiger cache memory (seecacheSizeGB).Index builds may be initiated either by a user command such as Create Index or by an administrative process such as an initial sync. Both are subject to the limit set bymaxIndexBuildMemoryUsageMegabytes.An initial sync operation populates only one collection at a time and has no risk of exceeding the memory limit. However, it is possible for a user to start index builds on multiple collections in multiple databases simultaneously and potentially consume an amount of memory greater than the limit set inmaxIndexBuildMemoryUsageMegabytes.TIPTo minimize the impact of building an index on replica sets and sharded clusters with replica set shards, use a rolling index build procedure as described on Rolling Index Builds on Replica Sets.Changed in version 4.2.For feature compatibility version (fcv)"4.2", the index build memory limit applies to all index builds.For feature compatibility version (fcv)"4.0", the index build memory limit only applies to foreground index builds.reportOpWriteConcernCountersInServerStatusNew in version 4.0.6.**Default: falseA boolean flag that determines whether the
db.serverStatus()method andserverStatuscommand returnopWriteConcernCountersinformation. [1]You can only setreportOpWriteConcernCountersInServerStatusduring startup in the config file or on the command line. For example:copycopiedmongod --setParameter reportOpWriteConcernCountersInServerStatus=true[1]EnablingreportOpWriteConcernCountersInServerStatuscan have a negative performance impact; specificaly, when running without TLS.watchdogPeriodSecondsAvailable for
mongodonly.Type: integerDefault: -1 (disabled)NOTEStarting in MongoDB 4.2, the Storage Node Watchdog is available in both the Community and MongoDB Enterprise editions.In earlier versions (3.2.16+, 3.4.7+, 3.6.0+, 4.0.0+), the Storage Node Watchdog is only available in MongoDB Enterprise edition.Determines how frequent the Storage Node Watchdog checks the status of the monitored filesystems:The--dbpathdirectoryThejournaldirectory inside the--dbpathdirectory ifjournalingis enabledThe directory of--logpathfileThe directory of--auditPathfileValid values forwatchdogPeriodSecondsare:-1(the default), to disable/pause Storage Node Watchdog, orAn integer greater than or equal to 60.NOTEIf a filesystem on a monitored directory becomes unresponsive, it can take a maximum of nearly twice the value ofwatchdogPeriodSecondsto terminate themongod.If any of its monitored directory is a symlink to other volumes, the Storage Node Watchdog does not monitor the symlink target. For example, if themongodusesstorage.directoryPerDB: true(or--directoryperdb) and symlinks a database directory to another volume, the Storage Node Watchdog does not follow the symlink to monitor the target.To enable Storage Node Watchdog,watchdogPeriodSecondsmust be set during startup.copycopiedmongod --setParameter watchdogPeriodSeconds=60You can only enable the Storage Node Watchdog at startup. However, once enabled, you can pause the Storage Node Watchdog or change thewatchdogPeriodSecondsduring runtime.Once enabled,To pause the Storage Node Watchdog during runtime, setwatchdogPeriodSecondsto -1.copycopieddb.adminCommand( { setParameter: 1, watchdogPeriodSeconds: -1 } )To resume or change the period during runtime, setwatchdogPeriodSecondsto a number greater than or equal to 60.copycopieddb.adminCommand( { setParameter: 1, watchdogPeriodSeconds: 120 } )NOTEIt is an error to setwatchdogPeriodSecondsat runtime if the Storage Node Watchdog was not enabled at startup time.tcmallocReleaseRateNew in version 4.2.3: Also available in 3.6.17+ and 4.0.14+Default: 1.0Specifies the tcmalloc release rate (TCMALLOC_RELEASE_RATE). Per https://gperftools.github.io/gperftools/tcmalloc.htmlruntime TCMALLOC_RELEASE_RATE is described as:Rate at which we release unused memory to the system, via madvise(MADV_DONTNEED), on systems that support it. Zero means we never release memory back to the system. Increase this flag to return memory faster; decrease it to return memory slower. Reasonable rates are in the range [0,10].—https://gperftools.github.io/gperftools/tcmalloc.htmlruntimeTo modify the release rate during runtime, you can use the
setParametercommand; for example:copycopieddb.adminCommand( { setParameter: 1, tcmallocReleaseRate: 5.0 } )You can also settcmallocReleaseRateat startup time; for example:copycopiedmongod --setParameter "tcmallocReleaseRate=5.0"Logging Parameters
logLevelAvailable for both
mongodandmongos.Specify an integer between0and5signifying the verbosity of the logging, where5is the most verbose. [2]The defaultlogLevelis0(Informational).The following example sets thelogLevelto2:copycopieddb.adminCommand( { setParameter: 1, logLevel: 2 } )SEE ALSOlogComponentVerbositysystemLog.verbosity[2]Starting in version 4.2, MongoDB includes the Debug verbosity level (1-5) in the log messages. For example, if the verbosity level is 2, MongoDB logsD2. In previous versions, MongoDB log messages only specifiedDfor Debug level.logComponentVerbosityAvailable for both
mongodandmongos.Sets the verbosity levels of various components for log messages. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. [3]The verbosity level can range from0to5:0is the MongoDB’s default log verbosity level, to include Informational messages.1to5increases the verbosity level to include Debug messages.For a component, you can also specify-1to inherit the parent’s verbosity level.To specify the verbosity level, use a document similar to the following:copycopied{ verbosity: <int>, <component1>: { verbosity: <int> }, <component2>: { verbosity: <int>, <component3>: { verbosity: <int> } }, ... }For the components, you can specify just the<component>: <int>in the document, unless you are setting both the parent verbosity level and that of the child component(s) as well:copycopied{ verbosity: <int>, <component1>: <int> , <component2>: { verbosity: <int>, <component3>: <int> } ... }The top-levelverbosityfield corresponds tosystemLog.verbositywhich sets the default level for all components. The default value ofsystemLog.verbosityis0.The components correspond to the following settings:accessControlcommandcontrolftdcgeoindexnetworkqueryreplicationreplication.electionreplication.heartbeatsreplication.initialSyncreplication.rollbackrecoveryshardingstoragestorage.journaltransactionwriteUnless explicitly set, the component has the verbosity level of its parent. For example,storageis the parent ofstorage.journal. That is, if you specify astorageverbosity level, this level also applies to:storage.journalcomponents unless you specify the verbosity level forstorage.journal.storage.recoverycomponents unless you specify the verbosity level forstorage.recovery.For example, the following sets thedefault verbosity levelto1, thequeryto2, thestorageto2, and thestorage.journalto1.copycopieddb.adminCommand( { setParameter: 1, logComponentVerbosity: { verbosity: 1, query: { verbosity: 2 }, storage: { verbosity: 2, journal: { verbosity: 1 } } } } )You can also set parameterlogComponentVerbosityat startup time, passing the verbosity level document as a string.copycopiedmongod --setParameter "logComponentVerbosity={command: 3}"Themongoshell also provides thedb.setLogLevel()to set the log level for a single component. For various ways to set the log verbosity level, see Configure Log Verbosity Levels.[3]Starting in version 4.2, MongoDB includes the Debug verbosity level (1-5) in the log messages. For example, if the verbosity level is 2, MongoDB logsD2. In previous versions, MongoDB log messages only specifiedDfor Debug level.maxLogSizeKBNew in version 3.4.Available for both
mongodandmongos.Type: non-negative integerDefault: 10Specifies the maxium size, in kilobytes, for an individual attribute field in a log entry; attributes exceeding this limit are truncated.Truncated attribute fields print field content up to themaxLogSizeKBlimit and excise field content past that limit, retaining valid JSON formating. Log entires that contain truncated attributes append atruncatedobject to the end of the log entry.See log message truncation for more information.A value of0disables truncation entirely. Negative values for this parameter are not valid.WARNINGUsing a large value, or disabling truncation with a value of0, may adversely affect system performance and negatively impact database operations.The following example sets the maximum log line size to20kilobytes:copycopiedmongod --setParameter maxLogSizeKB=20quietAvailable for both
mongodandmongos.Sets quiet logging mode. If1,mongodwill go into a quiet logging mode which will not log the following events/activities:connection events;thedropcommand, thedropIndexescommand, thediagLoggingcommand, thevalidatecommand, and thecleancommand; andreplication synchronization activities.Consider the following example which sets thequietto1:copycopieddb.adminCommand( { setParameter: 1, quiet: 1 } )SEE ALSOsystemLog.quietredactClientLogDataNew in version 3.4.Available for both
mongodandmongos.Type: booleanENTERPRISE FEATUREAvailable in MongoDB Enterprise only.Configure themongodormongosto redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.UseredactClientLogDatain conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.To enable log redaction on a runningmongodormongos, use the following command:copycopieddb.adminCommand( { setParameter: 1, redactClientLogData : true } )SEE ALSOsecurity.redactClientLogDatatraceExceptionsAvailable for both
mongodandmongos.Configuresmongodto log full source code stack traces for every database and socket C++ exception, for use with debugging. Iftrue,mongodwill log full stack traces.Consider the following example which sets thetraceExceptionstotrue:copycopieddb.adminCommand( { setParameter: 1, traceExceptions: true } )SEE ALSOsystemLog.traceAllExceptionssuppressNoTLSPeerCertificateWarningNew in version 4.0.1.Available for both
mongodandmongos.Type: booleanDefault: falseBy default, amongodormongoswith TLS/SSL enabled andnet.ssl.allowConnectionsWithoutCertificates:truelets clients connect without providing a certificate for validation while logging an warning. SetsuppressNoTLSPeerCertificateWarningto1ortrueto suppress those warnings.The following operation setssuppressNoTLSPeerCertificateWarningtotrue:copycopieddb.adminCommand( { setParameter: 1, suppressNoTLSPeerCertificateWarning: true} )
Diagnostic Parameters
To facilitate analysis of the MongoDB server behavior by MongoDB engineers, MongoDB logs server statistics to diagnostic files at periodic intervals.
For mongod, the diagnostic data files are stored in the diagnostic.data directory under the mongod instance’s --dbpath or storage.dbPath.
For mongos, the diagnostic data files, by default, are stored in a directory under the mongos instance’s --logpath or systemLog.path directory. The diagnostic data directory is computed by truncating the logpath’s file extension(s) and concatenating diagnostic.data to the remaining name.
For example, if mongos has --logpath /var/log/mongodb/mongos.log.201708015, then the diagnostic data directory is /var/log/mongodb/mongos.diagnostic.data/ directory. To specify a different diagnostic data directory for mongos, set the diagnosticDataCollectionDirectoryPath parameter.
The following parameters support diagnostic data capture (FTDC):
NOTE
The default values for the diagnostic data capture interval and the maximum sizes are chosen to provide useful data to MongoDB engineers with minimal impact on performance and storage size. Typically, these values will only need modifications as requested by MongoDB engineers for specific diagnostic purposes.
diagnosticDataCollectionEnabledNew in version 3.2.**Changed in version 3.4.14: Available for both
mongodandmongos.Type: booleanDefault: trueDetermines whether to enable the collecting and logging of data for diagnostic purposes. Diagnostic logging is enabled by default.For example, the following disables the diagnostic collection:copycopiedmongod --setParameter diagnosticDataCollectionEnabled=falsediagnosticDataCollectionDirectoryPathNew in version 3.4.14.**Type: StringAvailable for
mongosonly.Specify the directory for the diagnostic directory formongos. If the directory does not exist,mongoscreates the directory.If unspecified, the diagnostic data directory is computed by truncating themongosinstance’s--logpathorsystemLog.pathfile extension(s) and concatenatingdiagnostic.data.For example, ifmongoshas--logpath /var/log/mongodb/mongos.log.201708015, then the diagnostic data directory is/var/log/mongodb/mongos.diagnostic.data/.IMPORTANTIfmongoscannot create the specified directory, e.g. a file exists with the same name in the path or the process does not have permissions to create the directory, the diagnostic data capture will be disabled for that instance.diagnosticDataCollectionDirectorySizeMBNew in version 3.2.**Changed in version 3.4: Increased default size to 200 megabytes.Changed in version 3.4.14: Available for both
mongodandmongos.Type: integerDefault: 200Specifies the maximum size, in megabytes, of thediagnostic.datadirectory. If directory size exceeds this number, the oldest diagnostic files in the directory are automatically deleted based on the timestamp in the file name.For example, the following sets the maximum size of the directory to250megabytes:copycopiedmongod --setParameter diagnosticDataCollectionDirectorySizeMB=250The minimum value fordiagnosticDataCollectionDirectorySizeMBis10megabytes.diagnosticDataCollectionDirectorySizeMBmust be greater than maximum diagnostic file sizediagnosticDataCollectionFileSizeMB.diagnosticDataCollectionFileSizeMBNew in version 3.2.**Changed in version 3.4.14: Available for both
mongodandmongos.Type: integerDefault: 10Specifies the maximum size, in megabytes, of each diagnostic file. If the file exceeds the maximum file size, MongoDB creates a new file.For example, the following sets the maximum size of each diagnostic file to20megabytes:copycopiedmongod --setParameter diagnosticDataCollectionFileSizeMB=20The minimum value fordiagnosticDataCollectionFileSizeMBis1megabyte.diagnosticDataCollectionPeriodMillisNew in version 3.2.**Changed in version 3.4.14: Available for both
mongodandmongos.Type: integerDefault: 1000Specifies the interval, in milliseconds, at which to collect diagnostic data.For example, the following sets the interval to5000milliseconds or 5 seconds:copycopiedmongod --setParameter diagnosticDataCollectionPeriodMillis=5000The minimum value fordiagnosticDataCollectionPeriodMillisis100milliseconds.Logical Session
logicalSessionRefreshMillisAVAILABILITYNew in version 4.0.4 (and version 3.6.9).Available for both
mongodandmongos.Type: integerDefault: 300000 (i.e. 5 minutes)The interval (in milliseconds) at which the cache refreshes its logical session records against the main session store.You can only setlogicalSessionRefreshMillisat startup and cannot change this setting with thesetParametercommand.For example, to set thelogicalSessionRefreshMillisfor amongodinstance to 10 minutes:copycopiedmongod --setParameter logicalSessionRefreshMillis=600000localLogicalSessionTimeoutMinutesNew in version 3.6.Available for both
mongodandmongos.Type: integerDefault: 30FOR TESTING PURPOSES ONLYThis parameter is intended for testing purposes only and not for production use.The time in minutes that a session remains active after its most recent use. Sessions that have not received a new read/write operation from the client or been refreshed withrefreshSessionswithin this threshold are cleared from the cache. State associated with an expired session may be cleaned up by the server at any time.This parameter applies only to the instance on which it is set. To set this parameter on replica sets and sharded clusters, you must specify the same value on every member; otherwise, sessions will not function properly.You can only setlocalLogicalSessionTimeoutMinutesat startup and cannot change this setting with thesetParametercommand.For example, to set thelocalLogicalSessionTimeoutMinutesfor a testmongodinstance to 20 minutes:copycopiedmongod --setParameter localLogicalSessionTimeoutMinutes=20maxAcceptableLogicalClockDriftSecsNew in version 3.6.Available for both
mongodandmongos.Type: integerDefault: 31536000 (1 year)The maximum amount by which the current cluster time can be advanced; i.e.,maxAcceptableLogicalClockDriftSecsis the maximum difference between the new value of the cluster time and the current cluster time. Cluster time is a logical time used for ordering of operations.You cannot advance the cluster time to a new value if the new cluster time differs from the current cluster time by more thanmaxAcceptableLogicalClockDriftSecs,You can only setmaxAcceptableLogicalClockDriftSecsat startup and cannot change this setting with thesetParametercommand.For example, to set themaxAcceptableLogicalClockDriftSecsfor amongodinstance to 15 minutes:copycopiedmongod --setParameter maxAcceptableLogicalClockDriftSecs=900maxSessionsNew in version 4.0.1.Available for both
mongodandmongos.Type: integerDefault: 1000000The maximum number of sessions that can be cached.You can only setmaxSessionsduring start-up.For example, to set themaxSessionsfor amongodinstance to 1000:copycopiedmongod --setParameter maxSessions=1000TransactionRecordMinimumLifetimeMinutesNew in version 3.6.Available for
mongodonly.Type: integerDefault: 30The minimum lifetime a transaction record exists in thetransactionscollection before the record becomes eligible for cleanup.You can only setTransactionRecordMinimumLifetimeMinutesat startup and cannot change this setting with thesetParametercommand.For example, to set theTransactionRecordMinimumLifetimeMinutesfor amongodinstance to 20 minutes:copycopiedmongod --setParameter TransactionRecordMinimumLifetimeMinutes=20SEE ALSOlocalLogicalSessionTimeoutMinutesReplication Parameters
enableFlowControlNew in version 4.2.**Type: booleanDefault: trueEnables or disables the mechanism that controls the rate at which the primary applies its writes with the goal of keeping the secondary members’
majority committedlag under a configurable maximum value.NOTEFor flow control to engage, the replica set/sharded cluster must have: featureCompatibilityVersion (FCV) of4.2and read concernmajority enabled. That is, enabled flow control has no effect if FCV is not4.2or if read concern majority is disabled.flowControlTargetLagSecondsNew in version 4.2.**Type: integerDefault: 10The target maximum
majority committedlag when running with flow control. When flow control is enabled, the mechanism attempts to keep themajority committedlag under the specified seconds. The parameter has no effect if flow control is disabled.The specified value must be greater than 0.In general, the default settings should suffice; however, if modifying from the default value, decreasing, rather than increasing, the value may prove to be more useful.flowControlWarnThresholdSecondsNew in version 4.2.**Type: integerDefault: 10The amount of time to wait to log a warning once the flow control mechanism detects the majority commit point has not moved.The specified value must be greater than or equal to 0, with 0 to disable warnings.
initialSyncTransientErrorRetryPeriodSecondsNew in version 4.4.**Type: integerDefault: 86400The amount of time in seconds a secondary performing initial sync attempts to resume the process if interrupted by a transient network error. The default value is equivalent to 24 hours.
initialSyncSourceReadPreferenceNew in version 4.4.**Type: StringAvailable for
mongodonly.The preferred source for performing initial sync. Specify one of the following read preference modes:primaryprimaryPreferred(Default for voting replica set members)secondarysecondaryPreferrednearest(Default for newly added or non-voting replica set members)If the replica set has disabledchaining, the defaultinitialSyncSourceReadPreferenceread preference mode isprimary.You cannot specify a tag set ormaxStalenessSecondstoinitialSyncSourceReadPreference.If themongodcannot find a sync source based on the specified read preference, it logs an error and restarts the initial sync process. Themongodexits with an error if it cannot complete the initial sync process after10attempts. For more information on sync source selection, see Initial Sync Source Selection.initialSyncSourceReadPreferencetakes precedence over the replica set’ssettings.chainingAllowedsetting when selecting an initial sync source. After a replica set member successfully completes initial sync, it defers to the value ofchainingAllowedwhen selecting a replication sync source.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.oplogFetcherUsesExhaustNew in version 4.4.Available for
mongodonly.Type: booleanDefault: trueEnables or disables streaming replication. Set the value totrueto enable streaming replication.Set the value tofalseto disable streaming replication. If disabled, secondaries fetch batches of oplog entries by issuing a request to their sync from source and waiting for a response. This requires a network roundtrip for each batch of oplog entries.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.oplogInitialFindMaxSecondsNew in version 3.6.**Type: integerDefault: 60Available for
mongodonly.Maximum time in seconds for a member of a replica set to wait for thefindcommand to finish during data synchronization.replWriterThreadCountNew in version 3.2.**Type: integerDefault: 16Available for
mongodonly.Number of threads to use to apply replicated operations in parallel. Values can range from 1 to 256 inclusive. You can only setreplWriterThreadCountat startup and cannot change this setting with thesetParametercommand.rollbackTimeLimitSecsType: 64-bit integerDefault: 86400 (1 day)Maximum age of data that can be rolled back. Negative values for this parameter are not valid.Starting in MongoDB 4.2+ and 4.0.13+, if the time between the end of the to-be-rolledback instance’s oplog and the first operation after the common point (the last point where the source node and the to-be-rolledback node had the same data) exceeds this value, the rollback will fail.In MongoDB 4.0.0-4.0.12, if the time between the end of the to-be-rolledback instance’s oplog and the common point (the last point where the source node and the to-be-rolledback node had the same data) exceeds this value, the rollback will fail.To effectively have an unlimited rollback period, set the value to
2147483647which is the maximum value allowed and equivalent to roughly 68 years.New in version 4.0.waitForSecondaryBeforeNoopWriteMSNew in version 3.6.Available for
mongodonly.Type: integerDefault: 10The length of time (in milliseconds) that a secondary must wait if theafterClusterTimeis greater than the last applied time from the oplog. After thewaitForSecondaryBeforeNoopWriteMSpasses, if theafterClusterTimeis still greater than the last applied time, the secondary makes a no-op write to advance the last applied time.The following example sets thewaitForSecondaryBeforeNoopWriteMSto 20 milliseconds:copycopiedmongod --setParameter waitForSecondaryBeforeNoopWriteMS=20During runtime, you can also set the parameter with thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, waitForSecondaryBeforeNoopWriteMS: 20 } )createRollbackDataFilesAvailable for
mongodonly.Type: booleanDefault: trueNew in version 4.0.Flag that determines whether MongoDB creates rollback files that contains documents affected during a rollback.By default,createRollbackDataFilesistrueand MongoDB creates the rollback files.The following example setscreateRollbackDataFilesto false so that the rollback files are not created:copycopiedmongod --setParameter createRollbackDataFiles=falseDuring runtime, you can also set the parameter with thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, createRollbackDataFiles: false } )For more information, see Collect Rollback Data.enableElectionHandoffNew in version 4.0.2.**Type: booleanDefault: trueA flag that can reduce the downtime after the primary steps down from either the
rs.stepDown()method or thereplSetStepDowncommand. Specifically, if true, when a primary steps down afterrs.stepDown()(or thereplSetStepDowncommand without theforce: true), it nominates an eligible secondary to call an election immediately. If false, after the step down, secondaries can wait up tosettings.electionTimeoutMillisbefore calling an election.An eligible secondary must be caught up with the stepped down primary and haveprioritygreater than 0. If multiple secondary members meet this criteria, the stepped down primary selects the eligible secondary with the highestpriority. If the more than one eligible secondary members have the samepriority, the stepped down primary selects the secondary with the lowest_id. The stepped down primary does not wait for the effects of the handoff.The parameter has no impact if the primary steps down for reasons other thanrs.stepDown()(or thereplSetStepDowncommand without theforce: true).replBatchLimitBytesDefault: 104857600 (100MB)Sets the maximum oplog application batch size in bytes.Values can range from 16777216 (16MB) to 104857600 (100MB) inclusive.The following example sets
replBatchLimitBytesto 64 MB so that the rollback files are not created:copycopiedmongod --setParameter replBatchLimitBytes=67108864During runtime, you can also set the parameter with thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, replBatchLimitBytes: 64 * 1024 * 1024 } )New in version 4.0.10.mirrorReadsAvailable for
mongodonly.New in version 4.4**Type: DocumentDefault:{ samplingRate: 0.01, maxTimeMS: 1000 }Specifies the settings for mirrored reads for themongodinstance. The settings only take effect when the member is a primary.The parametermirrorReadstakes a JSON document with the following fields:FieldDescriptionsamplingRateThe sampling rate used to mirror a subset of operations that support mirroring to a subset of electable (i.e.priority greater than 0) secondaries. That is, the primary mirrors reads to each electable secondary at the specified sampling rate.Valid values are:0.0Turns off mirroring.1.0The primary mirrors all operations that supports mirroring to each electable secondary.Number between0.0and1.0(exclusive)The primary randomly samples each electable secondary at the specified rate to be sent mirrored reads.For example, given a replica set with a primary and two electable secondaries and a sampling rate of0.10, the primary mirrors reads to each electable secondary at the sampling rate of 10 percent such that one read may be mirrored to one secondary and not to the other or to both or to neither. That is, if the primary receives100operations that can be mirrored, the sampling rate of0.10may result in8reads being mirrored to one secondary and13reads to the other or10to each, etc.The default value is0.01.maxTimeMSThe maximum time in milliseconds for the mirrored reads. The default value is1000.ThemaxTimeMSfor the mirrored reads is separate from themaxTimeMSof the original read being mirrored.You can setmirrorReadsduring startup in theconfiguration fileor with the--setParameteroption on the command line. If specifying from the configuration file or on the command line, enclose themirrorReadsdocument in quotes.For example, the following sets the mirror reads sampling rate to0.10from the command line:copycopiedmongod --setParameter mirrorReads='{ samplingRate: 0.10 }'Or, to specify in a configuration file:copycopiedsetParameter: mirrorReads: '{samplingRate: 0.10}'Or if using thesetParametercommand in amongoshell connected to a runningmongod, do not enclose the document in quotes:copycopieddb.adminCommand( { setParameter: 1, mirrorReads: { samplingRate: 0.10 } } )Sharding Parameters
NOTE
Starting in version 4.2, MongoDB removes the parameter AsyncRequestsSenderUseBaton and always enables the performance enhancement controlled by the parameter.
disableResumableRangeDeleterNew in version 4.4.**Type: booleanDefault: falseAvailable for
mongodonly.If set on a shard’s primary, specifies if range deletion is paused on the shard. If set totrue, cleanup of chunkranges containing :term:orphaned documents is paused. The shard can continue to donate chunks to other shards, but the donated documents will not be removed from this shard until you set this parameter tofalse. This shard can continue to receive chunks from other shards as long as it does not have a pending range deletion task in theconfig.rangeDeletionscollection that overlaps with the incoming chunk’s range.WhendisableResumableRangeDeleteristrue, chunk migrations fail if orphaned documents exist on the recipient shard’s primary in the same range as the incoming chunks.The parameter has no effect on themongodif it is not the shard’s primary.IMPORTANTIf you setdisableResumableRangeDeleterparameter totrue, ensure that you apply it consistently for all members in the shard’s replica set. In the event of a failover, this setting’s value on the new primary dictates the behavior of the range deleter.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongod --setParameter disableResumableRangeDeleter=falseenableShardedIndexConsistencyCheckNew in version 4.4 (and 4.2.6).**Type: booleanDefault: trueAvailable for
mongodonly.If set on the config server’s primary, enables or disables the index consistency check for sharded collections. The parameter has no effect on themongodif it is not the config server’s primary.The following example setsenableShardedIndexConsistencyChecktofalsefor a config server primary:copycopiedmongod --setParameter enableShardedIndexConsistencyCheck=falseDuring runtime, you can also set the parameter with thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, enableShardedIndexConsistencyCheck: false } )SEE ALSOshardedIndexConsistencyCheckIntervalMSparametershardedIndexConsistencymetrics returned by theserverStatuscommand.shardedIndexConsistencyCheckIntervalMSNew in version 4.4 (and 4.2.6).**Type: integerDefault: 600000Available for
mongodonly.If set on the config server’s primary, the interval, in milliseconds, at which the config server’s primary checks the index consistency of sharded collections. The parameter has no effect on themongodif it is not the config server’s primary.You can only set the parameter during startup, and cannot change this setting using thesetParameterdatabase command.For example, the following sets the interval at 300000 milliseconds (i.e. 5 minutes) at startup:copycopiedmongod --setParameter shardedIndexConsistencyCheckIntervalMS=300000SEE ALSOenableShardedIndexConsistencyCheckparametershardedIndexConsistencymetrics returned by theserverStatuscommandqenableFinerGrainedCatalogCacheRefreshNew in version 4.4.**Type: booleanDefault: trueAvailable for both
mongodandmongos.This parameter allows the catalog cache to be refreshed only if the shard needs to be refreshed. If disabled, any stale chunk will cause the entire chunk distribution for a collection to be considered stale and force all routers who contact the shard to refresh their shard catalog cache.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongod --setParameter enableFinerGrainedCatalogCacheRefresh=true mongos --setParameter enableFinerGrainedCatalogCacheRefresh=trueSEE ALSOShardingshardingStatistics.catalogCachemaxTimeMSForHedgedReadsNew in version 4.4.**Type: integerDefault: 150Available for
mongosonly.Specifies the maximimum time limit (in milliseconds) for the hedged read. That is, the additional read sent to hedge the read operation uses themaxTimeMSvalue ofmaxTimeMSForHedgedReadswhile the read operation that is being hedged uses themaxTimeMSvalue specified for the operation.For example, to set the limit to 200 milliseconds, you can issue the following during startup:copycopiedmongos --setParameter maxTimeMSForHedgedReads=200Or if using thesetParametercommand in amongoshell connected to a runningmongos:copycopieddb.adminCommand( { setParameter: 1, maxTimeMSForHedgedReads: 200 } )SEE ALSOreadHedgingModeHedged ReadsreadHedgingModeNew in version 4.4.**Type: stringDefault: onAvailable for
mongosonly.Specifies whethermongossupports hedged reads for those read operations whose read preference have enabled the hedged read option.Available values are:ValueDescriptiononThemongosinstance supports hedged reads for read operations whose read preference have enabled the hedged read option.offThemongosinstance does not support hedged reads. That is, hedged reads are unavailable, even for read operations whose read preference have enabled the hedged read option.For example, to turn off hedged read support for amongosinstance, you can issue the following during startup:copycopiedmongos --setParameter readHedgingMode=offOr if using thesetParametercommand in amongoshell connected to a runningmongos:copycopieddb.adminCommand( { setParameter: 1, readHedgingMode: "off" } )SEE ALSOHedged ReadsmaxTimeMSForHedgedReadsreplMonitorMaxFailedChecksAvailable in MongoDB 3.2 onlyType: integerDefault: 30The number of times the
mongodormongosinstance tries to reach the replica sets in the sharded cluster (e.g. shard replica sets, config server replica set) to monitor the replica set status and topology.When the number of consecutive unsuccessful attempts exceeds this parameter value, themongodormongosinstance denotes the monitored replica set as unavailable. If the monitored replica set is the config server replica set:For MongoDB 3.2.0-3.2.9, the monitoringmongodormongosinstance will become unusable and needs to be restarted. See the v3.2 troubleshooting guide for more details.For MongoDB 3.2.10 and later 3.2-series, see alsotimeOutMonitoringReplicaSets.timeOutMonitoringReplicaSetsAvailable in MongoDB 3.2.10 and later 3.2-series onlyType: integerDefault: falseThe flag that determines whether the
mongodormongosinstance should stop its attempt to reach the monitored replica set after unsuccessfully tryingreplMonitorMaxFailedChecksnumber of times.If the monitored replica set is the config server replica set andtimeOutMonitoringReplicaSetsis set totrue, you must restartmongodormongosif themongodormongosinstance cannot reach any of the config servers for the specified number of times. See the v3.2 troubleshooting guide for more details.ShardingTaskExecutorPoolHostTimeoutMSType: integerDefault: 300000 (i.e. 5 minutes)Available for
mongosonly.Maximum time thatmongosgoes without communication to a host beforemongosdrops all connections to the host.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.If set,ShardingTaskExecutorPoolHostTimeoutMSshould be greater than the sum ofShardingTaskExecutorPoolRefreshRequirementMSandShardingTaskExecutorPoolRefreshTimeoutMS. Otherwise,mongosadjusts the value ofShardingTaskExecutorPoolHostTimeoutMSto be greater than the sum.copycopiedmongos --setParameter ShardingTaskExecutorPoolHostTimeoutMS=120000ShardingTaskExecutorPoolMaxConnectingNew in version 3.6.Type: integerDefault: 2Available for
mongosonly.Maximum number of simultaneous initiating connections (including pending connections in setup/refresh state) each TaskExecutor connection pool can have to amongodinstance. You can set this parameter to control the rate at whichmongosadds connections to amongodinstance.If set,ShardingTaskExecutorPoolMaxConnectingshould be less than or equal toShardingTaskExecutorPoolMaxSize. If it is greater,mongosignores theShardingTaskExecutorPoolMaxConnectingvalue.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongos --setParameter ShardingTaskExecutorPoolMaxConnecting=20ShardingTaskExecutorPoolMaxSizeType: integerDefault: 264 - 1Available for
mongosonly.Maximum number of outbound connections each TaskExecutor connection pool can open to any givenmongodinstance. The maximum possible connections to any given host across all TaskExecutor pools is:copycopiedShardingTaskExecutorPoolMaxSize * taskExecutorPoolSizeYou can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongos --setParameter ShardingTaskExecutorPoolMaxSize=4mongoscan have up tonTaskExecutor connection pools, wherenis the number of cores. SeetaskExecutorPoolSize.SEE ALSOShardingTaskExecutorPoolMinSizeShardingTaskExecutorPoolMinSizeType: integerDefault: 1Available for both
mongodandmongos.Minimum number of outbound connections each TaskExecutor connection pool can open to any givenmongodinstance.ShardingTaskExecutorPoolMinSizeconnections are created the first time a connection to a new host is requested from the pool. While the pool is idle, the pool maintains this number of connections untilShardingTaskExecutorPoolHostTimeoutMSmilliseconds pass without any application using that pool.For amongosusing thewarmMinConnectionsInShardingTaskExecutorPoolOnStartupparameter, theShardingTaskExecutorPoolMinSizeparameter also controls how many connections to each shard host are established on startup of themongosinstance before it begins accepting incoming client connections.NOTEIn MongoDB 4.4, thewarmMinConnectionsInShardingTaskExecutorPoolOnStartupparameter is enabled by default for themongos.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongos --setParameter ShardingTaskExecutorPoolMinSize=2mongoscan have up tonTaskExecutor connection pools, wherenis the number of cores. SeetaskExecutorPoolSize.SEE ALSOShardingTaskExecutorPoolMaxSizewarmMinConnectionsInShardingTaskExecutorPoolOnStartupShardingTaskExecutorPoolRefreshRequirementMSType: integerDefault: 60000 (1 minute)Available for
mongosonly.Maximum time themongoswaits before attempting to heartbeat a resting connection in the pool.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.If set,ShardingTaskExecutorPoolRefreshRequirementMSshould be greater thanShardingTaskExecutorPoolRefreshTimeoutMS. Otherwise,mongosadjusts the value ofShardingTaskExecutorPoolRefreshTimeoutMSto be less thanShardingTaskExecutorPoolRefreshRequirementMS.copycopiedmongos --setParameter ShardingTaskExecutorPoolRefreshRequirementMS=90000ShardingTaskExecutorPoolRefreshTimeoutMSType: integerDefault: 20000 (20 seconds)Available for
mongosonly.Maximum time themongoswaits for a heartbeat before timing out the heartbeat.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.If set,ShardingTaskExecutorPoolRefreshTimeoutMSshould be less thanShardingTaskExecutorPoolRefreshRequirementMS. Otherwise,mongosadjusts the value ofShardingTaskExecutorPoolRefreshTimeoutMSto be less thanShardingTaskExecutorPoolRefreshRequirementMS.copycopiedmongos --setParameter ShardingTaskExecutorPoolRefreshTimeoutMS=30000ShardingTaskExecutorPoolReplicaSetMatchingNew in version 4.2.Type: stringDefault: “matchPrimaryNode”Available for
mongosonly.The policy that determines the minimum size limit of themongosinstance’s connection pools to the sharded cluster’s replica set secondaries.Available values are:Matching PolicyDescription"matchPrimaryNode"(Default)For each replica set in the sharded cluster (i.e. shard replica set and config servers), the minimum size limit of themongosinstance’s connection pool to each secondary of that replica set is equal to the size of its connection pool to the primary.In case of primary stepdown,matchPrimaryNodeensures that any secondary that becomes the primary can handle the current level of primary reads and writes."matchBusiestNode"For each replica set in the sharded cluster (i.e. shard replica set and config servers), the minimum size limit of themongosinstance’s connection pool to each member of that replica set is equal to the largest among the active connections counts to the primary and each secondary members.With"matchBusiestNode",mongosmaintains enough connections to each secondary to handle the current level of primary and secondary reads and writes. The number of connections to maintain in the pool decreases as the number of active connections decreases."disabled"For each replica set in the sharded cluster (i.e. shard replica set and config servers), the minimum number of connections in themongosinstance’s connection pool to each secondary is equal to theShardingTaskExecutorPoolMinSize.The following example sets theShardingTaskExecutorPoolReplicaSetMatchingto"matchBusiestNode"during startup:copycopiedmongod --setParameter ShardingTaskExecutorPoolReplicaSetMatching="matchBusiestNode"During runtime, you can also set the parameter with thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, ShardingTaskExecutorPoolReplicaSetMatching: "matchBusiestNode" } )taskExecutorPoolSizeChanged in version 4.0.Type: integerDefault: 1Available for
mongosonly.The number of Task Executor connection pools to use for a givenmongos.If the parameter value is0or less, the number of Task Executor connection pools is the number of cores with the following exceptions:If the number of cores is less than 4, the number of Task Executor connection pools is 4.If the number of cores is greater than 64, the number of Task Executor connection pools is 64.Starting in MongoDB 4.0, the default value oftaskExecutorPoolSizeis1:In MongoDB 4.0 deployment, you can settaskExecutorPoolSizeto0and, on Linux, set AsyncRequestsSenderUseBaton tofalsefor the previous behavior.In MongoDB 4.2+ deployment, MongoDB removes theAsyncRequestsSenderUseBatonparameter and always enables the performance enhancement controlled by the parameter.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongos --setParameter taskExecutorPoolSize=6SEE ALSOShardingTaskExecutorPoolMaxSizeShardingTaskExecutorPoolMinSizeloadRoutingTableOnStartupNew in version 4.4.Type: booleanDefault: trueAvailable for
mongosonly.Configures amongosinstance to preload the routing table for a sharded cluster on startup. With this setting enabled, themongoscaches the cluster-wide routing table for each sharded collection as part of its startup procedure, before it begins accepting client connections.Without this setting enabled, themongosonly loads a routing table as needed for incoming client connections, and only loads the specific routing table for the namespace of a given request.Amongosinstance with theloadRoutingTableOnStartupparameter enabled may experience longer startup times, but will result in faster servicing of initial client connections once started.loadRoutingTableOnStartupis enabled by default.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.warmMinConnectionsInShardingTaskExecutorPoolOnStartupNew in version 4.4.Type: booleanDefault: trueAvailable for
mongosonly.Configures amongosinstance to prewarm its connection pool on startup. With this parameter enabled, themongosattempts to establishShardingTaskExecutorPoolMinSizenetwork connections to each shard server as part of its startup procedure, before it begins accepting client connections.A timeout for this behavior can be configured with thewarmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMSparameter. If this timeout is reached, themongoswill begin accepting client connections regardless of the size of its connection pool.Amongosinstance with this parameter enabled may experience longer startup times, but will result in faster servicing of initial client connections once started.warmMinConnectionsInShardingTaskExecutorPoolOnStartupis enabled by default.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.SEE ALSOwarmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMSShardingTaskExecutorPoolMinSizewarmMinConnectionsInShardingTaskExecutorPoolOnStartupWaitMSNew in version 4.4.Type: integerDefault: 2000 (i.e. 2 seconds)Available for
mongosonly.Sets the timeout threshold in milliseconds for amongosto wait forShardingTaskExecutorPoolMinSizeconnections to be established per shard host when using thewarmMinConnectionsInShardingTaskExecutorPoolOnStartupparameter. If this timeout is reached, themongoswill begin accepting client connections regardless of the size of its connection pool.You can only set this parameter on startup, using either thesetParameterconfiguration file setting or the--setParametercommand line option.SEE ALSOwarmMinConnectionsInShardingTaskExecutorPoolOnStartupShardingTaskExecutorPoolMinSizemigrateCloneInsertionBatchDelayMSNew in version 4.0.5: The parameter is also available starting in 3.4.18 and 3.6.10Available for
mongodonly.Type: Non-negative integerDefault: 0Time in milliseconds to wait between batches of insertions during cloning step of the migration process. This wait is in addition to thesecondaryThrottle.The default value of0indicates no additional wait.The following sets themigrateCloneInsertionBatchDelayMSto 200 milliseconds:copycopiedmongod --setParameter migrateCloneInsertionBatchDelayMS=200The parameter may also be set using thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, migrateCloneInsertionBatchDelayMS: 200 } )migrateCloneInsertionBatchSizeNew in version 4.0.5: The parameter is also available starting in 3.4.18 and 3.6.10Available for
mongodonly.Type: Non-negative integerDefault: 0The maximum number of documents to insert in a single batch during the cloning step of the migration process.The default value of0indicates no maximum number of documents per batch. However, in practice, this results in batches that contain up to 16 MB of documents.The following sets themigrateCloneInsertionBatchSizeto 100 documents:copycopiedmongod --setParameter migrateCloneInsertionBatchSize=100The parameter may also be set using thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, migrateCloneInsertionBatchSize: 100 } )orphanCleanupDelaySecsNew in version 3.6.Default: 900 (15 minutes)Available for
mongodonly.Minimum delay before a migrated chunk is deleted from the source shard.Before deleting the chunk during chunk migration, MongoDB waits fororphanCleanupDelaySecsor for in-progress queries involving the chunk to complete on the shard primary, whichever is longer.However, because the shard primary has no knowledge of in-progress queries run on the shard secondaries, queries that use the chunk but are run on secondaries may see documents disappear if these queries take longer than the time to complete the shard primary queries and theorphanCleanupDelaySecs.NOTEThis behavior only affects in-progress queries that start before the chunk migration. Queries that start after the chunk migration starts will not use the migrating chunk.If a shard has storage constraints, consider reducing this value temporarily. If running queries that exceed 15 minutes on shard secondaries, consider increasing this value.The following sets theorphanCleanupDelaySecsto 20 minutes:copycopiedmongod --setParameter orphanCleanupDelaySecs=1200This may also be set using thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, orphanCleanupDelaySecs: 1200 } )rangeDeleterBatchDelayMSNew in version 4.0.1: The parameter is also available starting in 3.4.17 and 3.6.7.Available for
mongodonly.Type: Non-negative integerDefault: 20The amount of time in milliseconds to wait before the next batch of deletion during the cleanup stage of chunk migration (or thecleanupOrphanedcommand).In MongoDB 3.4, consider whether _secondaryThrottle is set before modifying therangeDeleterBatchDelayMS. In MongoDB 3.4, the _secondaryThrottle replication delay occurs after each document deletion instead of after the batch deletion.In MongoDB 3.6+, the _secondaryThrottle replication delay occurs after each batch deletion.The following sets therangeDeleterBatchDelayMSto 200 milliseconds:copycopiedmongod --setParameter rangeDeleterBatchDelayMS=200The parameter may also be set using thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, rangeDeleterBatchDelayMS: 200 } )rangeDeleterBatchSizeNew in version 4.0.5: The parameter is also available starting in 3.4.19 and 3.6.10Available for
mongodonly.Type: Non-negative integerDefault: 0The maximum number of documents in each batch to delete during the cleanup stage of chunk migration (or thecleanupOrphanedcommand).The default value of0indicates that the system chooses an appropriate value, generally 128 documents.The following sets therangeDeleterBatchSizeto 100 documents:copycopiedmongod --setParameter rangeDeleterBatchSize=100The parameter may also be set using thesetParametercommand:copycopieddb.adminCommand( { setParameter: 1, rangeDeleterBatchSize: 100 } )skipShardingConfigurationChecksNew in version 3.6.3.Available for
mongodonly.Type: booleanDefault: falseWhentrue, allows for starting a shard member or config server member as a standalone for maintenance operations. This parameter is mutually exclusive with the--configsvror--shardsvroptions.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongod --setParameter skipShardingConfigurationChecks=trueIMPORTANTOnce maintenance has completed, remove theskipShardingConfigurationChecksparameter when restarting themongod.The parameter is also available for MongoDB versions:MongoDB 3.2.19+MongoDB 3.4.11+Storage Parameters
journalCommitIntervalAvailable for
mongodonly.Specify an integer between1and500signifying the number of milliseconds (ms) between journal commits.Consider the following example which sets thejournalCommitIntervalto200ms:copycopieddb.adminCommand( { setParameter: 1, journalCommitInterval: 200 } )SEE ALSOstorage.journal.commitIntervalMssyncdelayAvailable for
mongodonly.Specify the interval in seconds between fsync operations wheremongodflushes its working memory to disk. By default,mongodflushes memory to disk every 60 seconds. In almost every situation you should not set this value and use the default setting.Consider the following example which sets thesyncdelayto60seconds:copycopieddb.adminCommand( { setParameter: 1, syncdelay: 60 } )SEE ALSOjournalCommitIntervalstorage.syncPeriodSecshonorSystemUmaskNew in version 3.6.Available for
mongodonly.Default:falseIfhonorSystemUmaskis set totrue, new files created by MongoDB have permissions in accordance with the user’sumasksettings. You cannot setprocessUmaskifhonorSystemUmaskis set totrue.IfhonorSystemUmaskis set tofalse, new files created by MongoDB have permissions set to600, which gives read and write permissions only to the owner. New directories have permissions set to700. You can useprocessUmaskto override the default permissions for groups and other users on all new files created by MongoDB.You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.copycopiedmongod --setParameter honorSystemUmask=trueNOTEhonorSystemUmaskis not available on Windows systems.processUmaskNew in version 4.4.Available for
mongodonly.Overrides the default permissions used for groups and other users whenhonorSystemUmaskis set tofalse. By default, whenhonorSystemUmaskis set tofalse, new files created by MongoDB have permissions set to600. Use theprocessUmaskparameter to override this default with a customumaskvalue. The file owner inherits permissions from the systemumask.You cannot set this parameter ifhonorSystemUmaskis set totrue. You can only set this parameter during start-up and cannot change this setting using thesetParameterdatabase command.Consider the following example, which sets the permissions for groups and other users to read/write only and retains the systemumasksettings for the owner:copycopiedmongod --setParameter processUmask=011NOTEprocessUmaskis not available on Windows systems.WiredTiger Parameters
wiredTigerMaxCacheOverflowSizeGBDEPRECATED IN MONGODB 4.4MongoDB deprecates the
wiredTigerMaxCacheOverflowSizeGBparameter. The parameter has no effect starting in MongoDB 4.4.Default: 0 (No specified maximum)Available formongodonly.Specify the maximum size (in GB) for the “lookaside (or cache overflow) table” fileWiredTigerLAS.wtfor MongoDB 4.2.1-4.2.x and 4.0.12-4.0.x. The file no longer exists starting in version 4.4.The parameter can accept the following values:ValueDescription0The default value. If set to0, the file size is unbounded.number >= 0.1The maximum size (in GB). If theWiredTigerLAS.wtfile exceeds this size,mongodexits with a fatal assertion. You can clear theWiredTigerLAS.wtfile and restartmongod.You can only set this parameter during runtime using thesetParameterdatabase command:copycopieddb.adminCommand( { setParameter: 1, wiredTigerMaxCacheOverflowSizeGB: 100 } )To set the maximum size during start up, use thestorage.wiredTiger.engineConfig.maxCacheOverflowFileSizeGBinstead.Available starting in MongoDB 4.2.1 (and 4.0.12)wiredTigerConcurrentReadTransactionsAvailable for
mongodonly.Available for the WiredTiger storage engine only.Specify the maximum number of concurrent read transactions allowed into the WiredTiger storage engine.copycopieddb.adminCommand( { setParameter: 1, wiredTigerConcurrentReadTransactions: <num> } )SEE ALSOwiredTiger.concurrentTransactionswiredTigerConcurrentWriteTransactionsAvailable for
mongodonly.Available for the WiredTiger storage engine only.Specify the maximum number of concurrent write transactions allowed into the WiredTiger storage engine.copycopieddb.adminCommand( { setParameter: 1, wiredTigerConcurrentWriteTransactions: <num> } )SEE ALSOwiredTiger.concurrentTransactionswiredTigerEngineRuntimeConfigAvailable for
mongodonly.SpecifywiredTigerstorage engine configuration options for a runningmongodinstance. You can only set this parameter using thesetParametercommand and not using the command line or configuration file option.WARNINGAvoid modifying thewiredTigerEngineRuntimeConfigunless under the direction from MongoDB engineers as this setting has major implication across both WiredTiger and MongoDB.Consider the following operation prototype:copycopieddb.adminCommand({ "setParameter": 1, "wiredTigerEngineRuntimeConfig": "<option>=<setting>,<option>=<setting>" })See the WiredTiger documentation for all available WiredTiger configuration options.Auditing Parameters
auditAuthorizationSuccessDefault:
falseNOTEAvailable only in MongoDB Enterprise and MongoDB Atlas.Available for bothmongodandmongos.Enables the auditing of authorization successes for the authCheck action.WhenauditAuthorizationSuccessisfalse, the audit system only logs the authorization failures forauthCheck.To enable the audit of authorization successes, issue the following command:copycopieddb.adminCommand( { setParameter: 1, auditAuthorizationSuccess: true } )EnablingauditAuthorizationSuccessdegrades performance more than logging only the authorization failures.
SEE ALSO
Transaction Parameters
transactionLifetimeLimitSecondsNew in version 4.0.Available for
mongodonly.Default: 60Specifies the lifetime of multi-document transactions. Transactions that exceeds this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs everytransactionLifetimeLimitSeconds/2 seconds or at least once per every 60 seconds.The cleanup process helps relieve storage cache pressure.The minimum value for transactionLifetimeLimitSeconds is1second.The following sets thetransactionLifetimeLimitSecondsto30seconds:copycopieddb.adminCommand( { setParameter: 1, transactionLifetimeLimitSeconds: 30 } )You can also set parametertransactionLifetimeLimitSecondsat startup time.copycopiedmongod --setParameter "transactionLifetimeLimitSeconds=30"To set the parameter for a sharded cluster, the parameter must be modified for all shard replica set members.maxTransactionLockRequestTimeoutMillisNew in version 4.0.Available for
mongodonly.Type: integerDefault: 5The maximum amount of time in milliseconds that multi-document transactions should wait to acquire locks required by the operations in the transaction.If the transaction cannot acquire the locks after waitingmaxTransactionLockRequestTimeoutMillis, the transaction aborts.By default, multi-document transactions wait5milliseconds. That is, if the transaction cannot acquire the locks within5milliseconds, the transaction aborts. If an operation provides a greater timeout in a lock request,maxTransactionLockRequestTimeoutMillisoverrides the operation-specific timeout.You can setmaxTransactionLockRequestTimeoutMillisto:0such that if the transaction cannot acquire the required locks immediately, the transaction aborts.A number greater than0to wait the specified time to acquire the required locks. This can help obviate transaction aborts on momentary concurrent lock acquisitions, like fast-running metadata operations. However, this could possibly delay the abort of deadlocked transaction operations.-1to use the operation specific timeout.The following sets themaxTransactionLockRequestTimeoutMillisto20milliseconds:copycopieddb.adminCommand( { setParameter: 1, maxTransactionLockRequestTimeoutMillis: 20 } )You can also set this parameter during start-up:copycopiedmongod --setParameter maxTransactionLockRequestTimeoutMillis=20shouldMultiDocTxnCreateCollectionAndIndexesNew in version 4.4.**Type: booleanDefault: trueA flag that enables or disables the creation of a collection or an index inside transactions. Set the parameter to:
trueto enable. (Default)falseto disable.You can set the parameter during startup or runtime.IMPORTANTWhen setting the parameter for a sharded cluster, set the parameter on all shards.To set the parameter at startup, specify the parameter in theconfiguration fileor with the--setParameteroption on the command line. For example:copycopiedmongod --setParameter shouldMultiDocTxnCreateCollectionAndIndexes=falseTo modify during runtime, you can use thesetParametercommand; for example:copycopieddb.adminCommand( { setParameter: 1, shouldMultiDocTxnCreateCollectionAndIndexes: false
参见