# CouchBase Monitoring

## Overview

CouchBase Server is an open-source, distributed NoSQL document-oriented database and key-value store that is optimized for interactive applications. CouchBase is designed to provide easy-to-scale key-value or document access with low latency and high sustained throughput. Applications Manager helps to actively monitor all aspects of a CouchBase server like health, availability, response time etc., and helps take informed decisions in case of downtimes.

## Prerequisites

- For Applications Manager use [REST API](https://docs.couchbase.com/server/current/rest-api/rest-intro.html) to monitor the CouchBase server. Ensure that the firewall on your network and Applications Manager installed server allows outgoing communication on the CouchBase REST API port (8091 by default).
- The URL of the syntax given below should be accessible from the Applications Manager installed machine.

```
http://<host>:<port>/ui/index.html
```

## Creating a new CouchBase server monitor

**Supported Versions:** Couchbase server v6.0 and above

**Using the REST API to add a new CouchBase monitor:** [Click here](https://www.manageengine.com/products/applications_manager/help/database-servers.html#couchbase)

To create a CouchBase server monitor, follow the steps given below:

1. Click on **New Monitor** link.
2. Select **CouchBase** from *Database Servers*.
3. Specify the **Display Name** of the CouchBase monitor.
4. Enter the **HostName** or **IP Address** of the host where CouchBase process runs.
5. Enter the **REST API Port** (Default: 8091).
6. Specify the **Polling Interval** in minutes.
7. Choose the **Monitor Group** with which you want to associate the CouchBase server to, from the combo box (optional). You can choose multiple groups to associate your monitor.
8. Click **Add Monitor(s)**. This discovers the CouchBase server from the network and starts monitoring it.

### Monitored Parameters

Go to the **Monitors Category View** by clicking the **Monitors** tab. Click on **CouchBase** under the **Database** table. Displayed is the CouchBase bulk configuration view distributed into three tabs:

- **Availability** tab, gives the availability history for the past 24 hours or 30 days.
- **Performance** tab gives the health status and events for the past 24 hours or 30 days.
- **List view** enables you to perform [bulk admin configurations.](https://www.manageengine.com/products/applications_manager/help/bulk-config.html)

Click on the monitor name to see all the database details listed under the following tabs:

- [Monitor Information](https://www.manageengine.com/products/applications_manager/help/couchbase-servers.html#monitor)
- [Performance Overview](https://www.manageengine.com/products/applications_manager/help/couchbase-servers.html#performance)
- [Server Nodes](https://www.manageengine.com/products/applications_manager/help/couchbase-servers.html#server)
- [Data Buckets](https://www.manageengine.com/products/applications_manager/help/couchbase-servers.html#buckets)

### Monitor Information

This tab contains all general information regarding the monitor like Monitor name, port, hostname, username, associated groups etc.

### Performance Overview

| Parameters | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| Total Memory (MB) | Total memory available for the cluster. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Used Memory (MB) | RAM usage of the cluster. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Free Memory (MB) | Free memory available. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Cluster Disk Utilization (GB) | Total disk usage of the cluster. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Total Cluster Storage (GB) | Total disk space available for the cluster. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Other Data (GB) | Disk used by other data other than Couchbase. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Usable Free Space (GB) | Maximum free space available for Couchbase server. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |

### Server Nodes

| Parameters | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| Server Node Name | Server IP address where the Couchbase is running. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| RAM Usage | RAM usage of the server. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Swap Usage | Swap usage of the server | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| CPU Usage | CPU usage of the server. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Data Usage | Data usage of this node. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Usage | Disk usage of this node. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Node Memory Utilization | Memory Utilization of the alloted memory. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Active Items | Active data is the data written in this node. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Replica Items | Replica item is the copy of item from another node. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Node Disk Usage | Individual node disk consumed by Couchbase. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Background Data Fetches | Data not in cache and pulled from the disk. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |

### Data Buckets

| Parameters | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| **Data Buckets** |  |  |  |
| Bucket Name | Name of the bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Bucket Type | Bucket type can be either Memcached or CouchBase. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Nodes | Number of nodes available in the CouchBase server. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Item Count | Number of objects stored in the bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Used RAM Quota | Memory used from the given quota (in MB). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| RAM Quota | Memory allocated for this bucket (in MB). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Quota Memory Utilization | Amount of memory utilized from the available quota (in %). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Data Usage | Data used by this bucket (in MB). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Usage | Disk used by this bucket (in MB). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Docs Fragmentation | Indicates how much fragmented data is to be compacted compared to real data for the data files in this bucket (in %). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| OOM/sec | Number of back-offs sent per second to client SDKs due to "out of memory" situations from this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Current Connections | The number of connections per host. | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Total Connections | The total number of connections established for this bucket. | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Rejected Connections | The number of connection attempts rejected by the bucket. | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Resident item ratio | Ratio of items that are kept in memory versus stored on disk. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Total disk drain rate | Number of items actually written to disk from the disk queue. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Memory Headroom | This value indicates when you need to allocate more memory to a bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| **Bucket Operation Details** |  |  |  |
| Bucket Name | Name of the bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Ops/sec | Number of operations per second for this data bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Gets/sec | Number of reads (GET operations) per second from this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Total Gets/sec | Total number of GET operations per second from this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Sets/sec | Number of writes (SET operations) per second to this bucket | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Deletes/sec | Number of delete operations per second for this bucket | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| CAS Ops/sec | Number of operations with a CAS ID per second for this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Cache Miss Ratio | Ratio of the objects fetched from disk as opposed to memory (in %). Value should be as for be as close to 0 performance. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| **Bucket Disk Details** |  |  |  |
| Bucket Name | Name of the bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Creates/sec | Number of new items created on disk per second for this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Updates/sec | Number of items updated on disk per second for this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Reads/sec | Number of reads per second from disk for this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Not Supported](https://www.manageengine.com/products/applications_manager/help/images/cross.gif) |
| Disk Fetches/sec | Number of operations required to fetch the items from disk. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Write Queue | Number of items waiting to be written to disk in this bucket. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Write Failures | Number of disk write failures. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Read Failures | Number of disk read failures. | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |
| Disk Usage | Disk used by this bucket (in MB). | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) | ![Supported](https://www.manageengine.com/products/applications_manager/help/images/tick.gif) |