Skip to content

Commit 920d650

Browse files
DOCSP-30150 Mention that performance tab doesn't work for QE collections (#621)
* (DOCSP-30150): Mention that the performance tab doesn't work for QE * update screenshot * update page title * address review feedback * typo * wording
1 parent d4c3e9c commit 920d650

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed
-16.3 KB
Loading

source/performance.txt

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
===========
2-
Performance
3-
===========
1+
.. _performance-tab:
2+
3+
==========================
4+
View Real-Time Performance
5+
==========================
46

57
.. default-domain:: mongodb
68

@@ -10,18 +12,23 @@ Performance
1012
:depth: 1
1113
:class: singlecol
1214

13-
.. _performance-tab:
15+
To access the real-time server performance view:
16+
17+
#. Connect to a deployment.
18+
19+
#. Click :guilabel:`Performance` in the left pane.
1420

15-
Performance Tab
16-
---------------
21+
Limitations
22+
-----------
1723

18-
To access the real-time server performance view, click the
19-
cluster name in the upper left corner and select the
20-
:guilabel:`Performance` tab.
24+
- The :guilabel:`Performance` view is not available if you are connected
25+
to an :atlas:`Atlas Data Lake </data-lake>`.
2126

22-
.. figure:: /images/compass/performance-view.png
23-
:figwidth: 700px
24-
:alt: Example of cluster performance view
27+
- |compass| cannot retrieve performance data for collections that use
28+
:ref:`Queryable Encryption <qe-manual-feature-qe>`.
29+
30+
- |compass| shows limited performance data when connected to a
31+
:binary:`mongos`.
2532

2633
Server Stats
2734
------------
@@ -83,27 +90,26 @@ The :guilabel:`Performance` tab displays various stats:
8390
operations correspond to a given moment in the charts; i.e. as
8491
you move over the charts, the corresponding slowest operations
8592
are displayed in the table. To view the details of a slow
86-
operation or :ref:`kill the operation <kill-long-ops>`, click on
93+
operation or :ref:`stop the operation <kill-long-ops>`, click on
8794
the operation.
8895

8996
.. _kill-long-ops:
9097

91-
Kill Slow Operations
98+
Stop Slow Operations
9299
--------------------
93100

94-
.. important:: Required Permissions
101+
You can stop slow operations from the :guilabel:`Performance Tab`.
95102

96-
On deployments which require
97-
:manual:`authentication </core/authentication/>`, to kill operations
98-
not owned by the user, the user must have access that includes the
99-
:authaction:`killop` privilege action.
103+
.. important:: Required Permissions
100104

101-
You can kill slow operations from the :guilabel:`Performance Tab`.
105+
On deployments that require :manual:`authentication
106+
</core/authentication/>`, to stop operations that you don't own, you
107+
must have the :authaction:`killop` privilege action.
102108

103109
.. procedure::
104110
:style: normal
105111

106-
.. step:: Click the query you would like to kill in the :guilabel:`Slowest Operations` section.
112+
.. step:: Click the query you want to stop in the :guilabel:`Slowest Operations` section.
107113

108114
.. step:: In the :guilabel:`Operation Details` view, click :guilabel:`Kill Op`.
109115

@@ -118,9 +124,3 @@ collection of the underlying data. To restart the display updates, click
118124
Next to the :guilabel:`Pause` button is a clock which shows the
119125
current time while the graphs are updating. If the display is
120126
paused, the clock shows the time at which the pause began.
121-
122-
Limitation
123-
----------
124-
125-
The :guilabel:`Performance` tab is not available if you are connected
126-
to a :atlas:`Data Lake </data-lake>`.

0 commit comments

Comments
 (0)