Skip to content

Commit

Permalink
added content and updated sarshboard status
Browse files Browse the repository at this point in the history
  • Loading branch information
catalinaadam committed Sep 4, 2024
1 parent 5471264 commit 1d6032d
Show file tree
Hide file tree
Showing 9 changed files with 159 additions and 73 deletions.
Binary file added docs/_images/Mongodb_Collections_Overview.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Mongodb_Oplog.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/alert_flow - Copy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
# Experimental MongoDB Collection Overview

!!! caution alert alert-warning "Disclaimer"
This is an Experimental Dashboard that is not part of the official Percona Monitoring and Management (PMM) deployment and might be updated. We ship this Dashboard to obtain feedback from our users.

!!! note alert alert-primary "Availability"
This experimental dashboard is available starting with PMM 2.30.0.
# MongoDB Collections Overview

This realtime dashboard contains panels of data about the Hottest Collections in the MongoDB database.

The Instance level includes two panels, one for the *Hottest Collections by Read (Total)* and the *Hottest Collections by Write (total)*.
The Instance level includes two panels, one for the **Hottest Collections by Read (Total)** and the **Hottest Collections by Write (total)**.

The next panel displays data at the *Database Level*, where you can view MongoDB metrics such as *Commands*, *Inserts*, *Updates*, *Removes*, and *Getmore*.
The next panel displays data at the **Database Level**, where you can view MongoDB metrics such as **Commands**, **Inserts**, **Updates**, **Removes**, and **Getmore**.

The last panel shows the number of operations in the chosen database.

![!image](../../_images/PMM_Mongodb_Collections_Overview_Experimental.png)
![!image](../../_images/Mongodb_Collections_Overview.png)
11 changes: 0 additions & 11 deletions docs/details/dashboards/dashboard-mongodb-experimental_oplog.md

This file was deleted.

5 changes: 5 additions & 0 deletions docs/details/dashboards/dashboard-mongodb_oplog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# MongoDB Oplog Details

This realtime dashboard contains Oplog details such as Recovery Window, Processing Time, Buffer Capacity, and Oplog Operations.

![!image](../../_images/Mongodb_Oplog.png)
93 changes: 56 additions & 37 deletions docs/details/dashboards/dashboard-replsetsummary-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,79 +11,118 @@ The dashboard displays key metrics for individual nodes and the entire replica s

The overview section displays essential data for individual nodes, such as their role, CPU usage, memory consumption, disk space, network traffic, uptime, and the current MongoDB version.

## State

Displays the current state of a MongoDB replica set member. It shows a single value representing the node's role, such as PRIMARY, SECONDARY, or ARBITER. The state is color-coded for quick visual identification. This information is crucial for understanding the current role and health of each node in your MongoDB replica set.

### CPU Usage

This section shows the CPU usage over time, highlighting the percentage of CPU capacity utilized by each node in the replica set.
Displays the current CPU usage percentage for the selected MongoDB service. It shows how much of the CPU's capacity is being used, with a range from 0% to 100%.

The gauge is color-coded, turning red when usage exceeds 80%, helping you quickly identify high CPU load situations. This metric is crucial for monitoring the performance and resource utilization of your MongoDB instance, allowing you to spot potential bottlenecks or overloaded servers at a glance.

### Memory Used

Indicates how much memory can be used without causing swapping, ensuring efficient memory management.
Shows an estimate of how much memory can be used without causing swapping on the MongoDB server. It displays the percentage of memory currently in use, with 100% indicating that all available memory is used and swapping may occur. The gauge turns red above 80% usage, signaling that free memory is running low. This metric is crucial for predicting potential performance issues due to memory constraints, helping you proactively manage your MongoDB instance's memory resources to avoid swapping and maintain optimal performance.

### Disk I/O Utilization

