MongoDB

Introduction

MongoDB is a popular NoSQL database program. It is known for being scalable, flexible, and efficient in handling unstructured data. When people refer to a "Mongo cluster," they are usually talking about a MongoDB Cluster, which is a set of MongoDB servers that work together to provide high availability, fault tolerance, and scalability.

Getting Started

Compatibility

The MongoDB O11ySource is compatible with all versions of MongoDB equal to or greater than 5.0.26.

Data Collection Method

vuSmartMaps collects health and performance data for MongoDB O11ySource using an internal data collector. This agent collects data based on the source configuration.

Prerequisites

Dependent Configuration

To configure this O11ySource, create a 'credential' of type user and tls_certificate_bundle under the 'Definition' tab.

Inputs for Configuring Data Source

• Host: The IP Address/FQDN of the MongoDB host. This field is the key to identify each server you add here.
• Port: Enter a valid port
• Credential: This field is required
• TLS: Enable TLS for the MongoDB connection.
• TLS Mode: Select the TLS credential material required by the MongoDB connection.
• Skip Certificate Verification: Skip TLS server certificate and hostname verification for the MongoDB connection.
• TLS Credential: Select the TLS certificate bundle credential to use for this MongoDB connection.
• Polling Frequency: Specifies the interval in seconds at which data is collected. Data collection occurs once every specified period.

Firewall Requirement

To collect data from this O11ySource, ensure the following ports are opened:

Source IP	Destination IP	Destination Port	Protocol	Direction
vuSmartMaps IP	IP of MongoDB Server	27017*	TCP	Outbound

*Before providing the firewall requirements, please update the port based on the customer environment.

Configuring the Target

Configuring Metrics Collection from MongoDB Server

Metrics from MongoDB are gathered by establishing a connection to the server using a user with appropriate permissions. To get started with the standard MongoDB integration, create a read-only user with the necessary privileges to access performance metrics and other monitoring data.

Steps to Configure MongoDB Monitoring User: Connect to the MongoDB Instance: Use the mongo shell or a MongoDB client to connect to your MongoDB server with a user that has the appropriate administrative privileges.

mongo --host <HOST> --port <PORT> -u <ADMIN_USER> -p <ADMIN_PASSWORD> --authenticationDatabase admin

Create a Monitoring User: Execute the following commands to create a read-only monitoring user and assign the required roles (use admin) Create a new user with monitoring roles

db.createUser({
user: "vunet",
pwd: "<PASSWORD>",
roles: [
{ role: "read", db: "admin" }, // Read access to the admin database
{ role: "clusterMonitor", db: "admin" }, // Access to cluster statistics
{ role: "readAnyDatabase", db: "admin" }, // Read access to all databases
{ role: "dbAdmin", db: "admin" } // Access to database administration statistics
]
});

Verify Access for the 'vunet' User: Use the vunet user credentials to confirm connectivity and validate permissions.

mongo --host <HOST> --port <PORT> -u vunet -p <PASSWORD> --authenticationDatabase admin

Run sample queries to ensure the user can access necessary collections for metrics:

• Check replication status

db.runCommand({ replSetGetStatus: 1 });

• Retrieve server status

db.serverStatus();

• Check current operations

db.currentOp();

• Access collection statistics

db.stats();

Enable Access to Specific Collections (Optional): If additional collections or databases are required for monitoring, grant the vunet user specific privileges on those collections:

use <DATABASE_NAME>;
db.grantRolesToUser("vunet", [
{ role: "read", db: "<DATABASE_NAME>" },
{ role: "dbAdmin", db: "<DATABASE_NAME>" }
]);

Verify Metrics Collection: Ensure the monitoring tool can successfully fetch metrics using the vunet user's credentials.

By following these steps, you can configure a monitoring user in MongoDB for effective metrics collection, ensuring secure and granular access to the database.

Configuration Steps

• Enable the MongoDB O11ySource.
• Select the Sources tab and press the + button to add a new MongoDB instance to be monitored.
• Add the required details and then click on then click Finish to close the data source window.

Metrics Collected

