Review Atlas Search Metrics
Note
Availability
Atlas provides Atlas Search metrics for clusters with at least one active Atlas Search index. To set up an Atlas Search index, see What is MongoDB Atlas Search?.
M0(Free Tier) clusters don't support these metrics.
Required Access
To view Atlas Search indexes, you must have
Project Data Access Read Only or higher access to the project.
View Atlas Search Metrics
To view Atlas Search metrics for a cluster:
Click the View Monitoring button for that cluster.
If you deployed Search Nodes for workload isolation, click the Search Nodes tab to view Atlas Search metrics and the hardware metrics for the Search Nodes.
The Replica Set tab displays the MongoDB and the replica set's hardware metrics.
Select one or more of the search charts.
Alternatively:
Click on the name of the cluster to open the cluster overview.
Click the Metrics tab.
If you deployed Search Nodes for workload isolation, click the Search Nodes tab to view Atlas Search metrics and the hardware metrics for the Search Nodes.
The Replica Set tab displays the MongoDB and the replica set's hardware metrics.
Select one or more of the search charts.
If you deployed Search Nodes for workload isolation, you can also view Atlas Search metrics and the hardware metrics for your Search Nodes by clicking the View Search Metrics tab in your Search page after you create an Atlas Search index.
If you didn't deploy Search Nodes separately, to view Atlas Search metrics for a specific process:
Click the link for the process.
Click the Search Metrics tab.
Monitor cluster metrics to identify performance issues and determine whether your current cluster meets your requirements. For more information on the metrics available to monitor your clusters, see Review Available Metrics.
The following Atlas Search metrics are available to evaluate and optimize your Atlas Search indexes:
Chart | Data |
|---|---|
Search Disk Space Used | Total bytes of disk space that search indexes occupy. |
Search Fields Indexed | Total number of unique fields present in the Atlas Search
index. |
Search Index Size | Total size of all indexes on disk in bytes. |
Search JVM Heap Memory | Amount of memory that the JVM heap is currently
using. |
Search Max Number of Lucene Docs | Upper bound on the number of Lucene docs used to store Atlas Search
indexes in this replica set or shard. |
Search Max Replication Lag | |
Search Normalized Process CPU | CPU usage of search processes on the node scaled to a
range of 0-100% by dividing by the number of CPU cores. |
Search Opcounters | Total number of Atlas Search operations. |
Search Page Fault | Average rate of page faults on this process per second over the
selected sample period. |
Search Process CPU | Percentage of time that the CPU spent servicing
search processes. For servers with more than 1 CPU core, this value can exceed 100%. |
Search Process Memory | Total bytes of memory that search processes occupy. |
Search Query Status | Total number of Atlas Search queries with each status. |
Note
Monitoring Data Storage Granularity
Atlas stores metrics data at increasing granularity levels. For more information, see Monitoring Data Storage Granularity.
Chart Controls
Atlas provides the following controls for the metrics charts. Adjusting any of these options affects all charts displayed under the selected view:
Control | Function |
|---|---|
Granularity | Modifies the granularity of metrics displayed for each chart.
Select a granularity, usually between 1 minute and 1 day (24
hours). Select Atlas supports a 10 second granularity only on |
Zoom | Modifies the date range of metrics displayed for each chart.
Select a zoom range between 1 hour and 5 years. Adjusting
the Zoom automatically adjusts the
Current Display date range. |
Current Display | Modifies the start and end date-time range of metrics displayed
for each chart. Modifying the start and end date sets the
value of Zoom to custom and overrides the
previously selected zoom level. |
Add Chart | Select one or more charts to display or hide. Adding
charts using this dropdown is identical to adding charts
from the Toggle Charts section of the
Metrics view. |
Select Database | Only visible for the DB Stats view. Selects
the database for which to display metrics. |
Display Opcounters on Separate Charts | Directs Atlas to split the Opcounters chart into
its individual components. You can then choose to chart one or
more of those components. If you select this checkbox, Atlas
displays the number of the following operations per second
on the
If you deployed Search Nodes for workload isolation, you can't view opcounters on separate charts in the Search Nodes tab. To group opcounters metrics in the Search Nodes tab, select the Group Opcounters metrics checkbox. |
Display Timeline Annotations | Directs Atlas to display or hide chart annotations.
Chart annotations consist of colored vertical lines that
indicate server events, such as a server restart or
a transition in member state. If you deployed Search Nodes for
workload isolation, you can't display or hide chart annotations
in the Search Nodes tab. |
Chart Display
When viewing charts, you can do the following:
Task | Action |
|---|---|
View a detailed description of a chart. | Hover your mouse over the chart to display the context menu. Click next to the chart name to open the Chart Info modal. This modal includes a breakdown of the chart's data series, the annotations available for that chart, and the operations the chart supports. |
Expand a chart. | Hover your mouse over the chart to display the context menu. Click the two-way arrow at the top right of the chart. |
Zoom in on a period of time. | Click and drag the mouse pointer over a portion of the chart. To reset to the originally selected range (zoom out), double-click the chart. When you zoom in on one period of time, the Current Display date range in the chart control section automatically updates to reflect the selected period. |
View statistics at a particular time. | Hover the mouse pointer over a point on the chart. |
Move a chart. | Click and hold the grabber in the upper left corner of the chart,
and drag the chart to the new position. |
Share a URL to the chart. | Hover your mouse over the chart to display the context menu. Click the curved arrow on the chart. Select Chart Permalink to retrieve a URL to the chart. Select Email Chart to email the chart. The recipient of the chart URL must have a Atlas user account with access to the project and cluster. |
Chart Selection
Atlas displays the available metrics to chart for the selected cluster under the Toggle Charts header.
Charts marked with the + symbol are inactive,
while charts marked with the - symbol are active. Click
on any chart to toggle the chart state.