Overview

LogicMonitor offers out-of-the-box monitoring for Couchbase Server (formerly known as Membase), a document-oriented NoSQL database software package that is optimized for applications that serve concurrent users. Our LogicModule package for Couchbase Server accesses the Couchbase Server REST API to monitor auto-failover events, bucket performance, node status, pool performance, and more.

Compatibility

As of July 2020, LogicMonitor's Couchbase Server package is compatible with Couchbase Server REST API 6.5. As Couchbase Server releases newer versions of its REST API, LogicMonitor will test and extend coverage as necessary.

Setup Requirements

Satisfy Dependencies

  • REST API access must be enabled on each Couchbase Server. See Couchbase REST API reference.
  • Port 8091 must be accessible to the LogicMonitor Collector. If the Couchbase API is not set to use the default port (8091), an optional couchbase.port property can be set on the resource (as discussed in Assign Properties to Resources section) to override the default and this port must then be accessible to the Collector.

Add Resource Into Monitoring

Add your Couchbase Server host into monitoring. For more information on adding resources into monitoring, see Adding Devices.

Obtain Credentials

LogicMonitor must provide the appropriate credentials in order to successfully access Couchbase Server data. These credentials must belong to an API user; it is recommended that the user account have read-only permissions only.

A read-only user is created with the /settings/readOnlyUser URI endpoint. Only one read-only user can be created. See Couchbase Server's User API and Creating a read-only user documentation for API user creation instructions.

Assign Properties to Resources

The following custom properties should be set on the Couchbase Server resource within LogicMonitor. For more information on setting properties, see Resource and Instance Properties.

Property Value Required?
couchbase.user Couchbase REST API username. Required
couchbase.pass Couchbase REST API password. Required
couchbase.port API port. By default, LogicMonitor uses port 8091 but this can be overridden by setting this property. Optional

Import LogicModules

From the LogicMonitor public repository, import all Couchbase Server LogicModules, which are listed in the LogicModules in Package section of this support article. If these LogicModules are already present, ensure you have the most recent versions.

Once the LogicModules are imported (assuming all previous setup requirements have been met), data collection will automatically commence.​

LogicModules in Package

​ LogicMonitor's package for Couchbase Server consists of the following LogicModules. For full coverage, please ensure that all of these LogicModules are imported into your LogicMonitor platform.

Display Name Type Description
addCategory_CouchbaseConsole PropertySource Checks to see if a Couchbase Console is present at port 8091 (or custom port if optional couchbase.port property is configured). If found, adds "CouchbaseConsole" to the console's system.categories property.
Couchbase Server Auto Failover DataSource Detects Couchbase auto-failover events, if enabled. See the Auto Failover Monitoring section for important details on auto-failover monitoring.
Couchbase Server Buckets DataSource Monitors Couchbase Bucket performance metrics such as IOPS, throughput, CPU, memory, quota, queue depth, bucketed items, and more.
Couchbase Server Nodes DataSource Various Couchbase node status information, such as cluster state, memory usage, uptime status, and more.
Couchbase Server Pools DataSource Monitors Couchbase Pools for memory details, memory and storage utilization, and pool storage

When setting static datapoint thresholds on the various metrics tracked by this package's DataSources, LogicMonitor follows the technology owner's best practice KPI recommendations. If necessary, we encourage you to adjust these predefined thresholds to meet the unique needs of your environment. For more information on tuning datapoint thresholds, see Tuning Static Thresholds for Datapoints.

Auto Failover Monitoring

The Couchbase Server Auto Failover DataSource reports a failover count based off of the Couchbase Server automatic failover policy. See Automatic Failover.

Automatic failover node minimums are service specific and are outlined in the following table.

Service Minimum Nodes Required
Data 3
Query 2
Index Not Supported
Search 2
Analytics 2
Eventing 2

In this Article: