Schedule demo
Home

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 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

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 APIPort (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.

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

Monitor Information:

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

Performance Overview

ParametersDescription
Total Memory (MB)Total memory available for the cluster.
Used Memory (MB)RAM usage of the cluster.
Free Memory (MB)Free memory available.
Cluster Disk Utilization (GB)Total disk usage of the cluster.
Total Cluster Storage (GB)Total disk space available for the cluster.
Other Data (GB)Disk used by other data other than Couchbase.
Usable Free Space (GB)Maximum free space available for Couchbase server.

Server Nodes

ParametersDescription
Server Node NameServer IP address where the Couchbase is running.
RAM UsageRAM usage of the server.
Swap UsageSwap usage of the server
CPU UsageCPU usage of the server.
Data UsageData usage of this node.
Disk UsageDisk usage of this node.
Node Memory UtilizationMemory Utilization of the alloted memory.
Active ItemsActive data is the data written in this node.
Replica ItemsReplica item is the copy of item from another node.
Node Disk UsageIndividual node disk consumed by Couchbase.
Background Data FetchesData not in cache and pulled from the disk.

Data Buckets

ParametersDescription
Data Buckets
Bucket NameName of the bucket.
Bucket TypeBucket type can be either Memcached or CouchBase.
NodesNumber of nodes available in the CouchBase server.
Item CountNumber of objects stored in the bucket.
Used RAM QuotaMemory used from the given quota (in MB).
RAM QuotaMemory allocated for this bucket (in MB).
Quota Memory UtilizationAmount of memory utilized from the available quota (in %).
Data UsageData used by this bucket (in MB).
Disk UsageDisk used by this bucket (in MB).
Docs FragmentationIndicates how much fragmented data is to be compacted compared to real data for the data files in this bucket (in %).
OOM/secNumber of back-offs sent per second to client SDKs due to "out of memory" situations from this bucket.
Current ConnectionsThe number of connections per host.
Resident item ratioRatio of items that are kept in memory versus stored on disk.
Total disk drain rateNumber of items actually written to disk from the disk queue.
Memory HeadroomThis value indicates when you need to  allocate more memory to a bucket.
Bucket Operation Details
Bucket NameName of the bucket.
Ops/secNumber of operations per second for this data bucket.
Gets/secNumber of reads (GET operations) per second from this bucket.
Total Gets/secTotal number of GET operations per second from this bucket.
Sets/secNumber of writes (SET operations) per second to this bucket
Deletes/secNumber of delete operations per second for this bucket
CAS Ops/secNumber of operations with a CAS ID per second for this bucket.
Cache Miss RatioRatio of the objects fetched from disk as opposed to memory (in %). Value should be as for be as close to 0 performance.
Bucket Disk Details
Bucket NameName of the bucket.
Disk Creates/secNumber of new items created on disk per second for this bucket.
Disk Updates/secNumber of items updated on disk per second for this bucket.
Disk Reads/secNumber of reads per second from disk for this bucket.
Disk Fetches/secNumber of operations required to fetch the items from disk.
Disk Write QueueNumber of items waiting to be written to disk in this bucket.
Disk Write FailuresNumber of disk write failures.
Disk Read FailuresNumber of disk read failures.
Disk UsageDisk used by this bucket (in MB).

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.

Loved by customers all over the world

"Standout Tool With Extensive Monitoring Capabilities"

★★★★★

It allows us to track crucial metrics such as response times, resource utilization, error rates, and transaction performance. The real-time monitoring alerts promptly notify us of any issues or anomalies, enabling us to take immediate action.

Reviewer Role: Research and Development

carlos-rivero
"I like Applications Manager because it helps us to detect issues present in our servers and SQL databases."
Carlos Rivero

Tech Support Manager, Lexmark

Trusted by over 6000+ businesses globally