Name	Description	Data Type
collection	Name of the collection	String
commands_count	Total commands executed	UInt64
commands_time	Time taken for commands	UInt64
db_name	Database name	String
get_more_count	Total get more requests	UInt64
get_more_time	Time taken for get more requests	UInt64
host	Host name	String
hostname	Host address	String
insert_count	Total insert operations	UInt64
insert_time	Time taken for insert operations	UInt64
name	Statistics name	String
node_type	Node type	String
queries_count	Total queries executed	UInt64
queries_time	Time taken for queries	UInt64
read_lock_count	Total read locks acquired	UInt64
read_lock_time	Time taken for read locks	UInt64
remove_count	Total remove operations	UInt64
remove_time	Time taken for remove operations	UInt64
rs_name	Replica set name	String
timestamp	Time when the stats were recorded	DateTime64
total_count	Total operations counted	UInt64
total_time	Total time for operations	UInt64
type	Type of stats	String
update_count	Total update operations	UInt64
update_time	Time taken for update operations	UInt64
write_lock_count	Total write locks acquired	UInt64
write_lock_time	Time taken for write locks	UInt64
tenant_id	Tenant ID	String
bu_id	Business unit ID	UInt64
target	Target server address	String
@timestamp	Timestamp when the stats were recorded	String
avg_obj_size	Average object size	UInt64
collection	Name of the collection	String
count	Total count	UInt64
db_name	Database name	String
host	Host name	String
hostname	Host address	String
name	Statistics name	String
node_type	Node type	String
ok	Status of the operation	UInt8
rs_name	Replica set name	String
size	Collection size	UInt64
storage_size	Storage size of the collection	UInt64
timestamp	Time when the stats were recorded	DateTime64
total_index_size	Total index size of the collection	UInt64
type	Type of stats	String
tenant_id	Tenant ID	UInt64
bu_id	Business unit ID	UInt64
target	Target server address	String
@timestamp	Timestamp when the stats were recorded	String
avg_obj_size	Average object size in the database	Float64
collections	Total collections in the database	UInt64
data_size	Total data size in the database	UInt64
db_name	Database name	String
fs_total_size	Total file system size available	UInt64
fs_used_size	File system size used	UInt64
host	Host name	String
hostname	Host address	String
index_size	Total index size in the database	UInt64
indexes	Number of indexes in the database	UInt64
name	Statistics name	String
node_type	Node type	String
num_extents	Number of extents	UInt64
objects	Total number of objects in the database	UInt64
ok	Status of the operation	UInt8
rs_name	Replica set name	String
storage_size	Storage size of the database	UInt64
timestamp	Time when the stats were recorded	DateTime64
type	Type of stats	String
tenant_id	Tenant ID	UInt64
bu_id	Business unit ID	UInt64
target	Target server address	String
@timestamp	Timestamp when the stats were recorded	String
available	Availability status	UInt8
collection	Name of the collection	String
created	Total created	UInt64
db_name	Database name	String
host	Host name	String
hostname	Host address	String
in_use	Currently in use	UInt8
name	Statistics name	String
node_type	Node type	String
refreshing	Refreshing status	UInt8
rs_name	Replica set name	String
timestamp	Time when the stats were recorded	DateTime64
type	Type of stats	String
tenant_id	Tenant ID	UInt64
bu_id	Business unit ID	UInt64
target	Target server address	String
@timestamp	Timestamp when the stats were recorded	String
active_reads	Number of active reads	UInt64
active_writes	Number of active writes	UInt64
aggregate_command_failed	Failed aggregate commands	UInt64
aggregate_command_total	Total aggregate commands	UInt64
assert_msg	Assert message count	UInt64
assert_regular	Assert regular count	UInt64
assert_rollovers	Assert rollovers	UInt64
assert_user	Assert user count	UInt64
assert_warning	Assert warning count	UInt64
available_reads	Available read tickets	UInt64
available_writes	Available write tickets	UInt64
commands	Total commands executed	UInt64
commands_per_sec	Commands executed per second	UInt32
connections_available	Number of available connections	UInt32
connections_current	Current number of connections	UInt32
open_connections	Total open connections	UInt32
connections_total_created	Total connections created	UInt64
count_command_failed	Failed count command	UInt64
count_command_total	Total count command	UInt64
cursor_no_timeout	Cursor no timeout flag	UInt64
cursor_no_timeout_count	Count of cursor no timeout	UInt64
cursor_pinned	Cursor pinned flag	UInt64
cursor_pinned_count	Count of pinned cursors	UInt64
cursor_timed_out	Cursor timed out flag	UInt64
cursor_timed_out_count	Count of cursor timeouts	UInt64
cursor_total	Total cursor count	UInt64
cursor_total_count	Total cursor count value	UInt64
delete_command_failed	Delete command failed	UInt64
delete_command_total	Total delete commands	UInt64
deletes	Total deletes	UInt64
deletes_per_sec	Deletes per second	UInt32
distinct_command_failed	Failed distinct command	UInt64
distinct_command_total	Total distinct commands	UInt64
document_deleted	Total documents deleted	UInt64
document_inserted	Total documents inserted	UInt64
document_returned	Total documents returned	UInt64
document_updated	Total document updates	UInt64
find_and_modify_command_failed	Find and modify command failed	UInt64
find_and_modify_command_total	Total find and modify commands	UInt64
find_command_failed	Find command failed	UInt64
find_command_total	Total find commands	UInt64
flushes	Total flushes	UInt64
flushes_per_sec	Flushes per second	UInt64
flushes_total_time_ns	Total time for flushes	UInt64
get_more_command_failed	Get more command failed	UInt64
get_more_command_total	Total get more commands	UInt64
getmores	Total get more operations	UInt64
getmores_per_sec	Get more operations per second	UInt64
host	Host machine	String
hostname	Hostname	String
insert_command_failed	Failed insert command	UInt64
insert_command_total	Total insert commands	UInt32
inserts	Total inserts	UInt64
inserts_per_sec	Inserts per second	UInt64
jumbo_chunks	Total jumbo chunks	UInt64
latency_commands	Command latency	UInt64
latency_commands_count	Command latency count	UInt64
latency_reads	Read latency	UInt64
latency_reads_count	Read latency count	UInt64
latency_writes	Write latency	UInt64
latency_writes_count	Write latency count	UInt64
member_status	Member status of node	String
name	Statistics name	String
timestamp	Time when the stats were recorded	DateTime64
type	Type of stats	String
tenant_id	Tenant ID	UInt64
bu_id	Business unit ID	UInt64
target	Target server address	String
@timestamp	Timestamp when the stats were recorded	String
uptime_ns	Uptime of the MongoDB server in nanoseconds	UInt64
rs_name	Replica set name	String
net_in_bytes	Total network input in bytes	UInt64
net_out_bytes	Total network output in bytes	UInt64
net_in_bytes_count	Count of network input bytes	UInt64
net_out_bytes_count	Count of network output bytes	UInt64
locks_Collection_DeadLockCount_Read	Number of times a collection shared lock request encountered a deadlock	UInt64
locks_Collection_DeadLockCount_ReadLower	Number of times a collection exclusive lock request encountered a deadlock	UInt64
locks_Collection_DeadLockCount_Write	Number of times a collection intent shared lock request encountered a deadlock	UInt64
locks_Collection_DeadLockCount_WriteLower	Number of times a collection intent exclusive lock request encountered a deadlock	UInt64
locks_Collection_AcquireWaitCount_Read	Number of times a collection shared lock was waited for	UInt64
locks_Collection_AcquireWaitCount_ReadLower	Number of times a collection exclusive lock was waited for	UInt64
locks_Collection_AcquireWaitCount_Write	Number of times a collection intent shared lock was waited for	UInt64
locks_Collection_AcquireWaitCount_WriteLower	Number of times a collection intent exclusive lock was waited for	UInt64
locks_Collection_AcquireCount_Read	Number of times a shared collection shared lock was acquired	UInt64
locks_Collection_AcquireCount_ReadLower	Number of times a collection exclusive lock was acquired	UInt64
locks_Collection_AcquireCount_Write	Number of times a collection intent shared lock was acquired	UInt64
locks_Collection_AcquireCount_WriteLower	Number of times a collection intent exclusive lock was acquired	UInt64
locks_Global_AcquireWaitCount_Read	Number of times a global shared lock was waited for	UInt64
locks_Global_AcquireWaitCount_ReadLower	Number of times a global shared lock was waited for	UInt64
locks_Global_AcquireWaitCount_Write	Number of times a global exclusive lock was waited for	UInt64
locks_Global_AcquireWaitCount_WriteLower	Number of times a global exclusive lock was waited for	UInt64
locks_Global_DeadLockCount_Read	Number of times a global shared lock request encountered a deadlock	UInt64
locks_Global_DeadLockCount_ReadLower	Number of times a global exclusive lock request encountered a deadlock	UInt64
locks_Global_DeadLockCount_Write	Number of times a global intent shared lock request encountered a deadlock	UInt64
locks_Global_DeadLockCount_WriteLower	Number of times a global intent exclusive lock request encountered a deadlock	UInt64
locks_Global_AcquireCount_Read	Number of times a global shared lock was acquired	UInt64
locks_Global_AcquireCount_ReadLower	Number of times a global shared lock was acquired	UInt64
locks_Global_AcquireCount_Write	Number of times a global exclusive lock was acquired	UInt64
locks_Global_AcquireCount_WriteLower	Number of times a global exclusive lock was acquired	UInt64
locks_Database_AcquireWaitCount_Read	Number of times a database shared lock was waited for	UInt64
locks_Database_AcquireWaitCount_ReadLower	Number of times a database exclusive lock was waited for	UInt64
locks_Database_AcquireWaitCount_Write	Number of times a database intent shared lock was waited for	UInt64
locks_Database_AcquireWaitCount_WriteLower	Number of times a database intent exclusive lock was waited for	UInt64
locks_Database_AcquireCount_Read	Number of times a database shared lock was acquired	UInt64
locks_Database_AcquireCount_ReadLower	Number of times a database exclusive lock was acquired	UInt64
locks_Database_AcquireCount_Write	Number of times a database intent shared lock was acquired	UInt64
locks_Database_AcquireCount_WriteLower	Number of times a database intent exclusive lock was acquired	UInt64
locks_Database_DeadLockCount_Read	Number of times a database shared lock request encountered a deadlock	UInt64
locks_Database_DeadLockCount_ReadLower	Number of times a database exclusive lock request encountered a deadlock	UInt64
locks_Database_DeadLockCount_Write	Number of times a database intent shared lock request encountered a deadlock	UInt64
locks_Database_DeadLockCount_WriteLower	Number of times a database intent exclusive lock request encountered a deadlock	UInt64
resident_megabytes	Amount of memory in megabytes that is currently in RAM	UInt64
vsize_megabytes	Amount of memory in megabytes that is currently in Virtual memory	UInt64
members_down_count	Count of down members in the replication set	UInt64
oplog_size_allocated	Allocated size of the oplog in bytes	UInt64
oplog_size_used	Used size of the oplog in bytes	UInt64
members_unhealthy_count	Count of unhealthy members in the replication set	UInt64
optimes_Applied_TS_T	Timestamp of the last oplog entry applied	UInt64
optimes_Durable_TS_T	Timestamp of the last oplog entry durable	UInt64
optimes_LastCommitted_TS_T	Timestamp of the last oplog entry committed	UInt64
members_headroom_max	Maximum headroom (remaining oplog time) in milliseconds	UInt64
members_headroom_min	Minimum headroom (remaining oplog time) in milliseconds	UInt64
members_lag_max	Maximum replication lag in milliseconds	Int64
members_lag_min	Minimum replication lag in milliseconds	Int64
members_primary_hosts	Hostname of the primary member in the replication set	String
members_secondry_hosts	Hostnames of the secondary members in the replication set	Array(String)
members_recovering_hosts	Hostnames of the recovering members in the replication set	Array(String)
members_unknown_hosts	Hostnames of the unknown members in the replication set	Array(String)
members_startup2_hosts	Hostnames of the startup2 members in the replication set	Array(String)
members_arbiter_hosts	Hostnames of the arbiter members in the replication set	Array(String)
members_down_hosts	Hostnames of the down members in the replication set	Array(String)
members_rollback_hosts	Hostnames of the rollback members in the replication set	Array(String)
members_unhealthy_hosts	Hostnames of the unhealthy members in the replication set	Array(String)
ttl_deletes	Number of documents deleted by the TTL monitor	UInt32
ttl_deletes_per_sec	Request rate per Second	Float32
ttl_passes	Number of times the TTL monitor completed a pass	UInt32
ttl_passes_per_sec	Request rate per Second	Float32
repl_oplog_window_sec	Size of the oplog window in seconds	UInt64
page_faults	Number of page faults	UInt64