Skip to content

Commit 3e29e51

Browse files
authored
DOCSP 31908 removing free monitoring pages and references (#4883)
* DOCSP-31908 changing warning and adding redirects * DOCSP-31908 updating warning title * DOCSP-31908 removing pages and sections * DOCSP-31908 editing warning * DOCSP-31908 removing references to free monitoring * DOCSP-31908 removing references to free monitoring * DOCSP-31908 removing references to free monitoring * DOCSP-31908 removing references to free monitoring * DOCSP-31908 removing references to free monitoring * DOCSP-31908 removing references to free monitoring * DOCSP-31908 typo fix * DOCSP-31908 * DOCSP-31908 applying redirect to all versions
1 parent 1c4c275 commit 3e29e51

18 files changed

+20339
-886
lines changed

config/redirects

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2538,6 +2538,15 @@ raw: ${prefix}/${version}/applications/drivers -> ${base}/drivers/
25382538
# DOCSP-32198 Redirect removed page
25392539
[v7.0-*]: ${prefix}/${version}/tutorial/upgrade-revision -> ${base}/${version}/release-notes/
25402540

2541+
# DOCSP-31908 Removing free monitoring pages after decomission
2542+
[*]: ${prefix}/${version}/reference/method/db.enableFreeMonitoring -> ${base}/${version}/administration/free-monitoring/
2543+
[*]: ${prefix}/${version}/reference/method/db.disableFreeMonitoring -> ${base}/${version}/administration/free-monitoring/
2544+
[*]: ${prefix}/${version}/reference/method/db.getFreeMonitoringStatus -> ${base}/${version}/administration/free-monitoring/
2545+
[*]: ${prefix}/${version}/reference/method/js-free-monitoring -> ${base}/${version}/administration/free-monitoring/
2546+
[*]: ${prefix}/${version}/reference/command/nav-free-monitoring -> ${base}/${version}/administration/free-monitoring/
2547+
[*]: ${prefix}/${version}/reference/command/getFreeMonitoringStatus -> ${base}/${version}/administration/free-monitoring/
2548+
[*]: ${prefix}/${version}/reference/command/setFreeMonitoring -> ${base}/${version}/administration/free-monitoring/
2549+
25412550
# Fixing
25422551
raw: https://api.mongodb.com/python/current/ -> ${base}/drivers/python/
2543-
raw: https://mongodb.github.io/mongo-java-driver/ -> ${base}/drivers/java/sync/current/
2552+
raw: https://mongodb.github.io/mongo-java-driver/ -> ${base}/drivers/java/sync/current/

redirects.txt

Lines changed: 20316 additions & 0 deletions
Large diffs are not rendered by default.

source/administration/free-monitoring.txt

Lines changed: 1 addition & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -16,88 +16,4 @@ Free Monitoring
1616
:class: singlecol
1717

1818

19-
.. include:: /includes/fact-free-monitoring-deprecation-warning.rst
20-
21-
.. versionadded:: 4.0
22-
23-
Starting in version 4.0, MongoDB (Community Edition) offers free Cloud
24-
monitoring for standalones and replica sets.
25-
26-
Monitored Data
27-
--------------
28-
29-
Free monitoring provides information about your deployment, including:
30-
31-
- Operation Execution Times
32-
33-
- Memory Usage
34-
35-
- CPU Usage
36-
37-
- Operation Counts
38-
39-
The data expires 24 hours after being uploaded. For more information on
40-
the data upload and expiration, see
41-
:ref:`free-monitoring-data-expiration`.
42-
43-
Enable/Disable Free Monitoring
44-
------------------------------
45-
46-
By default, you can enable/disable free monitoring during runtime using
47-
:method:`db.enableFreeMonitoring()` and :method:`db.disableFreeMonitoring()`.
48-
49-
You can also enable or disable free monitoring during
50-
:binary:`~bin.mongod` startup using either:
51-
52-
- the configuration file setting :setting:`cloud.monitoring.free.state`
53-
or
54-
55-
- the command-line option :option:`--enableFreeMonitoring <mongod --enableFreeMonitoring>`
56-
57-
Once you enable free monitoring, it remains enabled until you disable
58-
it.
59-
60-
To view the state of your free monitoring,
61-
62-
- Use the :method:`db.getFreeMonitoringStatus()` method.
63-
64-
- The :dbcommand:`serverStatus` and the helper
65-
:method:`db.serverStatus()` also includes free monitoring statistics
66-
in the :serverstatus:`freeMonitoring` field.
67-
68-
Access Control
69-
--------------
70-
71-
When running with access control, the user must have the following
72-
privileges to enable free monitoring and get status:
73-
74-
.. code-block:: javascript
75-
76-
{ resource: { cluster : true }, actions: [ "setFreeMonitoring", "checkFreeMonitoringStatus" ] }
77-
78-
The built-in role :authrole:`clusterMonitor` role provides this
79-
privilege.
80-
81-
.. _free-monitoring-data-expiration:
82-
83-
Monitored Data and Expiration
84-
-----------------------------
85-
86-
When enabled, the monitored data is uploaded periodically. The
87-
monitored data expires after 24 hours. That is, you can only access
88-
monitored data that has been uploaded within the past 24 hours.
89-
90-
If you disable free monitoring and later re-enable free monitoring, you
91-
can access your previous metrics that have not expired within the past
92-
24 hours.
93-
94-
Monitoring URL
95-
--------------
96-
97-
When you enable free monitoring, you are provided with a unique
98-
URL where you can access your monitored data.
99-
100-
.. important::
101-
102-
Anyone with whom you share this unique URL can access your monitored
103-
data.
19+
.. include:: /includes/fact-free-monitoring-deprecation-warning.rst

source/administration/monitoring.txt

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,6 @@ Monitoring Strategies
3232
MongoDB provides various methods for collecting data about the state of
3333
a running MongoDB instance:
3434

35-
- Starting in version 4.0, MongoDB offers :doc:`free Cloud monitoring
36-
</administration/free-monitoring>` for standalones and replica sets.
37-
3835
- MongoDB distributes a set of utilities that provides real-time
3936
reporting of database activities.
4037

@@ -65,20 +62,6 @@ This section provides an overview of the reporting methods distributed
6562
with MongoDB. It also offers examples of the kinds of questions that
6663
each method is best suited to help you address.
6764

68-
Free Monitoring
69-
~~~~~~~~~~~~~~~
70-
71-
.. versionadded:: 4.0
72-
73-
MongoDB offers :doc:`free Cloud monitoring
74-
</administration/free-monitoring>` for standalones or replica sets.
75-
76-
By default, you can enable/disable free monitoring during runtime using
77-
:method:`db.enableFreeMonitoring()` and :method:`db.disableFreeMonitoring()`.
78-
79-
Free monitoring provides up to 24 hours of data. For more details, see
80-
:doc:`/administration/free-monitoring`.
81-
8265
Utilities
8366
~~~~~~~~~
8467

@@ -391,15 +374,6 @@ to the time difference between the :term:`primary` and the
391374

392375
.. include:: /includes/fact-oplog-size.rst
393376

394-
Free Monitoring
395-
~~~~~~~~~~~~~~~
396-
397-
.. note::
398-
399-
Starting in version 4.0, MongoDB offers :doc:`free monitoring
400-
</administration/free-monitoring>` for standalone and replica sets.
401-
For more information, see :doc:`/administration/free-monitoring`.
402-
403377
Slow Application of Oplog Entries
404378
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
405379

source/includes/fact-free-monitoring-deprecation-warning.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
.. warning:: Free monitoring is deprecated
1+
.. warning:: Free monitoring is decommissioned.
22

3-
Free monitoring was deprecated in April 2023 and will be decommissioned
4-
in August 2023.
3+
Free monitoring was decommmissioned in August 2023.
54

6-
Beginning in April 2023, you can’t enable free monitoring on MongoDB
7-
Community instances. Deployments currently using free monitoring can
8-
continue to access the free monitoring UI until August 2023.
5+
Beginning in April 2023, you cannot enable free monitoring on MongoDB
6+
Community instances.
97

10-
You can choose another monitoring option for your deployment:
8+
The following list shows monitoring options for your deployment:
119

1210
- **Deploy a MongoDB Atlas dedicated cluster**. :ref:`Migrate your
1311
data <live-migration>` to a :ref:`MongoDB Atlas

source/reference/command.txt

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1214,30 +1214,6 @@ Diagnostic Commands
12141214

12151215
/reference/command/nav-diagnostic
12161216

1217-
Free Monitoring Commands
1218-
~~~~~~~~~~~~~~~~~~~~~~~~
1219-
1220-
.. list-table::
1221-
:header-rows: 1
1222-
1223-
* - Name
1224-
1225-
- Description
1226-
1227-
- {+atlas+} Support
1228-
1229-
* - :dbcommand:`setFreeMonitoring`
1230-
1231-
- Enables/disables free monitoring during runtime.
1232-
1233-
- Yes
1234-
1235-
.. toctree::
1236-
:titlesonly:
1237-
:hidden:
1238-
1239-
/reference/command/nav-free-monitoring
1240-
12411217
Auditing Commands
12421218
-----------------
12431219

source/reference/command/getFreeMonitoringStatus.txt

Lines changed: 0 additions & 100 deletions
This file was deleted.

source/reference/command/nav-free-monitoring.txt

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)