Skip to content

Commit 4a4082c

Browse files
ltran-mdb2ltran-mdb2
authored
DOCSP 31908 v6.0 backport - removing free monitoring pages and references (#5035)
* 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 * DOCSP-31908-v.60-backport removing redirect
1 parent b3172e5 commit 4a4082c

17 files changed

+63
-902
lines changed

‎config/redirects

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2387,3 +2387,30 @@ raw: ${prefix}/${version}/applications/drivers -> ${base}/drivers/
23872387

23882388
(v4.2-*]: ${prefix}/${version}/reference/method/db.copyDatabase -> ${base}/database-tools/mongodump/#std-label-mongodump-example-copy-clone-database
23892389
(v4.2-*]: ${prefix}/${version}/reference/method/db.cloneDatabase -> ${base}/database-tools/mongodump/#std-label-mongodump-example-copy-clone-database
2390+
2391+
[v6.1-*]: ${base}/manual/tutorial/monitor-with-snmp-on-windows/ -> ${base}/${version}/
2392+
[v6.1-*]: ${base}/manual/tutorial/monitor-with-snmp/ -> ${base}/${version}/
2393+
[v6.1-*]: ${base}/manual/tutorial/troubleshoot-snmp/ -> ${base}/${version}/
2394+
2395+
# DOCS-9723 removed this page
2396+
[v7.0-*]: ${prefix}/${version}/core/index-intersection -> ${base}/${version}/indexes/
2397+
2398+
# Redirects for DOCSP-28477
2399+
[v4.2-*]: ${prefix}/${version}aggregation -> ${base}/${version}/aggregation
2400+
[v4.2-*]: ${prefix}/${version}core/read-preference -> ${base}/${version}/core/read-preference
2401+
[v4.2-*]: ${prefix}/${version}installation -> ${base}/${version}/installation
2402+
[v4.2-*]: ${prefix}/${version}reference/built-in-roles/ -> ${base}/${version}/reference/built-in-roles/
2403+
[v4.2-*]: ${prefix}/${version}reference/command/dbStats -> ${base}/${version}/reference/command/dbStats
2404+
[v4.2-*]: ${prefix}/${version}reference/connection-string/ -> ${base}/${version}/reference/connection-string
2405+
[v4.2-*]: ${prefix}/${version}reference/mongodb-extended-json/ -> ${base}/${version}/reference/mongodb-extended-json/
2406+
[v4.2-*]: ${prefix}/${version}reference/operator/aggregation/dateToString/ -> ${base}/${version}/reference/operator/aggregation/dateToString
2407+
[v4.2-*]: ${prefix}/${version}reference/operator/aggregation/toString/ -> ${base}/${version}/reference/operator/aggregation/toString/
2408+
[v4.2-*]: ${prefix}/${version}support/ -> ${base}/${version}/support
2409+
[v4.2-*]: ${prefix}/${version}tutorial/resync-replica-set-member/ -> ${base}/${version}/tutorial/resync-replica-set-member/
2410+
2411+
# DOCSP-32198 Redirect removed page
2412+
[v7.0-*]: ${prefix}/${version}/tutorial/upgrade-revision -> ${base}/${version}/release-notes/
2413+
2414+
# Fixing
2415+
raw: https://api.mongodb.com/python/current/ -> ${base}/drivers/python/
2416+
raw: https://mongodb.github.io/mongo-java-driver/ -> ${base}/drivers/java/sync/current/

‎source/administration/free-monitoring.txt

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

1818

19-
.. warning:: Free monitoring is deprecated
20-
21-
Free monitoring will be deprecated in April 2023 and decommissioned
22-
in August 2023.
23-
24-
Beginning in April 2023, new users can’t enable free monitoring on
25-
MongoDB Community instances. Deployments currently using free
26-
monitoring can continue to access the free monitoring UI until August
27-
2023.
28-
29-
You can choose another monitoring option for your deployment:
30-
31-
- **Deploy a MongoDB Atlas dedicated cluster**. :ref:`Migrate your
32-
data <live-migration>` to a :ref:`MongoDB Atlas
33-
<atlas-getting-started>` dedicated cluster sized M10 or greater,
34-
which includes several advanced monitoring and alerting features:
35-
36-
- :ref:`Query Profiler <query-profiler>`
37-
- :ref:`Performance Advisor <performance-advisor>`
38-
- :ref:`Real-Time Performance Panel <real-time-metrics-status-tab>`
39-
40-
- **Deploy a MongoDB Atlas free cluster**. A free Atlas cluster includes
41-
basic monitoring and alerting capabilities. After you
42-
:atlas:`create a free cluster
43-
</tutorial/deploy-free-tier-cluster/>`, use :binary:`mongodump` and
44-
:binary:`mongorestore` to manually create a backup of your database
45-
and import your data from your MongoDB Community instance.
46-
47-
- **Use MongoDB Cloud Manager**. The `MongoDB Cloud Manager
48-
<https://docs.cloudmanager.mongodb.com/>`_ free tier includes basic
49-
monitoring capabilities.
50-
51-
.. versionadded:: 4.0
52-
53-
Starting in version 4.0, MongoDB (Community Edition) offers free Cloud
54-
monitoring for standalones and replica sets.
55-
56-
Monitored Data
57-
--------------
58-
59-
Free monitoring provides information about your deployment, including:
60-
61-
- Operation Execution Times
62-
63-
- Memory Usage
64-
65-
- CPU Usage
66-
67-
- Operation Counts
68-
69-
The data expires 24 hours after being uploaded. For more information on
70-
the data upload and expiration, see
71-
:ref:`free-monitoring-data-expiration`.
72-
73-
Enable/Disable Free Monitoring
74-
------------------------------
75-
76-
By default, you can enable/disable free monitoring during runtime using
77-
:method:`db.enableFreeMonitoring()` and :method:`db.disableFreeMonitoring()`.
78-
79-
You can also enable or disable free monitoring during
80-
:binary:`~bin.mongod` startup using either:
81-
82-
- the configuration file setting :setting:`cloud.monitoring.free.state`
83-
or
84-
85-
- the command-line option :option:`--enableFreeMonitoring <mongod --enableFreeMonitoring>`
86-
87-
Once you enable free monitoring, it remains enabled until you disable
88-
it.
89-
90-
To view the state of your free monitoring,
91-
92-
- Use the :method:`db.getFreeMonitoringStatus()` method.
93-
94-
- The :dbcommand:`serverStatus` and the helper
95-
:method:`db.serverStatus()` also includes free monitoring statistics
96-
in the :serverstatus:`freeMonitoring` field.
97-
98-
Access Control
99-
--------------
100-
101-
When running with access control, the user must have the following
102-
privileges to enable free monitoring and get status:
103-
104-
.. code-block:: javascript
105-
106-
{ resource: { cluster : true }, actions: [ "setFreeMonitoring", "checkFreeMonitoringStatus" ] }
107-
108-
The built-in role :authrole:`clusterMonitor` role provides this
109-
privilege.
110-
111-
.. _free-monitoring-data-expiration:
112-
113-
Monitored Data and Expiration
114-
-----------------------------
115-
116-
When enabled, the monitored data is uploaded periodically. The
117-
monitored data expires after 24 hours. That is, you can only access
118-
monitored data that has been uploaded within the past 24 hours.
119-
120-
If you disable free monitoring and later re-enable free monitoring, you
121-
can access your previous metrics that have not expired within the past
122-
24 hours.
123-
124-
Monitoring URL
125-
--------------
126-
127-
When you enable free monitoring, you are provided with a unique
128-
URL where you can access your monitored data.
129-
130-
.. important::
131-
132-
Anyone with whom you share this unique URL can access your monitored
133-
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
@@ -30,9 +30,6 @@ Monitoring Strategies
3030
MongoDB provides various methods for collecting data about the state of
3131
a running MongoDB instance:
3232

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

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

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

@@ -389,15 +372,6 @@ to the time difference between the :term:`primary` and the
389372

390373
.. include:: /includes/fact-oplog-size.rst
391374

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

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. warning:: Free monitoring is decommissioned.
2+
3+
Free monitoring was decommmissioned in August 2023.
4+
5+
Beginning in April 2023, you cannot enable free monitoring on MongoDB
6+
Community instances.
7+
8+
The following list shows monitoring options for your deployment:
9+
10+
- **Deploy a MongoDB Atlas dedicated cluster**. :ref:`Migrate your
11+
data <live-migration>` to a :ref:`MongoDB Atlas
12+
<atlas-getting-started>` dedicated cluster sized M10 or greater,
13+
which includes several advanced monitoring and alerting features:
14+
15+
- :ref:`Query Profiler <query-profiler>`
16+
- :ref:`Performance Advisor <performance-advisor>`
17+
- :ref:`Real-Time Performance Panel <real-time-metrics-status-tab>`
18+
19+
- **Deploy a MongoDB Atlas free cluster**. A free Atlas cluster includes
20+
basic monitoring and alerting capabilities. After you
21+
:atlas:`create a free cluster
22+
</tutorial/deploy-free-tier-cluster/>`, use :binary:`mongodump` and
23+
:binary:`mongorestore` to manually create a backup of your database
24+
and import your data from your MongoDB Community instance.
25+
26+
- **Use MongoDB Cloud Manager**. The `MongoDB Cloud Manager
27+
<https://docs.cloudmanager.mongodb.com/>`_ free tier includes basic
28+
monitoring capabilities.

‎source/reference/command.txt

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

12001200
/reference/command/nav-diagnostic
12011201

1202-
Free Monitoring Commands
1203-
~~~~~~~~~~~~~~~~~~~~~~~~
1204-
1205-
.. list-table::
1206-
:header-rows: 1
1207-
1208-
* - Name
1209-
1210-
- Description
1211-
1212-
- {+atlas+} Support
1213-
1214-
* - :dbcommand:`setFreeMonitoring`
1215-
1216-
- Enables/disables free monitoring during runtime.
1217-
1218-
- Yes
1219-
1220-
.. toctree::
1221-
:titlesonly:
1222-
:hidden:
1223-
1224-
/reference/command/nav-free-monitoring
1225-
12261202
Auditing Commands
12271203
-----------------
12281204

‎source/reference/command/getFreeMonitoringStatus.txt

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

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

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

0 commit comments

Comments
 (0)