Mongo DB plugin

This plugin collects metrics from a MongoDB server instance using a REST API call.

Prerequisites

Meter 4.2 or later must be installed.

The Mongo DB plugin supports the following Operating Systems.

Linux(tick)
Windows(tick)
Smart OS(tick)
OS X(tick)

Plugin Setup

The statistics are pulled from http://hostname:(port+1000)/_status. If you did not change the MongoDB default port, we will use 28107.

  1. Verify that you have access to the MongoDB statics by using curl by running the following command:

    $ curl http://localhost:28017/_status
  2. If you cannot view the page, you may need to enable the  Mongo REST interface .

  3. If after enabling the Mongo REST interface, you are still unable to collect information from the REST interface and if you are polling remotely, ensure that the port that is serving the Mongo REST interfaces is open. You can bypasss any firewall restrictions by running locally where the MongoDB is running.

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.

    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

Field NameDescription
HostnameThe hostname of MongoDB
PortPort to use when accessing MongoDB
Username(optional) Username to access MongoDB
Password(optional) Pasword to access MongoDB
Source(optional) The Source to display in the legend for the MongoDB data. It will default to the hostname of the server

Advanced configuration

To customize this plugin, see Mongo DB plugin on GitHub.

Plugin metrics

Metric NameDescription
Mongo hitsthe number of times an accessed index was return from memory
Mongo missesthe number of times an accessed index was not in memory
Mongo miss ratioRatio of hits to misses [ hits / (hits+misses) ]
Mongo connectionsThe number of open connections
Mongo avail connsThe number of available connections
Mongo conn limitThe ratio of used connections [used / (used+avail)]
Mongo global lock ratioPercentage of time spent in the global lock
Mongo resident memoryThe amount of RAM being used by Mongo
Mongo virtual memoryThe amount of virtual memory used by Mongo
Mongo mapped memoryMongo uses memory-mapped files, this will be about the size of the DB
Mongo insertsThe number of mongo insert operations
Mongo queriesThe number of mongo query operations
Mongo updatesThe number of mongo update operations
Mongo deletesThe number of mongo delete operations
Mongo getmoreThe number of mongo getmore operations
Mongo commandsThe number of mongo commands issued
Was this page helpful? Yes No Submitting... Thank you

Comments