diff --git a/config/redirects b/config/redirects index 85c421e235e..275344dc8ba 100644 --- a/config/redirects +++ b/config/redirects @@ -1377,10 +1377,14 @@ raw: /master/release-notes/3.0-general-improvements -> ${base}/release-notes/3.0 [v3.6-*]: /${version}/reference/method/cursor.snapshot -> ${base}/${version}/reference/method/ [v3.6-*]: /${version}/administration/replica-sets -> ${base}/${version}/replication +# Redirects for 4.0 and greater + [v4.0-*]: /${version}/core/security-mongodb-cr -> ${base}/${version}/core/security-scram [v4.0-*]: /${version}/reference/command/authSchemaUpgrade -> ${base}/${version}/core/security-scram [v4.0-*]: /${version}/reference/command/copydbgetnonce -> ${base}/${version}/reference/command/copydb [v4.0-*]: /${version}/source/reference/command/resync -> ${base}/${version}/core/master-slave +[v4.0-*]: /${version}/source/reference/program/mongoperf -> ${base}/${version}/reference/program + # 2.8 compatibility [*]: /${version}/release-notes/2.8-downgrade -> ${base}/${version}/release-notes diff --git a/source/includes/extracts-run-from-cmd.yaml b/source/includes/extracts-run-from-cmd.yaml index 3a10c0a7edb..3d1707ba347 100644 --- a/source/includes/extracts-run-from-cmd.yaml +++ b/source/includes/extracts-run-from-cmd.yaml @@ -51,13 +51,6 @@ inherit: replacement: command: :binary:`~bin.mongotop` --- -ref: require-cmd-line-mongoperf -inherit: - file: extracts-run-from-cmd.yaml - ref: _require-cmd-line -replacement: - command: :binary:`~bin.mongoperf` ---- ref: require-cmd-line-mongoreplay inherit: file: extracts-run-from-cmd.yaml diff --git a/source/includes/list-mongodb-enterprise-packages.rst b/source/includes/list-mongodb-enterprise-packages.rst index 229f66c3e15..f236f58a738 100644 --- a/source/includes/list-mongodb-enterprise-packages.rst +++ b/source/includes/list-mongodb-enterprise-packages.rst @@ -26,5 +26,5 @@ repository. This repository contains the following packages: - Contains the following MongoDB tools: :binary:`~bin.mongoimport` :binary:`~bin.bsondump`, :binary:`~bin.mongodump`, :binary:`~bin.mongoexport`, :binary:`~bin.mongofiles`, - :binary:`~bin.mongoperf`, :binary:`~bin.mongorestore`, :binary:`~bin.mongostat`, + :binary:`~bin.mongorestore`, :binary:`~bin.mongostat`, and :binary:`~bin.mongotop`. diff --git a/source/includes/list-mongodb-org-packages.rst b/source/includes/list-mongodb-org-packages.rst index 854e60c3eaf..84ff0010854 100644 --- a/source/includes/list-mongodb-org-packages.rst +++ b/source/includes/list-mongodb-org-packages.rst @@ -29,7 +29,7 @@ repository contains the following packages: - Contains the following MongoDB tools: :binary:`~bin.mongoimport` :binary:`~bin.bsondump`, :binary:`~bin.mongodump`, :binary:`~bin.mongoexport`, :binary:`~bin.mongofiles`, - :binary:`~bin.mongoperf`, :binary:`~bin.mongorestore`, :binary:`~bin.mongostat`, + :binary:`~bin.mongorestore`, :binary:`~bin.mongostat`, and :binary:`~bin.mongotop`. The ``mongodb-org-server`` package provides an initialization script diff --git a/source/includes/options-mongoperf.yaml b/source/includes/options-mongoperf.yaml deleted file mode 100644 index 0ade90856dd..00000000000 --- a/source/includes/options-mongoperf.yaml +++ /dev/null @@ -1,44 +0,0 @@ -# This file borrows content from /includes/options-shared.yaml, which uses -# {{program}} to refer to the tool. -# -program: mongoperf -aliases: -h -name: help -inherit: - name: help - program: _shared - file: options-shared.yaml ---- -program: mongoperf -name: -directive: option -args: null -description: | - :binary:`~bin.mongoperf` accepts configuration options in the form of a - file that holds a :term:`JSON` document. You must stream the - content of this file into :binary:`~bin.mongoperf`, as in the following - operation: - - .. code-block:: sh - - mongoperf < config - - In this example ``config`` is the name of a file that holds a JSON - document that resembles the following example: - - .. code-block:: javascript - - { - nThreads:, - fileSizeMB:, - sleepMicros:, - mmf:, - r:, - w:, - recSizeKB:, - syncDelay: - } - - See the :ref:`mongoperf-fields` section for documentation of each - of these fields. -... diff --git a/source/includes/steps-install-mongodb-on-windows-unattended.yaml b/source/includes/steps-install-mongodb-on-windows-unattended.yaml index d72bfb1f42c..9f893ecbfd1 100644 --- a/source/includes/steps-install-mongodb-on-windows-unattended.yaml +++ b/source/includes/steps-install-mongodb-on-windows-unattended.yaml @@ -39,7 +39,7 @@ pre: | * - ``ImportExportTools`` - ``mongodump.exe``, ``mongorestore.exe``, ``mongoexport.exe``, ``mongoimport.exe`` * - ``MiscellaneousTools`` - - ``bsondump.exe``, ``mongofiles.exe``, ``mongoperf.exe`` + - ``bsondump.exe``, ``mongofiles.exe`` For instance, to install *only* the MongoDB utilities, invoke: diff --git a/source/reference/program.txt b/source/reference/program.txt index e6e68a6f105..85a4aba3813 100644 --- a/source/reference/program.txt +++ b/source/reference/program.txt @@ -96,7 +96,6 @@ LDAP configuration options against a running LDAP server or set of servers. /reference/program/mongostat /reference/program/mongotop - /reference/program/mongoperf /reference/program/mongoreplay /reference/program/mongoldap diff --git a/source/reference/program/mongoperf.txt b/source/reference/program/mongoperf.txt deleted file mode 100644 index ed098a9cea6..00000000000 --- a/source/reference/program/mongoperf.txt +++ /dev/null @@ -1,184 +0,0 @@ -.. _mongoperf: - -============= -``mongoperf`` -============= - -.. default-domain:: mongodb - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -Synopsis --------- - -:binary:`~bin.mongoperf` is a utility to check disk I/O performance -independently of MongoDB. - -It times tests of random disk I/O and presents the results. You can -use :binary:`~bin.mongoperf` for any case apart from MongoDB. The -:setting:`~mongoperf.mmf` ``true`` mode is completely generic. In -that mode it is somewhat analogous to tools such as `bonnie++ -`_ (albeit mongoperf is -simpler). - -Specify options to :binary:`~bin.mongoperf` using a JavaScript document. - -.. include:: /includes/extracts/require-cmd-line-mongoperf.rst - -.. seealso:: - - * `bonnie `_ - * `bonnie++ `_ - * `Output from an example run `_ - -.. _mongoperf-options: - -Options -------- - -.. binary:: mongoperf - -.. program:: mongoperf - -.. include:: /includes/option/option-mongoperf-help.rst - -.. include:: /includes/option/option-mongoperf-.rst - -.. _mongoperf-fields: - -Configuration Fields --------------------- - -.. setting:: mongoperf.nThreads - - *Type:* Integer. - - *Default:* 1 - - Defines the number of threads :binary:`~bin.mongoperf` will use in the - test. To saturate your system's storage system you will need - multiple threads. Consider setting :setting:`~mongoperf.nThreads` to ``16``. - -.. setting:: mongoperf.fileSizeMB - - *Type:* Integer. - - *Default:* 1 megabyte (i.e. 1024\ :sup:`2` bytes) - - Test file size. - -.. setting:: mongoperf.sleepMicros - - *Type:* Integer. - - *Default:* 0 - - :binary:`~bin.mongoperf` will pause for the number of specified - :setting:`~mongoperf.sleepMicros` divided by the - :setting:`~mongoperf.nThreads` between each operation. - -.. setting:: mongoperf.mmf - - *Type:* Boolean. - - *Default:* ``false`` - - Set :setting:`~mongoperf.mmf` to ``true`` to use memory mapped - files for the tests. - - Generally: - - - when :setting:`~mongoperf.mmf` is ``false``, :binary:`~bin.mongoperf` - tests direct, physical, I/O, without caching. Use a large file - size to test heavy random I/O load and to avoid I/O coalescing. - - - when :setting:`~mongoperf.mmf` is ``true``, :binary:`~bin.mongoperf` - runs tests of the caching system, and can use normal file system - cache. Use :setting:`~mongoperf.mmf` in this mode to test file system cache - behavior with memory mapped files. - -.. setting:: mongoperf.r - - *Type:* Boolean. - - *Default:* ``false`` - - Set :setting:`~mongoperf.r` to ``true`` to perform reads as part of - the tests. - - Either :setting:`~mongoperf.r` or :setting:`~mongoperf.w` must be ``true``. - -.. setting:: mongoperf.w - - *Type:* Boolean. - - *Default:* ``false`` - - Set :setting:`~mongoperf.w` to ``true`` to perform writes as part of - the tests. - - Either :setting:`~mongoperf.r` or :setting:`~mongoperf.w` must be ``true``. - -.. setting:: mongoperf.recSizeKB - - .. versionadded:: 2.4 - - *Type:* Integer. - - *Default:* 4 kb - - The size of each write operation. - -.. setting:: mongoperf.syncDelay - - *Type:* Integer. - - *Default:* 0 - - Seconds between disk flushes. :setting:`mongoperf.syncDelay` is - similar to :option:`--syncdelay ` for :binary:`~bin.mongod`. - - The :setting:`~mongoperf.syncDelay` controls how frequently - :binary:`~bin.mongoperf` performs an asynchronous disk flush of the memory - mapped file used for testing. By default, :binary:`~bin.mongod` - performs this operation every 60 seconds. Use - :setting:`~mongoperf.syncDelay` to test basic system performance of - this type of operation. - - Only use :setting:`~mongoperf.syncDelay` in conjunction with - :setting:`~mongoperf.mmf` set to ``true``. - - The default value of ``0`` disables this. - -Use ---- - -.. code-block:: javascript - - mongoperf < jsonconfigfile - -Replace ``jsonconfigfile`` with the path to the :binary:`~bin.mongoperf` -configuration. You may also invoke :binary:`~bin.mongoperf` in the -following form: - -.. code-block:: sh - - echo "{nThreads:16,fileSizeMB:10000,r:true,w:true}" | mongoperf - -In this operation: - -- :binary:`~bin.mongoperf` tests direct physical random read and write io's, using - 16 concurrent reader threads. - -- :binary:`~bin.mongoperf` uses a 10 gigabyte test file. - -Consider using ``iostat``, as invoked in the following example to -monitor I/O performance during the test. - -.. code-block:: sh - - iostat -xtm 1 diff --git a/source/release-notes/3.0.txt b/source/release-notes/3.0.txt index 051b7aebb11..2ecd2c03541 100644 --- a/source/release-notes/3.0.txt +++ b/source/release-notes/3.0.txt @@ -589,8 +589,8 @@ components. For information, see :doc:`/reference/log-messages`. MongoDB Tools Enhancements ~~~~~~~~~~~~~~~~~~~~~~~~~~ -All MongoDB tools except for :binary:`~bin.mongosniff` and -:binary:`~bin.mongoperf` are now written in Go and maintained as a separate +All MongoDB tools except for ``mongosniff`` and +``mongoperf`` are now written in Go and maintained as a separate project. - New options for parallelized :binary:`~bin.mongodump` and diff --git a/source/release-notes/4.0-compatibility.txt b/source/release-notes/4.0-compatibility.txt index 748230383e9..13160e6c995 100644 --- a/source/release-notes/4.0-compatibility.txt +++ b/source/release-notes/4.0-compatibility.txt @@ -84,3 +84,9 @@ uses master-slave replication, you must upgrade to a replica set. To convert your master-slave replication, see :ref:`convert-master-slave-to-replica-set`. +General +------- + +- Remove ``mongoperf``. + +