Monitoring Best Practices

Monitoring tools/applications that provide support for MongoDB should conform to the following Best Practices for certification against MongoDB Enterprise.

the best practices checklist and submit it with your application to expedite the certification process.

Please note that all certification categories require compliance with security best practices.

Connections

• Application should connect to MongoDB deployments using the standard connection string URI format. Application should support the ability to connect to (i) an individual mongod process, (ii) a MongoDB replica set (using auto-discovery), or (iii) a mongos as a frontend to a sharded cluster. For more information, refer to http://docs.mongodb.org/manual/reference/connection-string/.
• Application should auto-discover the MongoDB deployment topology, either replica set or sharded cluster by interrogating the appropriate interfaces. For more information, refer to http://docs.mongodb.org/manual/reference/command/replSetGetStatus/#dbcmd.replSetGetStatus and http://docs.mongodb.org/manual/reference/method/sh.status/.

Data

• Application should gather metrics data from either MongoDB server/database/collection status. mongostat, SNMP, or MMS/Ops Manager RESTful API. For more information, refer to:

  • http://docs.mongodb.org/manual/reference/command/serverStatus/
  • http://docs.mongodb.org/manual/reference/command/replSetGetStatus/
  • http://docs.mongodb.org/manual/reference/command/dbStats/
  • http://docs.mongodb.org/manual/reference/command/collStats/
  • http://docs.mongodb.org/manual/reference/program/mongostat/
  • http://docs.mongodb.org/manual/tutorial/monitor-with-snmp/

• Application should - at a minimum - expose the following key metrics for any and all MongoDB deployments (note: this list is not exhaustive):

  • Operation counts (inserts, updates, deletes, queries, commands)
  • Disk flushes
  • Memory usage (resident, mapped)
  • Page faults
  • Index miss percentage
  • Queued/active operations (reads and writes)
  • Network traffic (received, sent)
  • Connections
  • Role (Primary, Secondary, Router)

• Application should provide the ability for the end user to create alerts based on metric value changes (absolute or relative) and send notifications via appropriate communication channels (e.g. SMS, email, etc.)