DOCSP-31020 query analysis server params (#4103)

* DOCSP-31020 query analysis server params

* internal review

* external rev

* external review

* removes note

Author: jmd-mongo

source/reference/parameters.txt

@@ -3572,6 +3572,143 @@ Sharding Parameters
 
       db.adminCommand( { setParameter: 1, metadataRefreshInTransactionMaxWaitBehindCritSecMS: 400 } )
 
+.. parameter:: queryAnalysisSamplerConfigurationRefreshSecs
+
+   .. versionadded:: 7.0
+
+   |both|
+
+   *Type*: integer
+
+   *Default*: 10
+
+   Interval that a sampler (``mongos`` or ``mongod``) refreshes its 
+   query analyzer sample rates. 
+
+   The sample rate configured by the ``configureQueryAnalyzer`` 
+   command is divided among ``mongos`` instances in the sharded cluster 
+   or ``mongod`` instances in the replica set based on the traffic going 
+   through them. To make the sample rate assignment for a ``mongos`` or 
+   ``mongod`` more responsive to the traffic going through it, decrease
+   this value. 
+
+   We recommend using the default value. 
+
+   This example sets ``queryAnalysisSamplerConfigurationRefreshSecs`` to 
+   60 seconds at startup on a ``mongod`` instance:
+
+   .. code-block:: bash
+
+      mongod --setParameter queryAnalysisSamplerConfigurationRefreshSecs=60
+
+   This example sets ``queryAnalysisSamplerConfigurationRefreshSecs`` to 
+   60 seconds at startup on a ``mongos`` instance:
+
+   .. code-block:: bash
+
+      mongos --setParameter queryAnalysisSamplerConfigurationRefreshSecs=60
+
+   ``queryAnalysisSamplerConfigurationRefreshSecs`` may only be set at 
+   startup.
+
+.. parameter:: queryAnalysisWriterIntervalSecs
+
+   .. versionadded:: 7.0
+
+   |mongod-only|
+
+   *Type*: integer
+
+   *Default*: 90
+
+   Interval that sampled queries are written to disk, in seconds.
+
+   This example sets ``queryAnalysisWriterIntervalSecs`` to 
+   60 seconds at startup on a ``mongod`` instance:
+
+   .. code-block:: bash
+
+      mongod --setParameter queryAnalysisWriterIntervalSecs=60
+   
+   ``queryAnalysisWriterIntervalSecs`` may only be set at startup.
+
+.. parameter:: queryAnalysisWriterMaxMemoryUsageBytes
+
+   .. versionadded:: 7.0
+
+   |mongod-only|
+
+   *Type*: integer
+
+   *Default*: 100 * 1024 * 1024
+
+   Maximum amount of memory in bytes that the query sampling writer is 
+   allowed to use. Once the limit is reached, all new queries and diffs 
+   are discarded from sampling until the buffer is flushed. Must be 
+   greater than ``0``.
+
+   This example sets ``queryAnalysisWriterMaxMemoryUsageBytes`` to 
+   ``10000000`` at startup on a ``mongod`` instance:
+
+   .. code-block:: bash
+
+      mongod --setParameter queryAnalysisWriterMaxMemoryUsageBytes=10000000
+
+.. parameter:: queryAnalysisWriterMaxBatchSize
+
+   .. versionadded:: 7.0
+
+   |mongod-only|
+
+   *Type*: integer
+
+   *Default*: 100000
+
+   Maximum number of sampled queries to write to disk at once. Must be
+   greater than ``0`` and less than or equal to ``100000``.
+
+   This example sets ``queryAnalysisWriterMaxBatchSize`` to 
+   ``1000`` at startup on a ``mongod`` instance:
+
+   .. code-block:: bash
+
+      mongod --setParameter queryAnalysisWriterMaxBatchSize=1000
+
+   During run time, you can also set the parameter with the
+   :dbcommand:`setParameter` command:
+
+   .. code-block:: javascript
+
+      db.adminCommand( { setParameter: 1, queryAnalysisWriterMaxBatchSize: 1000 } )
+
+.. parameter:: queryAnalysisSampleExpirationSecs
+
+   .. versionadded:: 7.0
+
+   |mongod-only|
+
+   *Type*: integer
+
+   *Default*: 7 * 24 * 3600 
+
+   Amount of time that a sampled query document exists before 
+   being removed by the TTL monitor, in seconds. Must be greater
+   than ``0``.
+
+   This example sets ``queryAnalysisSampleExpirationSecs`` to 
+   ``691200`` (``8 * 24 * 3600``) at startup on a ``mongod`` instance:
+
+   .. code-block:: bash
+
+      mongod --setParameter queryAnalysisSampleExpirationSecs=691200
+
+   During run time, you can also set the parameter with the
+   :dbcommand:`setParameter` command:
+
+   .. code-block:: javascript
+
+      db.adminCommand( { setParameter: 1, queryAnalysisSampleExpirationSecs: 691200 } )
+
 
 .. parameter:: readHedgingMode
 

source/release-notes/7.0.txt

@@ -196,6 +196,18 @@ MongoDB 7.0  adds the :parameter:`oidcIdentityProviders` parameter which allows
 you to specify identity provider (IDP) configurations when using 
 :ref:`OpenID Connect <authentication-oidc>` authentication. 
 
+configureQueryAnalysis-related Parameters
+`````````````````````````````````````````
+
+MongoDB 7.0 adds the following parameters related to the
+``configureQueryAnalysis`` command:
+
+- :parameter:`queryAnalysisSamplerConfigurationRefreshSecs`
+- :parameter:`queryAnalysisWriterIntervalSecs`
+- :parameter:`queryAnalysisWriterMaxMemoryUsageBytes`
+- :parameter:`queryAnalysisWriterMaxBatchSize`
+- :parameter:`queryAnalysisSampleExpirationSecs`
+
 Security
 -------------