Displays disk utilization as a percentage, showing how often there was at least one I/O request in flight. This metric helps determine if disk load was evenly distributed or if I/O was bottlenecked, potentially leading to queuing and latency.
Displays disk utilization as a percentage, showing how often there was at least one I/O request active for the MongoDB server. Ranging from 0% to 100%, it helps determine if disk load is evenly distributed or if I/O is bottlenecked. Higher values suggest more intense, potentially queued disk activity. The gauge turns red above 80%, indicating possible I/O constraints. Use this metric alongside I/O latency and queue depth to assess overall storage performance and identify potential disk-related issues affecting your MongoDB instance's responsiveness

### Disk Space Utilization

Provides detailed information about disk space usage on the specified mount point, including used space, free space, and total disk space. Low free space can lead to *Disk full* errors, which may cause system crashes or service interruptions.
Shows the percentage of used disk space for the MongoDB server's data storage. It ranges from 0% to 100%, with higher values indicating less free space. The gauge turns red above 80% usage, warning of potential disk space issues. This metric is crucial for preventing *Disk full* errors that could disrupt services or crash the system. When free space approaches zero, consider removing unused files or expanding storage capacity to ensure smooth MongoDB operation and prevent data-related incidents.

### Disk IOPS

Tracks the number of physical I/O operations (reads and writes) served by different devices. Spikes in IOPS can indicate performance issues related to I/O subsystem overload.
This stat panel displays the current rate of disk Input/Output Operations Per Second (IOPS) for the MongoDB server, showing separate values for read and write operations. It provides a real-time view of the physical I/O load on the storage system. The panel uses an area graph to visualize recent trends. High IOPS values or sudden spikes can indicate potential performance issues due to I/O subsystem overload. Monitor this metric to identify periods of intense disk activity and potential storage bottlenecks that could affect MongoDB's performance.

### Network Traffic

Monitors the volume of data moving across the network at any given time, helping identify potential network bottlenecks.
Displays the current network traffic for the MongoDB server, showing separate values for inbound and outbound data transfer rates in bytes per second. It uses an area graph to visualize recent trends in network activity. The panel provides a real-time view of data movement across the network, helping you monitor the MongoDB server's network load.

High values or sudden spikes can indicate increased database activity, potential performance bottlenecks, or unusual network patterns. Use this metric to assess network utilization and identify periods of intense data transfer that might affect MongoDB's performance or user experience.

### Uptime

Shows how long each node in the replica set has been running without a shutdown or restart.
Displays the current uptime of the MongoDB server, showing how long it has been running without a shutdown or restart. The value is presented in seconds and uses color-coding for quick status assessment: red for very recent starts, orange for short uptimes, and green for longer periods.

This metric is useful for tracking system stability, identifying recent restarts, and monitoring continuous operation time. Long uptimes generally indicate stable operation, while short uptimes might suggest recent maintenance or unexpected restarts that could warrant investigation.

### Version

Displays the current MongoDB version for each node in the replica set.
Shows the current version of MongoDB running on the selected node in the replica set.

This information is crucial for ensuring consistency across your MongoDB deployment, tracking upgrade status, and identifying potential version-related issues or compatibility concerns. Regular checks of this panel can help maintain a uniform MongoDB version across your infrastructure and assist in planning future upgrades or troubleshooting version-specific problems.

## States

Tracks the replica set state over a specified time period. For more details on replica set states, see to the [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/replica-states/).
### Node States

Visualizes the status changes of each node in the MongoDB replica set over the selected time range.

The timeline format allows you to easily track state transitions, identify periods of instability, and understand the roles of different nodes throughout the monitored period. This visualization is crucial for monitoring replica set health, detecting failovers or reconfigurations, and ensuring the overall stability of your MongoDB cluster. Use this panel to quickly spot any unusual patterns or frequent state changes that might require further investigation.

For more details on replica set states, see to the [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/replica-states/).

## Details

### Command Operations

