New Relic Infrastructure On-Host Integration for Couchbase

Reports status and metrics for couchbase-plugin service

Disclaimer

New Relic has open-sourced this integration to enable monitoring of this technology. This integration is provided AS-IS WITHOUT WARRANTY OR SUPPORT, although you can report issues and contribute to this integration via GitHub. Support for this integration is available with an Expert Services subscription.

Requirements

Couchbase REST Endpoint enabled

Configuration

Edit the couchbase-plugin-config.yml configuration file to provide a unique instance name, host and port of couchbase REST API and the bucket and nodes to monitor. Enter "all" as the value of bucket or node to specify all available buckets and nodes in the cluster.

Installation

Install the couchbase plugin

cp -R bin /var/db/newrelic-infra/custom-integrations/

cp couchbase-plugin-definition.yml /var/db/newrelic-infra/custom-integrations/

cp couchbase-plugin-config.yml.sample  /etc/newrelic-infra/integrations.d/

Configuration

In order to use the Couchbase Integration it is required to configure couchbase-plugin-config.yml.sample file. Firstly, rename the file to couchbase-plugin-config.yml. Then, depending on your needs, specify all instances that you want to monitor. Once this is done, restart the Infrastructure agent.

Restart the infrastructure agent

sudo systemctl stop newrelic-infra

sudo systemctl start newrelic-infra

Troubleshooting

Test the plugin by executing it from the command line

Usage of ./bin/nr-couchbase-plugin:
  -host string
    	Hostname or IP of the Couchbase server (default "127.0.0.1")
  -port int
    	Port of the Couchbase server (default 8091)
  -ssl
    	Use SSL connection to Couchbase server
  -username string
    	Username for authenticating to Couchbase server
  -password string
    	Password for authenticating to the Couchbase server
  -bucket string
    	(OPTIONAL) If specified, only the specified bucket stats will be fetched (default "all")
  -node string
    	(OPTIONAL) If specified, only the specified node will be queried (default "all")
  -pretty
    	Print pretty formatted JSON.
  -verbose
    	Print more information to logs.

where {host} and {port} refer to the Couchbase Server host and port.

Compatibility

• Supported OS: Linux