| Supported Versions |
|---|
| 2.6.10 or higher |
This discribes the monitoring setup for the MongoDB database.
Prerequisites
- Install gateway version 5.0.0 or higher.
- Map a suitable gateway management profile to a resource.
- Create credentials with type
HTTPbefore assigning a template to a resource. The Port, Connection Time-out, and Is Secure values are not used to create credentials.
Discovery using the gateway
The administrator can deploy a gateway to support MongoDB agentless monitoring. The gateway establishes a connection to the database using the management profile, collects metrics from the templates, and starts monitoring.
To monitor MongoDB:
- Associate appropriate database credentials to the discovered database.
- Assign one or more database-specific global templates on the device.
Choose one of the following management mechanisms to discover MongoDB servers and add them to your inventory:
- WMI
- SSH
- SNMP
- (Optional) Manually add a database server to the infrastructure inventory.
- Select Infrastructure.
- Click the Settings icon.
- Select Resource > Add.
- In the Add Device window, enter the required details Device Type and any additional properties you want.
- Click Save.
View resource metrics
The gateway monitors the application using the assigned templates and displays the results in graphical format. To view resource metrics, click the desired Database Resource Name > Resource Details > Metrics.
Troubleshooting
If the graphs are plotted incorrectly, verify that the resource is accessible and telnet connectivity:
ping <IPAddress>
telnet <IPAddress:Port>Also, verify that you are using valid credentials for the resource.
Supported templates
- MongoDB Performance Template
- MongoDB_activeclients_Template
- MongoDB_asserts_Template
- MongoDB_btree_Template
- MongoDB_connections_Template
- MongoDB_currentqueue_Template
- MongoDB_cursors_TemplateMongoDB_flush_Template
- MongoDB_heap_Template
- MongoDB_memory_Template
- MongoDB_network_Template
- MongoDB_opcounter_Template
- MongoDB_pagefaults_Template
- MongoDB_replica_Template
After selecting the templates, you can:
- Assign MongoDB templates from Setup or at the device level.
- Customize default configuration parameter values while assigning the template.
Resource template configuration parameters
| Configuration Parameter | Description |
|---|---|
| Connection Time-out | The maximum time to connect to the database. The driver waits for the specified time before timing out due to connection failure. The default time is 15000 milliseconds(ms). |
| MongoDB Stats URL | The URL establishes the network connection to the MongoDB cluster. Use the URL format: http/https://{ipaddress}:{port}/serverstatus while connecting to the database. |
| Application Type | The application type value to identify the adapter. For example, MONGODB. Warning: Do not change the default application type value. |
Supported metrics
| Metric | Metric Display Name | Unit | Description |
|---|---|---|---|
| mongo.active.clients | MongoDB Active Clients | count | Total number of active client connections to the database |
| mongo.active.clients.read | Mongo Active Clients Read | count | Count of the active client connections performing read operations |
| mongo.active.clients.write | Mongo Active Clients Write | count | Count of active client connections performing write operations |
| mongo.asserts.message | Mongo Asserts Message | count | Number of messages assertions per second |
| mongo.asserts.regular | Mongo Asserts Regular | count | Number of regular assertions raised per second |
| mongo.asserts.rollovers | Mongo Asserts Rollovers | count | Number of rollovers assertions raised per second |
| mongo.asserts.total | Mongo Asserts Total | count | Total number of assertions per second |
| mongo.asserts.user | Mongo Asserts User | count | Number of user assertions raised per second |
| mongo.asserts.warning | Mongo Asserts Warning | count | Number of warnings raised per second |
| mongo.avg.flush | Mongo Avg Flush | millisecond | Average time for each flush to disk |
| mongo.avg.flush.time | Mongo Avg Flush Time | millisecond | Number of times the database has flushed all writes to disk |
| mongo.btree.access | Mongo Btree Access | count | Provides Index Counters details as Accesses |
| mongo.btree.hits | Mongo Btree Hits | count | Provides Index Counters details as Hits |
| mongo.btree.misses | Mongo Btree Misses | count | Provides Index Counters details as Misses |
| mongo.btree.misses.ratio | Mongo BTree Misses Ratio | count | Provides Index Counters details as Miss_ratio |
| mongo.btree.resets | Mongo BTree Resets | count | Provides Index Counters details as Resets |
| mongo.connections.available | Mongo Connections Avaliable | - | Number of unused available incoming connections the database can provide |
| mongo.connections.current | Mongo Connections Current | count | Number of connections to the database server from clients |
| mongo.current.queue | Mongo Current Queue | count | Current Queue |
| mongo.currentqueue.readers | Mongo CurrentQueue Readers | count | Current readers in Queue |
| mongo.currentqueue.writers | Mongo CurrentQueue Writers | count | Current writers in Queue |
| mongo.cursors | Mongo Cursors | count | Total number of cursors for clients |
| mongo.cursors.client.size | Mongo Cursors Client Size | count | The number of cursors that the server is maintaining for clients |
| mongo.cursors.open | Mongo Cursors Open | count | Number of cursors that MongoDB is maintaining for clients |
| mongo.cursors.timeout | Mongo Cursors Timeout | count | Number of cursors that time-out, per second |
| mongo.heap.usage | Mongo Heap Usage | bytes | Heap Usage |
| mongo.index.miss.ratio | Mongo Index Miss Ratio | - | Provides Index Counters details as Miss_ratio |
| mongo.index.size | Mongo Index Size | kilobytes | Provides the Index size of databases in KBs |
| mongo.journal.commits | Mongo Journal Commits | count | Provides the number of journal commits that occurred in the write loc |
| mongo.journaled.status/td> | Mongo Journaled Status | megabytes | Provides the journal status |
| mongo.last.flush.time | Mongo Last Flush Time | millisecond | Amount of time that the last flush operation took to complete |
| mongo.lock.percent | Mongo Lock Percent | percent | Lock percentage |
| mongo.memory | Mongo Memory | gigabytes | Amount of memory for database |
| mongo.memory.mapped | Mongo Memory Mapped | gigabytes | Amount of mapped memory by the database |
| mongo.memory.resident | Mongo Memory Resident | gigabytes | Amount of memory currently used by the database process |
| mongo.memory.virtual | Mongo Memory Virtual | gigabytes | Amount of virtual memory used by the mongod process |
| mongo.network.requests | Mongo Network Requests | count | Number of network requests per second |
| mongo.op.counters | Mongo OP Counters | count | Mongo OP Counters |
| mongo.opCounters.command | Mongo opcounters command | count | Total number of commands per second issued to the database |
| mongo.opCounters.delete | MongoDB Opcounters Delete | count | Number of delete operations per second |
| mongo.opCounters.get | Mongo Opcounters Get | count | Number of get operations per second |
| mongo.opCounters.insert | Mongo Opcounters Insert | count | Number of insert operations per second |
| mongo.opCounters.query | Mongo Opcounters Query | count | Total number of queries per second |
| mongo.opCounters.update | Mongo Opcounters Update | count | Number of update operations per second |
| mongo.pagefaults | Mongo Page Faults | count | Number of page faults per second that require disk operations |
| mongo.replicaprimary | Mongo Replicaprimary | - | Check if the primary server of a replica set has changed |
| mongo.replication.state | Mongo Replication State | - | Replication states is the following cases: StartingPhase1(0), Primary(1), Secondary(2), Recoverying(3), Fatal Error(4), StartingPhase2(5), Arbiter(7), Down(8), Not_Running_with_Replication(-1) |
| mongo.size | Mongo Size | gigabytes | Provides the size of individual databases in Gigabytes |
| mongo.traffic | Mongo Traffic | - | Mongo Traffic |
| mongo.uptime | Mongo Uptime | minutes | Uptime in minutes |