Shows the number of operations per second, classified by legacy wire protocol type (e.g., query, insert, update, delete). It also includes documents deleted per second by TTL indexes.
Shows the rates of different MongoDB operations per second, including primary operations (like queries, inserts, updates, and deletes), replicated operations on secondary nodes, and automatic deletions by TTL indexes.

It helps you visualize your database's workload, showing how different types of operations contribute to overall activity. Use this to spot unusual patterns, balance between read and write operations, and understand your MongoDB instance's performance at a glance.

### Top Hottest Collections by Read

Lists the five collections with the most read operations.
Lists the five collections with the highest read activity. Use this The panel to quickly identify which collections are under the most demand, allowing you to monitor read-heavy workloads and optimize performance accordingly.

### Query Execution Times

Displays the average latency of operations, categorized by read, write, or command.
Displays the average latency of operations, categorized by read, write, or command. It visualizes how long each type of operation takes to execute over time, helping you identify trends or potential performance bottlenecks in your database operations Use this panel to you to monitor and optimize the responsiveness of your MongoDB cluster.

### Top Hottest Collections by Write

Lists the five collections with the most write operations.

### Query Efficiency

Measures the ratio of documents (or index entries) scanned to documents returned. A ratio of 1 indicates that all returned documents perfectly match the query criteria.
Measures the efficiency of queries in your MongoDB cluster by showing the ratio of documents or index entries scanned versus documents returned. A ratio of 1 indicates that every document returned matched the query criteria exactly, while a higher value, such as 100, suggests that on average, 100 documents were scanned to return a single document.

Use this panel to assess query performance, identify inefficient queries, and optimize indexing strategies.

### Queued Operations

Shows operations that are queued due to lock contention.
Displays the number of operations that are queued due to locks within your MongoDB cluster. It helps identify performance bottlenecks by showing how many operations are waiting because of locking issues.

Use this panel to track these queued operations and monitor the impact of locking on system performance over time and take action if necessary.

### Reads & Writes

Tracks read and write operations over time, with reads representing data queries and writes representing data modifications.
Tracks the number of read and write operations over time in your MongoDB environment. Reads represent data queries, while writes represent data modifications.


Use this panel to get insights into the workload distribution and monitor the performance of database operations, ensuring that the system is handling read and write operations efficiently.

### Connections

Displays the total available and currently active database connections over time.
monitors the average number of active and available MongoDB connections over time.

Use this panel to track connection usage and ensure the database has sufficient capacity to handle incoming requests without reaching its limit.

## Collection Details

MongoDB organizes data in collections, which are similar to tables in relational databases.
### Size of Collections

Displays the storage size of MongoDB collections, which are analogous to tables in relational databases, offering insights into the storage footprint of each collection across different nodes.

Use it to effectively monitor and manage data distribution and storage consumption. The data is organized by database name, collection, and node, and can be easily filtered and sorted for detailed analysis.

### Number of Collections

Provides a count of collections across different databases and nodes, helping you understand the structure and scale of your MongoDB deployments. The data is organized by database name and node, and you can filter and sort it for detailed insights.

Use this table to monitor the distribution of collections and manage your database schema effectively.

## Replication

Expand Down Expand Up @@ -124,23 +163,3 @@ Tracks disk I/O operations and swap activity, which involve transferring data be
## Network Traffic

Monitors network traffic, showing the amount of data moving across the network at any given time.

## Operations - by Service Name

Classifies operations by legacy wire protocol type (insert, update, and delete only).

## Max Member Ping Time - by Service Name

Tracks the maximum ping time between replica set members, which can correlate with replication lag.

## Max Heartbeat Time

Measures the time elapsed since the last heartbeat from replica set members.

## Elections

Counts the number of elections, which typically occur when the primary role changes due to maintenance or issues.

## Oplog Recovery Window - by Service Name

Displays the timespan between the newest and oldest operations in the Oplog collection for each service name.
Loading

0 comments on commit 1d6032d

Please sign in to comment.