@@ -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
0 commit comments