Skip to content

Commit 1f5ddb1

Browse files
authored
(DOCSP-12329) updates OM profiler page info (#118)
This PR moves over ongoing changes from [this PR](10gen/mms-docs#5010) from the old mms repo. Addressing outstanding feedback from @Isabel11 from the old PR: > Have you verified that > Change Slow Operations Threshold > Request Index Suggestions > do work in OM? I am not sure these are supported features in the Profiler page (I may be wrong here) > **Request Index Suggestions** did not appear to be a supported feature in the Profiler page, so I removed the corresponding section. > Profiler is its own tab on the page - metrics displays metrics specifically but is separate from Profiler. Addressed in this new PR. Referencing the sentence "Log data is processed in batches. Data can be delayed up to five minutes from realtime.": > I am curious where the 5 minutes is coming from? Is this the mongod batching the logs? This information was derived from [the corresponding page](https://www.mongodb.com/docs/atlas/tutorial/profile-database/) in the Atlas docs. [See here](https://www.mongodb.com/docs/atlas/tutorial/profile-database/#data-display-limitations). - [DOCSP-12329](https://jira.mongodb.org/browse/DOCSP-12329) - [STAGING](https://preview-mongodbcarriecwk.gatsbyjs.io/ops-manager/DOCSP-12329/tutorial/profile-database/) - [LATEST BUILD LOG](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=65e1091011db7b04275a44d8) ### Self-Review Checklist - [x] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [x] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [x] Resolve any new warnings or errors in the build. - [x] Proofread for spelling and grammatical errors. - [x] Check staging for rendering issues. - [x] Confirm links are working.
1 parent 11a536f commit 1f5ddb1

File tree

1 file changed

+15
-63
lines changed

1 file changed

+15
-63
lines changed

source/tutorial/profile-database.txt

Lines changed: 15 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ Profile Databases
1111
This feature is available only with the {+mdbagent-wa+}. To learn
1212
more about the {+mdbagent-wa+}, see
1313
:ref:`add-mdb-processes`.
14+
15+
.. facet::
16+
:name: genre
17+
:values: reference
1418

1519
.. contents:: On this page
1620
:local:
@@ -23,9 +27,10 @@ gathers statistics about writes, cursors, and commands on one running
2327
|mongod| instance.
2428

2529
|mms| can collect and display statistics from any of your |mongod|
26-
instances that have profiling enabled. |mms| displays this data in the
27-
:guilabel:`Profiler` section of an instance's :guilabel:`Metrics` page.
28-
To access an instance's metrics, click the :guilabel:`Metrics` button
30+
instances. The Query Profiler identifies slow queries based on
31+
:ref:`log data <mongodb-logs>` from your ``mongod`` instances.
32+
|mms| displays this data on an instance's :guilabel:`Profiler` page.
33+
To access an instance's metrics, click the :guilabel:`Metrics` button
2934
for that instance.
3035

3136
The :guilabel:`Profiler` displays one aspect, like *Operation Execution
@@ -48,53 +53,21 @@ Profile data may include sensitive information including the content of
4853
database queries. Ensure that exposing this data to |mms| is consistent
4954
with your information security practices.
5055

51-
``system.profile`` Collection
52-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
Data Display Limitations
57+
~~~~~~~~~~~~~~~~~~~~~~~~~
5358

54-
The MongoDB profiler stores data in the
55-
``system.profile <<database>.system.profile>`` collection. |mms|
56-
caps this :term:`collection <capped collection>` to 1 MB as a default.
57-
You may increase the size of this collection up to 4 MB.
59+
The Query Profiler displays up to the limit that it reaches first:
5860

59-
When collecting data from the profiler, |mms| ignores operations on
60-
the ``system.profile <<database>.system.profile>`` collection,
61-
such as {+magent+} queries of the
62-
``system.profile <<database>.system.profile>`` collection.
63-
64-
Resource Consumption Impact
65-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
66-
67-
The profiler consumes resources which may slow MongoDB performance.
68-
Consider the resource impact before enabling profiling.
69-
70-
Data Collection
71-
```````````````
72-
73-
Every minute, the agent queries the
74-
``system.profile <<database>.system.profile>`` collection for the
75-
last 20 documents created. Monitoring sends
76-
:manual:`those documents </reference/database-profiler>` to |mms|.
77-
78-
.. seealso::
79-
80-
:manual:`Database Profiler </tutorial/manage-the-database-profiler>`
81-
in the MongoDB Manual.
82-
83-
|mms| samples profile documents until it samples either all documents
84-
returned or 4 MB of returned document data. This 4 MB limit may be
85-
reached if you increase the collection's size to 4 MB *and* your
86-
database creates large
87-
:manual:`profiler documents </reference/database-profiler>`.
61+
- The most recent 10,000 operations, or
62+
- The most recent 10MB of logs.
8863

8964
Monitoring tries to minimize its effect on the monitored systems.
9065
If polling profile data slows database performance, |mms| throttles how
9166
often it collects data.
9267

93-
Data Display
94-
````````````
68+
|mms| displays no more than 10,000 data points in the :guilabel:`Profiler` charts.
9569

96-
|mms| displays no more than 10,000 data points in the
97-
:guilabel:`Profiler` charts.
70+
Log data is processed in batches. Data can be delayed up to five minutes from real time.
9871

9972
Time to Propagate Changes to the {+mdbagent+}
10073
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -179,27 +152,6 @@ To change the slow operations threshold:
179152
When you change the threshold, you change it for all databases on the
180153
instance.
181154

182-
.. _profiler-chart-suggest-indexes:
183-
184-
Request Index Suggestions
185-
`````````````````````````
186-
187-
Based on the Profiler data, you may want to improve the performance of
188-
slow queries.
189-
190-
1. Click :guilabel:`Calculate Suggested Indexes` to direct |mms| to
191-
analyze your databases.
192-
193-
#. After the analysis completes, the
194-
:guilabel:`Suggested Indexes for Improving Query Performance` modal
195-
displays.
196-
197-
This modal offers suggested indexes with the appropriate database
198-
commands to created those indexes.
199-
200-
#. After you have finished using the suggested indexes, click
201-
:guilabel:`OK` to close the modal.
202-
203155
.. _profiler-table:
204156
.. _profiler-table-set-filter:
205157

0 commit comments

Comments
 (0)