Skip to content

WRITING-1033 #2017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,9 @@ def has(self, *args):
'manual': ('http://docs.mongodb.org/manual%s', ''),
'ecosystem': ('http://docs.mongodb.org/ecosystem%s', ''),
'meta-driver': ('http://docs.mongodb.org/meta-driver/latest%s', ''),
'mms': ('https://mms.mongodb.com/help%s', ''),
'mms-hosted': ('https://mms.mongodb.org/help-hosted%s', ''),
'mms': ('https://docs.mms.mongodb.com%s', ''),
'mms-hosted': ('https://mms.mongodb.com/help-hosted%s', ''),
'mms-home': ('https://mms.mongodb.com%s', ''),
'about': ('http://www.mongodb.org/about%s', '')
}

Expand Down
30 changes: 12 additions & 18 deletions source/administration/monitoring.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,7 @@ available in MongoDB. It also introduces diagnostic strategies
and suggestions for monitoring replica sets and
sharded clusters.

.. note::

`MongoDB Management Service (MMS)
<https://mms.mongodb.com/?pk_campaign=mongodb-org&pk_kwd=monitoring>`_
is a hosted monitoring service which collects and aggregates data
to provide insight into the performance and operation of MongoDB
deployments. See the `MMS documentation
<http://mms.mongodb.com/help/>`_ for more information.
.. include:: /includes/fact-mms-summary.rst

Monitoring Strategies
---------------------
Expand All @@ -38,11 +31,10 @@ running MongoDB instance:
statistics regarding the current database state with greater
fidelity.

- Third, `MMS Monitoring Service
<https://mms.mongodb.com/?pk_campaign=mongodb-org&pk_kwd=monitoring>`_
- Third, :mms-home:`MMS Monitoring
</>`
collects data from running MongoDB deployments and provides
visualization and alerts based on that data. MMS is a free service
provided by MongoDB.
visualization and alerts based on that data.

Each strategy can help answer different questions and is useful in
different contexts. These methods are complementary.
Expand Down Expand Up @@ -140,7 +132,7 @@ MongoDB performance.
:dbcommand:`serverStatus` outputs an account of the state of a MongoDB
instance. This command is rarely run directly. In most cases, the data
is more meaningful when aggregated, as one would see with monitoring
tools including `MMS <http://mms.mongodb.com>`_ .
tools including :mms-home:`MMS </>`.
Nevertheless, all administrators should be familiar with the data
provided by :dbcommand:`serverStatus`.

Expand Down Expand Up @@ -265,9 +257,9 @@ query analyzing tool for MongoDB that compares MongoDB log files and
indexes to make indexing recommendations.

As part of `MongoDB Enterprise <http://www.mongodb.com/products/mongodb-enterprise>`_,
you can run `MMS On-Prem <http://mms.mongodb.com>`_,
you can run :mms-home:`MMS On-Prem </>`,
which offers the features of MMS in a package that runs within your
infrastructure.
own infrastructure.

Hosted (SaaS) Monitoring Tools
``````````````````````````````
Expand All @@ -282,10 +274,11 @@ a paid subscription.

- **Notes**

* - `MongoDB Management Service <https://mms.mongodb.com/?pk_campaign=mongodb-org&pk_kwd=monitoring>`_
* - `MongoDB Management Service :mms-home:</>`

- MMS is a cloud-based suite of services for managing MongoDB
deployments. MMS provides monitoring and backup functionality.
deployments. MMS provides monitoring, backup, and automation
functionality.

* - `Scout <http://scoutapp.com>`_

Expand Down Expand Up @@ -671,7 +664,8 @@ the availability of a sharded cluster, you should monitor your
configuration servers to ensure that the cluster remains well
balanced and that :program:`mongos` instances can restart.

`MMS Monitoring <http://mms.mongodb.com>`_ monitors config servers and
:mms-home:`MMS </>` monitors config
servers and
can create notifications if a config server becomes inaccessible.

Balancing and Chunk Distribution
Expand Down
8 changes: 1 addition & 7 deletions source/administration/production-notes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,7 @@ Production Notes
This page details system configurations that affect MongoDB,
especially in production.

.. note::
`MongoDB Management Service (MMS) <http://mms.mongodb.com>`_ is a hosted monitoring service
which collects and aggregates diagnostic data to provide insight into
the performance and operation of MongoDB deployments. See the
`MMS Website <http://mms.mongodb.com/>`_ and the
`MMS documentation <http://mms.mongodb.com/help/>`_ for more
information.
.. include:: /includes/fact-mms-summary.rst

Packages
--------
Expand Down
27 changes: 12 additions & 15 deletions source/core/backups.txt
Original file line number Diff line number Diff line change
Expand Up @@ -118,31 +118,28 @@ for more information.
MongoDB Management Service (MMS) Cloud Backup
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The `MongoDB Management Service
<https://mms.10gen.com/?pk_campaign=MongoDB-Org&pk_kwd=Backup-Docs>`_
supports backup and restore for MongoDB deployments.
The :mms-home:`MongoDB Management Service
</>`
supports the backing up and restoring of MongoDB deployments.

