CouchBase Monitoring Extension

This extension works only with the standalone machine agent.

Use Case

Couchbase Server is an open source, distributed (shared-nothing architecture) NoSQL document-oriented database that is optimized for interactive applications. This extension allows the user to connect to a specific cluster host and retrieve metrics about the cluster, all the nodes within the cluster and any buckets associated with the nodes.

Installation

1. Download and unzip the CouchBaseMonitor zip file into the <machineagent install dir>/monitors/ directory.
2. Open <machineagent install dir>/monitors/CouchBaseMonitor/monitor.xml and configure the CouchBase parameters.

    

            <argument name="host" is-required="false" default-value="localhost"/>
            <argument name="port" is-required="false" default-value="8091"/>
            <argument name="username" is-required="false" default-value="username"/>
            <argument name="password" is-required="false" default-value="password"/>
            <argument name="disabled-metrics-path" is-required="false" default-value="monitors/CouchBaseMonitor/conf/DisabledMetrics.xml"/>      
           <argument name="metric-prefix" is-required="false" default-value="Custom Metrics|CouchBase|"
   

3. Open <machineagent install dir>/monitors/CouchBaseMonitor/conf/DisabledMetrics.xml and configure the list of disabled metrics. Here is a sample configuration of the disabled metrics:

    

        <Metric name="mem_free"/>
        <Metric name="mem_total"/>
   

4. Restart the machine agent.
5. In the AppDynamics Metric Browser, look for: Application Infrastructure Performance | <Tier> | Custom Metrics | CouchBase

 Password Encryption Support

To avoid setting the clear text password in the monitor.xml. Please follow the process to encrypt the password and set the encrypted password and the key in the monitor.xml
1. Download the util jar to encrypt the password from here 
2. Encrypt password from the commandline
java -cp "appd-exts-commons-1.1.2.jar" com.appdynamics.extensions.crypto.Encryptor myKey myPassword
3. Add the properties in the monitor.xml. Substitute the default-value
<argument name="password-encrypted" is-required="true" default-value="<ENCRYPTED_PASSWORD>"/>
<argument name="encryption-key" is-required="false" default-value="myKey"/>

Metrics

Metric Category: Cluster Metrics

Metric Category: Node Metrics

Metric Category: Bucket Metrics

Custom Dashboard

Contributing

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

Support

For any support questions, please contact help@appdynamics.com.