MongoDB monitoring is a Gateway configuration file that enables monitoring of MongoDB through the Toolkit plug-in.
MongoDB can monitor the database environment in a measurable way to spot any potential discrepancies and issues.
Some key areas to track when using MongoDB monitoring:
|Metrics||Determine the crucial alerts to be set in the metrics to avoid any performance issues or errors.|
|Database performance||Monitor the database's current state.|
|Resource utilisation||Monitor the number of client connections to avoid abnormal traffic loads that can lead to performance issues.|
|Asserts||Show errors raised during the selected time period.|
MongoDB helps you to get an overview of database operations, such as:
- Track the current state of database.
- View reports of asserts on the database.
- Monitor the metrics for write performance.
- View contains storage statistics for a given database.
- Check reports information regarding the state and use of indexes in MongoDB.
This guide discusses the steps to set up the MongoDB integration on a Gateway. Once the integration is set up, the samplers providing the dataviews become available to that Gateway.
To view the sample metrics and dataviews, see MongoDB Monitoring Technical Reference.
This monitoring template is a Gateway configuration setup that can be included in the Gateway Setup Editor.
To use this template, your configuration must meet the following requirements:
- A machine running the Netprobe must have access to the MongoDB published HTTP address and port.
- An Active Console that is connected to the Gateway.
- MongoDB configuration files extracted to their Gateway set-up.
The following requirements must be met prior to the installation and setup of the template:
- Template package: geneos-integration-mongoDB-<version>.zip.
- Managed entities utilising the samplers defined in the
- RHEL 6.
For more information on supported versions, see Application and plug-in specific information in Geneos 5.x Compatibility Matrix.
This document is a reference guide to introduce templates and scripts built using the Geneos development toolkit plug-ins.The template allows you to integrate specific applications and services to collect metrics without having to create a new plug-in..
Ensure that you have read and can follow the system requirements prior to installation and setup of this integration template.
- Download the config file (geneos-integration-mongoDB-<version>.zip) from the ITRS Downloads site.
- Open Gateway Setup Editor.
- In the Navigation panel, click Includes to create a new file.
- Enter the location of the file to include in the Location field. In this example, it is the
- Update the Priority field. This can be any value except
1. If you input a priority of
1, the Gateway Setup Editor returns an error.
- Expand the file location in the Include section.
- Select Click to load.
- Click Yes to load the new MongoDB include file.
- Click Managed entities in the Navigation panel.
- Add the MongoDB type to the Managed Entity section that you will use to monitor MongoDB.
- Click the Validate button to check your configuration and save if everything is correct.
These are the pre-configured samplers available to use in
Configure the required fields by referring to the table below:
MongoDBMonitoring.xml template provides the following variables that are set in the Environments section:
|MONGODB_SAMPLE_INTERVAL||Sample interval used by all the Mongo samplers.|
|MONGODB_CLIENT||Full path of the Mongo client. The toolkit script uses this to communicate with the MongoDB instance.|
|MONGODB_GROUP||Group name used by all the Mongo Samplers.|
Follow the format <host>:<port>
|MONGODB_SCRIPT_DIR||Directory where the sampler scripts will be generated.|
|MONGODB_DB||Specifies the name of the database to connect to.|
Note: The default values can be changed by providing an environment named Mongo with a higher priority in the set-up file, or by using an environment in the Managed entity where the type is defined.
MongoDBMonitoring-SampleRules.xml template also provides a separate sample rules that can be used to configure the Gateway Setup Editor.
Your configuration rules must be set in the Includes section. In the Navigation panel, click Rules
The table below shows the included rules in the integration file.