Skip to content

Commit 9f2df88

Browse files
authored
Merge pull request #59 from steveren/DOCSP-2589
DOCSP2589: MongoDB Instance page revisions
2 parents 8dc6565 + 1b07e7a commit 9f2df88

File tree

5 files changed

+68
-61
lines changed

5 files changed

+68
-61
lines changed

source/collections.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ for a database, either:
2626
.. figure:: /images/compass/select-database-1.svg
2727
:figwidth: 802px
2828

29-
\- **or** -
29+
- **or** -
3030

3131
- Click on a database in the left-hand pane:
3232

source/databases.txt

Lines changed: 5 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,16 @@ Databases Tab
1919

2020
The :guilabel:`Databases` tab lists the existing databases for your
2121
MongoDB deployment. To access the :guilabel:`Databases` tab, click the
22-
connection home |home| on the left hand pane and click the
22+
:guilabel:`Home` icon in the upper left corner and select the
2323
:guilabel:`Databases` tab.
2424

25-
.. figure:: /images/compass/database-view1.svg
26-
:figwidth: 802px
25+
.. figure:: /images/compass/database-tab.png
26+
:figwidth: 700px
2727

28-
From this tab, in addition to viewing the current databases, you can
28+
In addition to viewing the current databases, you can
2929
also create or delete databases.
3030

31-
.. figure:: /images/compass/database-view.svg
32-
:figwidth: 778px
31+
3332

3433
.. _create-database:
3534

@@ -44,23 +43,3 @@ Drop a Database
4443
---------------
4544

4645
.. include:: /includes/steps/delete-database.rst
47-
48-
View Collection/Index Information for a Database
49-
------------------------------------------------
50-
51-
To view a list of collections for a database, either:
52-
53-
- Click on a database in the :guilabel:`Databases` tab:
54-
55-
.. figure:: /images/compass/select-database-1.svg
56-
:figwidth: 802px
57-
58-
\- **or** -
59-
60-
- Click on a database in the left-hand pane:
61-
62-
.. figure:: /images/compass/select-database-2.svg
63-
:figwidth: 802px
64-
65-
66-
.. |home| unicode:: U+2302
52 KB
Loading

source/instance.txt

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,60 @@
1-
================
2-
MongoDB Instance
3-
================
1+
============
2+
Compass Home
3+
============
44

55
.. default-domain:: mongodb
66

7-
Once connected to a MongoDB instance, the home |home| on the left hand
8-
pane provides details regarding the MongoDB instance, such as:
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
912

10-
- the connection name if the connection is a favorite connection or "My
11-
Cluster" otherwise.
13+
The Compass Home screen provides details regarding the
14+
MongoDB instance to which Compass is connected, including:
1215

13-
- the deployment type (standalone, replica set, sharded cluster). If
16+
- The connection name if the connection is a favorite connection,
17+
or "My Cluster" otherwise.
18+
19+
- The deployment type (standalone, replica set, sharded cluster). If
1420
the deployment is a replica set and the replica set name is specified
1521
in the connection window, the number of replica set members will also
1622
be displayed.
1723

18-
- the hostname and port, as well as the version of MongoDB.
24+
- The hostname and port, as well as the version of MongoDB.
25+
26+
- A list of the instance's :doc:`databases </databases>`.
27+
28+
- Performance statistics, including memory usage, operation counts,
29+
and slowest operations. *(Not Available in Compass Community
30+
Edition)*
31+
32+
Once connected to a MongoDB instance, you can reach the Compass
33+
Home screen by clicking the :guilabel:`Home` icon in the upper left
34+
corner.
1935

20-
.. figure:: /images/compass/instance-view.svg
21-
:figwidth: 800px
36+
Databases Tab
37+
-------------
2238

23-
From the instance home, you can access:
39+
The :guilabel:`Databases` tab of the Home screen shows a list of all
40+
the databases on the current connection, with each one's storage size,
41+
number of collections, and number of indexes. For more information
42+
about the :guilabel:`Databases` tab, see :doc:`Databases </databases>`.
2443

25-
- The :ref:`Databases <database-tab>` tab to view and manage the
26-
databases in the deployment, and
44+
.. _performance-tab:
2745

28-
- The :ref:`Server Performance <performance-tab>` tab to view real time
29-
server stats. *Not Available in Compass Community Edition*
46+
Performance Tab
47+
---------------
48+
49+
The :guilabel:`Performance` tab provides real-time server
50+
performance statistics and graphs, showing insights such as:
51+
52+
- Which database collections receive the most operations
53+
- Which operations take the longest to execute
54+
- Memory utilization
55+
56+
For more information about the :guilabel:`Performance` tab, see
57+
:doc:`Performance </performance>`.
3058

3159
.. class:: hidden
3260

@@ -35,5 +63,3 @@ From the instance home, you can access:
3563

3664
/databases
3765
/performance
38-
39-
.. |home| unicode:: U+2302

source/performance.txt

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==================
2-
Server Performance
3-
==================
1+
===========
2+
Performance
3+
===========
44

55
.. default-domain:: mongodb
66

@@ -17,9 +17,9 @@ Server Performance
1717
Performance Tab
1818
---------------
1919

20-
To access the real-time server performance view, click the connection
21-
home |home| on the left hand pane to go to the :guilabel:`Performance`
22-
tab.
20+
To access the real-time server performance view, click the
21+
:guilabel:`Home` icon in the upper left corner and select the
22+
:guilabel:`Performance` tab.
2323

2424
.. figure:: /images/compass/performance-view.svg
2525
:figwidth: 700px
@@ -71,7 +71,7 @@ The :guilabel:`Performance` tab displays various stats:
7171
- Displays the collections with the most activities as reported
7272
by :binary:`mongotop <bin.mongotop>`.
7373

74-
The collections corresponds to a given moment in the charts;
74+
The collections correspond to a given moment in the charts;
7575
i.e. as you move over the charts, the corresponding collections
7676
are highlighted/displayed in the table.
7777

@@ -80,18 +80,20 @@ The :guilabel:`Performance` tab displays various stats:
8080

8181
- Displays the slowest operations as reported by
8282
:manual:`db.currentOp() </reference/method/db.currentOp>`. The
83-
operations correspond to a moment in the charts; i.e. as you
84-
move over the charts, the corresponding slowest operations are
85-
displayed in the table. To view the details of a slow operation
86-
as reported by :manual:`db.currentOp()
83+
operations correspond to a given moment in the charts; i.e. as
84+
you move over the charts, the corresponding slowest operations
85+
are displayed in the table. To view the details of a slow
86+
operation as reported by :manual:`db.currentOp()
8787
</reference/method/db.currentOp>`, click on the operation.
8888

8989
Pause the Display
9090
~~~~~~~~~~~~~~~~~
9191

92-
The :guilabel:`Pause` button pauses the update of the displays only and
93-
does not pause the collection of the underlying data.
92+
The :guilabel:`Pause` button above the graph display pauses the update
93+
of the displays only. Pausing the performance tab does not impact the
94+
collection of the underlying data. To restart the display updates, click
95+
:guilabel:`Play`.
9496

95-
To restart the display updates, click :guilabel:`Play`.
96-
97-
.. |home| unicode:: U+2302
97+
Next to the :guilabel:`Pause` button is a clock which shows the
98+
current time while the graphs are updating. If the display is
99+
paused, the clock shows the time at which the pause began.

0 commit comments

Comments
 (0)