MMS continually backs up MongoDB replica sets and sharded
systems by reading the oplog data from your MongoDB cluster.
clusters by reading the oplog data from your MongoDB deployment.

MMS Backup offers point in time recovery of MongoDB replica sets and a
consistent snapshot of sharded systems.
consistent snapshot of sharded clusters.

MMS achieves point in time recovery by storing oplog data so that it
can create a restore for any moment in time in the last 24 hours for a
particular replica set.

For sharded systems, MMS does not provide restores for arbitrary moments in
time. MMS does provide periodic consistent snapshots of the entire
sharded cluster. Sharded cluster snapshots are difficult to achieve
particular replica set or sharded cluster.
Sharded cluster snapshots are difficult to achieve
with other MongoDB backup methods.

To restore a MongoDB cluster from an MMS Backup snapshot, you download
To restore a MongoDB deployment from an MMS Backup snapshot, you download
a compressed archive of your MongoDB data files and distribute those
files before restarting the :program:`mongod` processes.

To get started with MMS Backup `sign up for MMS
<http://mms.mongodb.com>`_, and consider the
To get started with MMS Backup :mms-home:`sign up for MMS
</>`, and consider the
complete documentation of MMS see the :mms:`MMS Manual
</>`.

Expand All @@ -157,8 +154,8 @@ version of MMS, has similar functionality as the cloud version and is
available with Standard and Enterprise subscriptions.

For more information about On Prem MMS see the `MongoDB subscription
<https://www.mongodb.com/products/subscriptions>`_ page and the `MMS
On Prem Manual <https://mms.mongodb.com/help-hosted/current/>`_.
<https://www.mongodb.com/products/subscriptions>`_ page and the :mms-hosted:`MMS
On Prem Manual </current/>`.

Further Reading
---------------
Expand Down
2 changes: 1 addition & 1 deletion source/core/import-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ database backup operation, use full :doc:`database instance backups
supplant more frequently accessed data, causing a deterioration in
performance for the database's regular workload.

.. seealso:: :doc:`/core/backups` or :mms:`MMS Backup Manual </backup>`
.. seealso:: :doc:`/core/backups` or :mms:`MMS Backup Manual </tutorial/nav/backup-use/>`
for more information on backing up MongoDB instances. Additionally,
consider the following references for the MongoDB import/export
tools:
Expand Down
2 changes: 1 addition & 1 deletion source/faq/concurrency.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ following methods:
- :method:`db.currentOp()`,
- :doc:`mongotop </reference/program/mongotop>`,
- :doc:`mongostat </reference/program/mongostat>`, and/or
- the `MongoDB Management Service (MMS) <http://mms.mongodb.com/>`_
- the :mms-home:`MongoDB Management Service (MMS) </>`

Specifically, the :data:`~serverStatus.locks` document in the :doc:`output of
serverStatus </reference/command/serverStatus>`, or the :data:`~currentOp.locks` field
Expand Down
12 changes: 8 additions & 4 deletions source/faq/diagnostics.txt
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,15 @@ Windows systems.
What tools are available for monitoring MongoDB?
------------------------------------------------

The `MongoDB Management Services <http://mms.mongodb.com>` includes
monitoring. MMS Monitoring is a free, hosted services for monitoring
MongoDB deployments. A full list of third-party tools is available as
The :mms-home:`MongoDB Management Service
</>` includes
monitoring functionality,
which collects data from running MongoDB deployments and provides
visualization and alerts based on that data.

A full list of third-party tools is available as
part of the :doc:`/administration/monitoring/` documentation. Also
consider the `MMS Documentation <http://mms.mongodb.com/help/>`_.
consider the :mms:`MMS Documentation </>`.

.. _faq-memory:

Expand Down
7 changes: 7 additions & 0 deletions source/includes/fact-mms-summary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. note::
:mms-home:`MongoDB Management Service (MMS) </>` is a hosted
service that provides monitoring, backup, and automated deployment
of MongoDB instances. See the
:mms-home:`MMS Website </>` and the
:mms:`MMS documentation </>` for more
information.
6 changes: 3 additions & 3 deletions source/includes/steps-restore-primary-from-backup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ content: |
The backup files may come from a :doc:`file system snapshot
</tutorial/backup-with-filesystem-snapshots>`. The `MongoDB Management
Service (MMS)
<https://mms.mongodb.com/?pk_campaign=mongodb-docs-restore-rs-tutorial>`_
:mms-home:</>`
produces MongoDB database files for :mms:`stored snapshots
</backup/tutorial/restore-from-snapshot/>` and :mms:`point and time
snapshots </backup/tutorial/restore-from-point-in-time-snapshot/>`. You
</tutorial/restore-from-snapshot/>` and :mms:`point in time
snapshots </tutorial/restore-from-point-in-time-snapshot/>`. You
can also use :program:`mongorestore` to restore database files using
data created with :program:`mongodump`. See
:doc:`/tutorial/backup-with-mongodump` for more information.
Expand Down
5 changes: 3 additions & 2 deletions source/includes/toc-administration-backup-and-recovery.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ description: |
file: /tutorial/restore-replica-set-from-backup
description: |
Describes procedure for restoring a replica set from an archived
backup such as a :program:`mongodump` or `MMS Backup
<https://mms.mongodb.com/?pk_campaign=mongodb-docs-admin-tutorials>`_ file.
backup such as a :program:`mongodump` or :mms-home:`MMS
</>` Backup
file.
---
file: /tutorial/backup-with-mongodump
description: |
Expand Down
12 changes: 7 additions & 5 deletions source/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -105,13 +105,15 @@ The following resources provide additional information:
`Slides and Video <http://www.mongodb.com/presentations/>`_
Presentations and videos from past MongoDB events.

