Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Couchbase

Monitor Couchbase Distributed NoSQL Database Servers.

Data Collection Setup

Metrics are collected via the REST SSL API running on the Couchbase Database Cluster.

Network Requirements

Port: 18091 (TCP) HTTPS Internal REST SSL for Cluster Communication

For more information see Network Ports within the official Couchbase Documentation

Least Privileged User

Couchbase is not setup to use Authentication by default. To setup authentication, use the following steps:

  1. Login to GUI as administrator
  2. Go to Security -> External Users/Roles
  3. Click Enable Authentication
  4. Add user's with appropriate roles.
  5. Log out with the current user.
  6. Attempt to login with the newly-created user.

Supported Versions

Couchbase: 4.x, 5.x

Connection Parameters

NameRequired?Description
HostRequiredThe Couchbase cluster to connect to.
PortThe port for communication to the Couchbase cluster.
UsernameRequiredUsername for the Couchbase cluster.
PasswordRequiredPassword for the Couchbase cluster.
SSL ConfigurationThe SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).
Enable Cluster And NodesEnable the API call to return cluster and node resources.
Enable BucketsEnable the API call to return bucket resources.
Enable Bucket StatsEnable the API call to return additional bucket statistics.
Enable QueriesEnable the API call to return Prepared Statement and Query Metrics.
Query PortThe port for communication to Couchbase queries.
Max Query ResourcesMaximum number of query resources that will be returned in the collection.
Query Cutoff TimeTime interval in minutes from which Couchbase queries will be collected.
Priority Query MetricWhich query metric has priority when max_query_resources is enabled, limiting how many queries are returned from the collector
Max Completed LimitDisables queries if amount returned from API is more than this.
Request Timeout (seconds)The number of seconds to allow for connecting to the target.
Thread Pool SizeMaximum number of threads used to perform collection in addition to the two primary collection threads. Each Endpoint must have at least one additional thread.

Metrics

Bucket

NameDescription
Active Resident Items Ratio (%)Percentage of active items cached in RAM in this bucket.
Average Disk Commit Time (Seconds)The average disk commit time in seconds of the Bucket.
Average Disk Update Time (Microseconds)The average disk update time in microseconds of the Bucket.
Cache Miss Ratio (%)Percentage of reads per second to this Bucket from disk as opposed to RAM.
Current Connections (Connections)Number of connections to this server including connections from external client SDKs, proxies, TAP requests and internal statistic gathering.
Data Used (Bytes)Amount of data used by this bucket.
Decrement Hits (Operations per Second)The number of decrement hits per second of the Bucket.
Decrement Misses (Operations per Second)The number of decrement misses per second of the Bucket.
Delete Hits (Operations per Second)The number of delete hits per second for this Bucket.
Delete Misses (Operations per Second)The number of delete misses per second for this Bucket.
Disk Create Operations (Operations per Second)Number of new items created on disk per second for this Bucket.
Disk Fetches (Fetches per Second)The number of operations required to fetch items from disk on the Bucket.
Disk Update Operations (Operations per Second)Number of items updated on disk per second for this Bucket.
Disk Used (Bytes)The amount of disk space in use for the Bucket.
Disk Write QueueNumber of items waiting to be written to disk in the Bucket.
Ejections (per Second)Total number of items per second being ejected to disk in this bucket
Eviction PolicyThe Eviction policy of the bucket.
Evictions (per Second)The number of items per second evicted from the Bucket.
Get Hits (Operations per Second)Number of get operations per second for data that this bucket contains.
Get Misses (Operations per Second)Number of get operations per second for data that this bucket does not contain.
Headroom (Bytes)Amount of free RAM before hitting the high water mark.
Hit Ratio (%)Percentage of get requests served with data from this bucket.
Hits (Operations per Second)The number of hits per second of the Bucket.
Increment Hits (Operations per Second)The number of increment hits per second of the Bucket.
Increment Misses (Operations per Second)The number of increment misses per second of the Bucket.
Item CountThe number of objects stored in the Bucket.
Memory High Water Mark (Bytes)High water mark for auto-evictions on the Bucket.
Memory Low Water Mark (Bytes)Low water mark for auto-evictions on the Bucket.
Memory Used (Bytes)The amount of RAM used for the Bucket.
Metadata in Memory Utilization (%)The percentage of Metadata in RAM for this Bucket.
Metadata in RAM (Bytes)Amount of RAM used for metadata on this bucket.
Misses (Operations per Second)The number of misses per second of the Bucket.
NameThe name of the Bucket.
Node LocatorType of node locator.
Out of Memory Errors (per Second)Number of Hard Out of Memory Errors for this bucket.
Overhead (Bytes)The extra memory used by transient data (persistence queues, replication queues, checkpoints, etc.) on the Bucket.
Pending Resident Items Ratio (%)Percentage of pending items cached in RAM in this bucket.
Proxy PortProxy port on which the bucket communicates.
Quota Utilization (%)The percent of RAM Quota currently in use on the Bucket.
Read Operations (Operations per Second)The number of reads (get operations) per second from this Bucket.
Read Rate (Bytes per Second)The bytes read of the Bucket.
Replica IndexDefines if the bucket has replica indexes enabled.
Replica NumberNumber of replicas of this bucket.
Replica Resident Items Ratio (%)Percentage of replica items cached in RAM in this bucket.
Resident Items Ratio (%)Percentage of all items cached in RAM in this Bucket.
Temporary Out of Memory Errors (per Second)Number of back-offs sent per second to client SDKs due to "out of memory" situations from this Bucket.
Threads NumberThe number of concurrent readers and writers for the data bucket.
Total Operations (Operations per Second)The total operations per second of the Bucket.
TypeThe type of bucket.
UUIDThe UUID of the Bucket.
Write Operations (Operations per Second)The number of writes (set operations) per second to this Bucket.
Write Rate (Bytes per Second)The bytes written of the Bucket.

