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 HTTP before 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.
    1. Select Infrastructure.
    2. Click the Settings icon.
    3. Select Resource > Add.
    4. In the Add Device window, enter the required details Device Type and any additional properties you want.
    5. 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.

Global 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 ParameterDescription
Connection Time OutThe 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 URLThe URL establishes the network connection to the MongoDB cluster. Use the URL format: http/https://{ipaddress}:{port}/serverstatus while connecting to the database.
Application TypeThe application type value to identify the adapter. For example, MONGODB.

Warning: Do not change the default application type value.

Global metrics

MetricMetric Display NameUnitDescription
mongo.active.clientsMongoDB Active ClientscountTotal number of active client connections to the database
mongo.active.clients.readMongo Active Clients ReadcountCount of the active client connections performing read operations
mongo.active.clients.writeMongo Active Clients WritecountCount of active client connections performing write operations
mongo.asserts.messageMongo Asserts MessagecountNumber of messages assertions per second
mongo.asserts.regularMongo Asserts RegularcountNumber of regular assertions raised per second
mongo.asserts.rolloversMongo Asserts RolloverscountNumber of rollovers assertions raised per second
mongo.asserts.totalMongo Asserts TotalcountTotal number of assertions per second
mongo.asserts.userMongo Asserts UsercountNumber of user assertions raised per second
mongo.asserts.warningMongo Asserts WarningcountNumber of warnings raised per second
mongo.avg.flushMongo Avg FlushmillisecondAverage time for each flush to disk
mongo.avg.flush.timeMongo Avg Flush TimemillisecondNumber of times the database has flushed all writes to disk
mongo.btree.accessMongo Btree AccesscountProvides Index Counters details as Accesses
mongo.btree.hitsMongo Btree HitscountProvides Index Counters details as Hits
mongo.btree.missesMongo Btree MissescountProvides Index Counters details as Misses
mongo.btree.misses.ratioMongo BTree Misses RatiocountProvides Index Counters details as Miss_ratio
mongo.btree.resetsMongo BTree ResetscountProvides Index Counters details as Resets
mongo.connections.availableMongo Connections Avaliable-Number of unused available incoming connections the database can provide
mongo.connections.currentMongo Connections CurrentcountNumber of connections to the database server from clients
mongo.current.queueMongo Current QueuecountCurrent Queue
mongo.currentqueue.readersMongo CurrentQueue ReaderscountCurrent readers in Queue
mongo.currentqueue.writersMongo CurrentQueue WriterscountCurrent writers in Queue
mongo.cursorsMongo CursorscountTotal number of cursors for clients
mongo.cursors.client.sizeMongo Cursors Client SizecountThe number of cursors that the server is maintaining for clients
mongo.cursors.openMongo Cursors OpencountNumber of cursors that MongoDB is maintaining for clients
mongo.cursors.timeoutMongo Cursors TimeoutcountNumber of cursors that time out, per second
mongo.heap.usageMongo Heap UsagebytesHeap Usage
mongo.index.miss.ratioMongo Index Miss Ratio-Provides Index Counters details as Miss_ratio
mongo.index.sizeMongo Index SizekilobytesProvides the Index size of databases in KBs
mongo.journal.commitsMongo Journal CommitscountProvides the number of journal commits that occurred in the write loc
mongo.journaled.status/td>Mongo Journaled StatusmegabytesProvides the journal status
mongo.journaled.status.writeMongo Journaled Status WritemegabytesThe average amount of data in megabytes written to the recovery log in the last four seconds is the JournaledMB and the data written to the databases datafiles in the last four seconds is writeToDataFilesMB
mongo.last.flush.timeMongo Last Flush TimemillisecondAmount of time that the last flush operation took to complete
mongo.lock.percentMongo Lock PercentpercentageLock percentage
mongo.memoryMongo MemorygigabytesAmount of memory for database
mongo.memory.mappedMongo Memory MappedgigabytesAmount of mapped memory by the database
mongo.memory.residentMongo Memory ResidentgigabytesAmount of memory currently used by the database process
mongo.memory.virtualMongo Memory VirtualgigabytesAmount of virtual memory used by the mongod process
mongo.network.requestsMongo Network RequestscountNumber of network requests per second
mongo.op.countersMongo OP CounterscountMongo OP Counters
mongo.opCounters.commandMongo opcounters commandcountTotal number of commands per second issued to the database
mongo.opCounters.deleteMongoDB Opcounters DeletecountNumber of delete operations per second
mongo.opCounters.getMongo Opcounters GetcountNumber of get operations per second
mongo.opCounters.insertMongo Opcounters InsertcountNumber of insert operations per second
mongo.opCounters.queryMongo Opcounters QuerycountTotal number of queries per second
mongo.opCounters.updateMongo Opcounters UpdatecountNumber of update operations per second
mongo.pagefaultsMongo Page FaultscountNumber of page faults per second that require disk operations
mongo.replicaprimaryMongo Replicaprimary-Check if the primary server of a replica set has changed
mongo.replication.stateMongo Replication State-Replication states will be 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.sizeMongo SizegigabytesProvides the size of individual databases in Gigabytes
mongo.trafficMongo Traffic-Mongo Traffic
mongo.uptimeMongo UptimeminutesUptime in minutes