`MongoDB Management Service <http://mms.mongodb.com/>`_
:mms-home:`MongoDB Management Service </>`
Free cloud-based service for monitoring and backing up MongoDB deployments. Also
consider the `MMS documentation <http://mms.mongodb.com/help/>`_.
consider the :mms:`MMS documentation </>`.

`MongoDB Books <http://mongodb.org/books>`_
Books that provide additional information and background on
MongoDB.
`MongoDB Training <http://university.mongodb.com>`_
MongoDB's professional training offerings. Free online courses, online
certification, in-person training, and private courses for your
organization are available to help you learn to build, run, and deploy
applications with MongoDB.

`MongoDB Ecosystem <http://docs.mongodb.org/ecosystem/>`_
The documentation available for the drivers, frameworks, tools,
Expand Down
6 changes: 3 additions & 3 deletions source/reference/built-in-roles.txt
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,8 @@ functions.

.. authrole:: clusterMonitor

Provides read-only access to monitoring tools, such as the `MongoDB
Management Service (MMS) <http://mms.mongodb.com/help/>`_ monitoring agent.
Provides read-only access to monitoring tools, such as the :mms:`MongoDB
Management Service (MMS) </>` monitoring agent.

Provides the following actions on the cluster as a whole:

Expand Down Expand Up @@ -298,7 +298,7 @@ restoring data:

Provides minimal privileges needed for backing up data.
This role provides sufficient privileges to use the
`MongoDB Management Service (MMS) <http://mms.mongodb.com/help/>`_
:mms:`MongoDB Management Service (MMS) </>`
backup agent, or to use :program:`mongodump` to back up an entire
:program:`mongod` instance.

Expand Down
6 changes: 3 additions & 3 deletions source/release-notes/2.6.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ enhancements, text-search integration, query-engine improvements, a new
write-operation protocol, and security enhancements.

MMS 1.4, which includes On-Prem Backup in addition to Monitoring, is
now also available. See `MMS 1.4 documentation
<https://mms.mongodb.com/help-hosted/v1.4/>`_ and the `MMS 1.4 release
notes <https://mms.mongodb.com/help-hosted/v1.4/management/changelog/>`_
now also available. See :mms-hosted:`MMS 1.4 documentation
</v1.4/>` and the :mms-hosted:`MMS 1.4 release
notes </v1.4/management/changelog/>`
for more information.

Minor Releases
Expand Down
4 changes: 2 additions & 2 deletions source/tutorial/backup-with-mongodump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This document describes the process for writing and restoring backups
to files in binary format with the :program:`mongodump` and
:program:`mongorestore` tools.

Use these tools for backups if other backup methods, such as the `MMS Backup Service
<https://mms.mongodb.com/?pk_campaign=mongodb-docs-tools>`_ or
Use these tools for backups if other backup methods, such as the
:mms-home:`MMS Backup Service </>` or
:doc:`file system snapshots </tutorial/backup-with-filesystem-snapshots>`
are unavailable.

Expand Down
6 changes: 3 additions & 3 deletions source/tutorial/configure-ssl-clients.txt
Original file line number Diff line number Diff line change
Expand Up @@ -87,15 +87,15 @@ connect to that :program:`mongod`:
MMS Monitoring Agent
--------------------

The Monitoring agent will also have to connect via SSL in order to gather its
stats. Because the agent already utilizes SSL for its communications
The MMS Monitoring agent will also have to connect via SSL in order to gather its
statistics. Because the agent already utilizes SSL for its communications
to the MMS servers, this is just a matter of enabling SSL support in
MMS itself on a per host basis.

Use the "Edit" host button (i.e. the pencil) on the Hosts page in the
MMS console to enable SSL.

Please see the `MMS documentation <http://mms.mongodb.com/help>`_ for more
Please see the :mms:`MMS documentation </>` for more
information about MMS configuration.

PyMongo
Expand Down
8 changes: 3 additions & 5 deletions source/tutorial/troubleshoot-replica-sets.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,9 @@ To check the current length of replication lag:
:dbcommand:`replSetGetStatus` database command.

- Monitor the rate of replication by watching the oplog time in the
"replica" graph in the `MongoDB Management Service`_. For more
information see the `documentation for MMS`_.

.. _`MongoDB Management Service`: http://mms.mongodb.com/
.. _`documentation for MMS`: http://mms.mongodb.com/help/
"replica" graph in the :mms-home:`MongoDB Management Service
</>`. For more
information see the :mms:`documentation for MMS </>`.

Possible causes of replication lag include:

Expand Down