Cluster

NameDescription
Auto Failover CountThe number of auto failovers on the Cluster.
Auto Failover EnabledIndicates if failover is enabled on the Cluster.
Bucket CountThe number of buckets in the Cluster.
Collection NodeNode used to collect metrics
Database Fragmentation Threshold (%)The percentage level within the database at which compaction occurs.
Disk Data Utilization (%)The percentage of disk used by bucket data in the cluster
Disk Free (Bytes)The free disk space on this Cluster.
Disk Quota Total (Bytes)Total Disk Space Available to Couchbase.
Disk Total (Bytes)Total Disk Space.
Disk Used (Bytes)The used disk space on this Cluster.
Disk Used by Data (Bytes)Disk used by Bucket Data on this Cluster.
Disk Utilization (%)The percentage of disk used in the cluster
Implementation VersionVersion of couchbase running on this cluster.
Index Fragmentation Threshold (%)The percentage level within indexes at which compaction occurs.
Maximum Bucket CountMaximum number of buckets this cluster supports.
Memory Data Utilization (%)The percentage of RAM used by bucket data in the cluster
Memory Quota Total (Bytes)Total RAM Available to Couchbase.
Memory Quota Total per Node (Bytes)Total RAM Available to Couchbase, per node.
Memory Quota Used (Bytes)Total RAM Used by Couchbase.
Memory Quota Used per Node (Bytes)Total RAM Used by Couchbase, per node.
Memory Quota Utilization (%)The percentage of RAM Quota used by the cluster
Memory Total (Bytes)The total RAM on this Cluster.
Memory Used (Bytes)The total RAM used on this Cluster.
Memory Used by Data (Bytes)Total RAM Used by Bucket Data on this Cluster.
Memory Utilization (%)The percentage of RAM used by the cluster
NameThe name of the Cluster.
Node CountThe number of nodes in the Cluster.
UUIDThe UUID of the Cluster.
View Fragmentation Threshold (%)The percentage of fragmentation within all the view index files at which compaction is triggered.

Node

NameDescription
Cluster MembershipThe cluster membership of the Node.
Collection NodeThis node is currently being collected against.
CPU Utilization (%)The CPU utilization of the Node.
HostnameThe hostname of the Node.
Memory Free (Bytes)The free memory of the Node.
Memory Total (Bytes)The total memory allocated to the Node.
Memory Used (Bytes)The amount of Memory Used of the Node.
Memory Utilization (%)The percentage of Memory Used of the Node.
Operating SystemThe operating system of the Node.
PortThe port of the Node.
Recovery TypeThe recovery type of the Node.
ServicesThe services of the Node.
StatusThe status of the Node.
Swap Total (Bytes)The total swap space of the Node.
Swap Used (Bytes)The used swap space of the Node.
Uptime (Seconds)The uptime of the Node.
VersionVersion of couchbase running on this node.

Prepared Statement

