Supported Versions
2.6.10 or higher


MongoDB is a cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas. MongoDB is developed by MongoDB Inc. and licensed under the Server Side Public License.

MongoDB is classified as a NoSQL database, stores data using a flexible document data model that is similar to JSON documents with dynamic schemas (called as BSON). Documents contain one or more fields, including arrays, binary data and sub-documents.

MongoDB provides auto-sharding for horizontal scale out.

Native replication and automatic leader election supports high availability across racks and data centers.

MongoDB makes extensive use of RAM, providing in-memory speed and on-disk capacity.

Some of the main features include:

Document-oriented Instead of taking a business subject and breaking it up into multiple relational structures, MongoDB can store the business subject in the minimal number of documents. For example, instead of storing title and author information in two distinct relational structures, title, author, and other title-related information can all be stored in a single document called Book, which is much more intuitive and usually easier to work with.

Ad hoc queries MongoDB supports search by field, range queries, regular expression searches. Queries can return specific fields of documents and also include user-defined JavaScript functions.

Indexing Any field in a MongoDB document can be indexed (indices in MongoDB are conceptually similar to those in RDBMSes). Secondary indices are also available.

Replication MongoDB provides high availability with replica sets. A replica set consists of two or more copies of the data. Each replica set member may act in the role of primary or secondary replica at any time. The primary replica performs all writes and reads by default. Secondary replicas maintain a copy of the data on the primary using built-in replication. When a primary replica fails, the replica set automatically conducts an election process to determine which secondary should become the primary. Secondaries can also perform read operations, but the data is eventually consistent by default.

Load balancing MongoDB scales horizontally using sharding. The user chooses a shard key, which determines how the data in a collection will be distributed. The data is split into ranges (based on the shard key) and distributed across multiple shards. (A shard is a master with one or more slaves.) MongoDB can run over multiple servers, balancing the load and/or duplicating data to keep the system up and running in case of hardware failure. Automatic configuration is easy to deploy, and new machines can be added to a running database.

File storage MongoDB can be used as a file system, taking advantage of load balancing and data replication features over multiple machines for storing files. This function, called GridFS, is included with MongoDB drivers and available with no difficulty for development languages. MongoDB exposes functions for file manipulation and content to developers. Instead of storing a file in a single document, GridFS divides a file into parts, or chunks, and stores each of those chunks as a separate document. In a multi-machine MongoDB system, files can be distributed and copied multiple times between machines transparently, thus effectively creating a load-balanced and fault-tolerant system.

Aggregation MapReduce can be used for batch processing of data and aggregation operations. The aggregation framework enables users to obtain the kind of results for which the SQL GROUP BY clause is used.

Server-side JavaScript execution JavaScript can be used in queries, aggregation functions (such as MapReduce), and sent directly to the database to be executed.

Capped collections MongoDB supports fixed-size collections called capped collections. This type of collection maintains insertion order and, once the specified size has been reached, behaves like a circular queue.

Discovery with the agent

Collector Type: Agent

Category: Application Monitors

Application Name: MongoDB

Global Template Name: LINUX MongoDB Template

Prerequisites: python-pymongo package is needed to be installed in the server vistara agent runs on.


NameDefault Value
Host IP Address

The host on which MongoDB is running.
User Name

The username of the MongoDB Server.

The password of the MongoDB Server.

The port on which Mongo Server is running.
Replication Set Name

The latest vistara agent can detect the Replica set name dynamically, if available.

Note: All field attributes are mandatory, use default values wherever applicable.

Collected Metrics

Metric NameDisplay Name

Uptime in minutes.

Current active, read and write clients.

MongoDB resident, virtual, mapped memory in MB.

Lock percentage in %percentage.

MongoDB current and available connections.
mongodb.heap usage

Heap Usage in MB.

Page Faults per second.

Provides Index Counters details as Accesses, Hits, Misses, Resets, Miss_ratio.

Network Requests per second.

Current readers and writers in Queue.

Provides opcounts for operations like insert, update, query, delete, getmore, command(per second).

Check if the primary server of a replica set has changed.

Checks the replication lag in seconds.

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).

Provides the number of journal commits that occurred in the write lock.

Provides the size of individual databases in Gigabytes (GB's).
mongodb.index size

Provides the Index size of databases in KBs.

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.


  • 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.


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 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.

Supported metrics

MetricMetric Display NameUnitDescription Active ClientscountTotal number of active client connections to the database Active Clients ReadcountCount of the active client connections performing read operations 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 PercentpercentLock 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 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 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.sizeMongo SizegigabytesProvides the size of individual databases in Gigabytes
mongo.trafficMongo Traffic-Mongo Traffic
mongo.uptimeMongo UptimeminutesUptime in minutes