AppDynamics Monitoring Extension for use with MongoDB

Use Case

The MongoDB custom monitor captures statistics from the MongoDB server and displays them in the AppDynamics Metric Browser.

This extension works only with the standalone machine agent.

Pre-requisite

Before the extension is installed, the prerequisites mentioned here need to be met. Please do not proceed with the extension installation if the specified prerequisites are not met.

Installation

1. Download and unzip MongoMonitor.zip into <MACHINE_AGENT_HOME>/monitors/
2. Edit the file config.yml located at <MachineAgent_Dir>/monitors/ The metricPrefix of the extension has to be configured as specified here. Please make sure that the right metricPrefix is chosen based on your machine agent deployment, otherwise this could lead to metrics not being visible in the controller.
3. Restart the machineagent
4. In the AppDynamics Metric Browser, look for: Application Infrastructure Performance | <Tier> | Custom Metrics | Mongo Server.

Configuration

Note : Please make sure to not use tab (\t) while editing yaml files. You may want to validate the yaml file using a yaml validator

1. Configure the Mongo instances by editing the config.yml file in <MACHINE_AGENT_HOME>/monitors/MongoMonitor/.

   For eg.

       # MongoDB host and port. If ReplicaSet is enabled, configure all OR subset of members of the cluster.
       servers:
         - host: "localhost"
           port: 27017
         - host: "localhost"
           port: 27018
   
       # Specify this key if Password Encryption Support is required else keep it empty
       # If specified, adminDBPassword and databases passwords are now the encrypted passwords.
       passwordEncryptionKey: ""
   
       # Admin DB username and password. Required if mongod is started with --auth (Authentication) else keep empty
       # The user should have clusterMonitor role as a minimum
       adminDBUsername: "admin"
       adminDBPassword: "admin"
   
       # Change ssl to true if mongod is started with ssl. T
       ssl: false
   
       #prefix used to show up metrics in AppDynamics
       metricPathPrefix:  "Custom Metrics|Mongo Server|"
       #This will create it in specific Tier. Replace 
       #metricPathPrefix:  "Server|Component:|Custom Metrics|Mongo Server|"
   
   

2. Configure the path to the config.yml file by editing the in the monitor.xml file in the <MACHINE_AGENT_HOME>/monitors/MongoMonitor/ directory. Below is the sample

    <task-arguments>
        <!-- config file-->
        <argument name="config-file" is-required="true" default-value="monitors/MongoMonitor/config.yml" />
         ....
    </task-arguments>
   

Note : By default, a Machine agent or a AppServer agent can send a fixed number of metrics to the controller. To change this limit, please follow the instructions mentioned here. For eg.

    java -Dappdynamics.agent.maxMetrics=2500 -jar machineagent.jar

Metrics

Server Stats

Metric Category: Asserts

Metric Category: Background Flushing

Metric Category: Connections

Metric Category: Global Lock

Active Clients

Current Queue

Metric Category: Index Counter

Metric Category: Memory

Metric Category: Network

Metric Category: Operations

Replica Stats

For each replica the following metrics are reported.

DB Stats

Metric Category: Collection Stats

 

Credentials Encryption

Please visit this page to get detailed instructions on password encryption. The steps in this document will guide you through the whole process.

Extensions Workbench

Workbench is an inbuilt feature provided with each extension in order to assist you to fine tune the extension setup before you actually deploy it on the controller. Please review the following document on How to use the Extensions WorkBench

Troubleshooting

Please look at the troubleshooting document and make sure that everything is followed correctly.

Support Tickets

If after going through the Troubleshooting Document you have not been able to get your extension working, please file a ticket and add the following information.

Please provide the following in order for us to assist you better.

1. Stop the running machine agent.
2. Delete all existing logs under <MachineAgent>/logs.
3. Please enable debug logging by editing the file                                <MachineAgent>/conf/logging/log4j.xml. Change the level value of the            following <logger> elements to debug.
    <logger name="com.singularity">
    <logger name="com.appdynamics">
4. Start the machine agent and please let it run for 10 mins. Then zip and        upload all the logs in the directory 
    <MachineAgent>/logs/*.
5. Attach the zipped <MachineAgent>/conf/* directory here.
6. Attach the zipped <MachineAgent>/monitors/ExtensionFolderYouAreHavingIssuesWith directory here.

For any support related questions, you can also contact help@appdynamics.com.

Contributing

Always feel free to fork and contribute any changes directly via GitHub.

Version

 

List of Changes changes to this extension can be found here