NameDescription
CountThe number of queries evaluated for each calculated metric.
Elapsed Time Average (Milliseconds)The average time taken for the request, that is the time from when the request was received until the results were returned.
Elapsed Time Maximum (Milliseconds)The maximum time taken for the request, that is the time from when the request was received until the results were returned.
Elapsed Time Minimum (Milliseconds)The minimum time taken for the request, that is the time from when the request was received until the results were returned.
Error Count AverageThe average number of errors that occurred during the request.
Error Count MaximumThe maximum number of errors that occurred during the request.
Error Count MinimumThe minimum number of errors that occurred during the request.
NameThe prepared name of this statement.
Result Count AverageThe average number of objects in the results.
Result Count MaximumThe maximum number of objects in the results.
Result Count MinimumThe minimum number of objects in the results.
Result Size Average (Bytes)The average number of bytes in the results.
Result Size Maximum (Bytes)The maximum number of bytes in the results.
Result Size Minimum (Bytes)The minimum number of bytes in the results.
Service Time Average (Milliseconds)The average time taken for the execution of the request, that is the time from when query execution started until the results were returned.
Service Time Maximum (Milliseconds)The maximum time taken for the execution of the request, that is the time from when query execution started until the results were returned.
Service Time Minimum (Milliseconds)The minimum time taken for the execution of the request, that is the time from when query execution started until the results were returned.
TextThe text of the prepared statement.
UsesThe number of uses of this prepared statement.

Query

NameDescription
CountThe number of queries evaluated for each calculated metric.
Elapsed Time Average (Milliseconds)The average time taken for the request, that is the time from when the request was received until the results were returned.
Elapsed Time Maximum (Milliseconds)The maximum time taken for the request, that is the time from when the request was received until the results were returned.
Elapsed Time Minimum (Milliseconds)The minimum time taken for the request, that is the time from when the request was received until the results were returned.
Error Count AverageThe average number of errors that occurred during the request.
Error Count MaximumThe maximum number of errors that occurred during the request.
Error Count MinimumThe minimum number of errors that occurred during the request.
Result Count AverageThe average number of objects in the results.
Result Count MaximumThe maximum number of objects in the results.
Result Count MinimumThe minimum number of objects in the results.
Result Size Average (Bytes)The average number of bytes in the results.
Result Size Maximum (Bytes)The maximum number of bytes in the results.
Result Size Minimum (Bytes)The minimum number of bytes in the results.
Service Time Average (Milliseconds)The average time taken for the execution of the request, that is the time from when query execution started until the results were returned.
Service Time Maximum (Milliseconds)The maximum time taken for the execution of the request, that is the time from when query execution started until the results were returned.
Service Time Minimum (Milliseconds)The minimum time taken for the execution of the request, that is the time from when query execution started until the results were returned.
StatementThe text of the query.
Statement IDThe MD5 representation of the statement text.

Query Engine

NameDescription
Active RequestsCurrent number of active requests.
Average Request Time (Milliseconds)Average Request Time of this query engine.
Completed LimitNumber of Queries that couchbase will keep in it's query log.
Completed RequestsCurrent number of completed Requests.
Completed Threshold (Milliseconds)Minimum time query must take to be logged in couchbase's query log.
CoresNumber of cores available for this query engine.
Garbage Collection NumberNumber of the last Garbage Collection
Garbage Collection Paused (%)Percent of time that garbage collection is paused.
Garbage Collection Time Paused (Milliseconds)Number of milliseconds that Garbage Collection is paused.
Median Request Time (Milliseconds)Median Request Time of this query engine.
Node HostnameThe hostname of the Node this query engine runs on.
Node PortThe port of the Node this query engine runs on.
Prepared Statement Utilization (%)Percentage of requests that are prepared statements.
Request Time 80th Percentile (Milliseconds)80th Percentile of Request Time of this query engine.
Request Time 95th Percentile (Milliseconds)95th Percentile of Request Time of this query engine.
Request Time 99th Percentile (Milliseconds)99th Percentile of Request Time of this query engine.
Requests in Last 15 Min (Requests per Second)Requests per second average over the past 15 minutes.
Requests in Last 1 Min (Requests per Second)Requests per second average over the past minute.
Requests in Last 5 Min (Requests per Second)Requests per second average over the past 5 minutes.
System CPU Utilization (%)CPU Utilization of this Query Engine
System Memory (Bytes)The virtual address space reserved by this query engine.
Total Memory (Bytes)Cumulative amount of memory allocated for heap objects by this query engine.
Total Threads (Threads)Total threads used by this query engine.
Uptime (Milliseconds)Uptime of this Query Engine
Used Memory (Bytes)Amount of memory allocated for heap objects for this query engine.
User CPU Utilization (%)User CPU Utilization of this Query Engine
VersionVersion of this Query Engine.

Updated 8 months ago

Couchbase


Monitor Couchbase Distributed NoSQL Database Servers.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.