Skip to technology filters Skip to main content
Dynatrace Hub

Extend the platform,
empower your team.

Popular searches:
Home hero bg
CouchbaseCouchbase
Couchbase

Couchbase

Couchbase Capella (SaaS) database monitoring

Extension
Free trial
Overview dashboardNode detailCluster detailCluster list view
  • Product information
  • Release notes

Overview

The Couchbase extension is designed to monitor Couchbase databases. It provides monitoring metrics at the cluster and node level.

This initial release focuses on support for Capella, Couchbase's cloud database platform. Future versions will add support for Couchbase Server self-hosted solution.

Monitoring Cappella is handled by deploying the extension on an ActiveGate.

Get started

Set up monitoring

Virtual machine

If your Couchbase is running on a virtual machine directly, you will need to install OneAgent on that virtual machine to get started.

Kubernetes workload

If your Couchbase is running as a workload in Kubernetes, please refer to the Kubernetes deployment start guide.

Openshift workload

If your Couchbase is running as a workload in OpenShift, please refer to the OpenShift deployment start guide.

OpenTelemetry

If you are instrumenting Couchbase with OpenTelemetry then:

  1. Ensure that the OneAgent feature "OpenTelemetry Java Instrumentation agent support" is activated to get full tracing and metric insight (OneAgent version 1.237 or newer needed).
  2. Instrument the java client with OpenTelemetry.
  3. Ensure to store the span attributes.

Extension

Activate the Couchbase extension to get further metrics.

The Couchbase extension is designed to monitor Couchbase databases. It provides monitoring metrics at the cluster and node level.

The extension supports Capella, Couchbase's cloud database platform and Couchbase Server version 7+.

Details

Configuration

To configure the Couchbase Capella extension, add this extension and create a new Monitoring Configuration.

Successful configuration of the extension requires several corresponding settings in the Capella/Couchbase Server Admin UI. Below are guidelines for the required configurations.

Connection Hostname

Capella: This is the Capella Connection String.  In the Capella UI, go to the Connect tab on a Database and copy the full connection string. Server: IP of a Couchbase Node. The Couchbase Node must be accessible from the ActiveGate the extension is running on.

User Credentials

Capella: The extension requires a set of Capella credentials (username / password) that has Read Access to All Buckets and All Scopes in your Database (as noted, the required external_stats_reader role is only granted when a Database Credential is given Read Access to all Buckets in a Database).  Credentials can be created in the Capella UI by going to Settings -> Database Access -> Create Database Access (see Couchbase's Configure Database Credentials) Server: Create a user with Read-Only Admin permissions.

Security Certificate

The Security Certificate for your Database.  In the Capella UI, select the Database, go to Settings -> Security Certificate, and click on Copy.  This will give you a PEM-formatted text.

Allowed IP Addresses

Before any client can connect to a Capella Database, the client's IP address must be added to the Database's Allowed IP list. 

Note: For Allowed IP address, you must find the external IP address of the ActiveGate(s) you are running the extension on and add those IPs to the allowed IP address setting.

Compatibility information

  • Linux OS or Windows
  • Couchbase version 4.3+

The extension requires:

  • ActiveGate version 1.270+
  • Dynatrace version 1.270+
  • Couchbase version 7+
Dynatrace
By Dynatrace
Dynatrace support center
Subscribe to new releases
Copy to clipboard

Extension content

Content typeNumber of items included
screen message cards
10
screen properties
2
screen layout
2
generic relationship
1
dashboards
1
metric metadata
63
screen actions
2
list screen layout
2
generic type
2
screen chart groups
10
screen entities lists
3

Feature sets

Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.

Feature setsNumber of metrics included
Metric nameMetric keyDescriptionUnit
XDCR replicated docscouchbase.xdcr_docs_processed_totalNumber of documents processed for a ReplicationCount
XDCR docs receivedcouchbase.xdcr_docs_received_from_dcp_totalNumber of Document Mutations received from the Data ServiceCount
XDCR docs writtencouchbase.xdcr_docs_written_totalNumber of docs Document Mutations written/sent to the TargetCount
XDCR write operationscouchbase.xdcr_set_docs_written_totalNumber of Set operations successfully written to the TargetCount
Metric nameMetric keyDescriptionUnit
Current MCBP/DCP Connectionscouchbase.kv_curr_connectionsCurrent number of MCBP/DCP connectionsCount
Waiting for commit (bucket)couchbase.kv_disk_seconds_bucketWaiting for a commit after a batch of updatesSecond
Waiting for commit (count)couchbase.kv_disk_seconds_count.gaugeWaiting for a commit after a batch of updatesSecond
Waiting for commit (sum)couchbase.kv_disk_seconds_sumWaiting for a commit after a batch of updatesSecond
Disk used by Bucketcouchbase.kv_ep_db_data_size_bytesTotal size of valid data in db filesByte
Disk drain ratecouchbase.kv_ep_diskqueue_drainTotal drained items on disk queueCount
Enqueued items on disk queuecouchbase.kv_ep_diskqueue_fillTotal enqueued items on disk queueCount
Total memory used in disk queuecouchbase.kv_ep_diskqueue_memory_bytesTotal memory used in disk queueByte
Disk used percent by nodecouchbase.kv_ep_magma_total_disk_usage_bytesDisk used percent by nodeByte
Items queued for storagecouchbase.kv_ep_queue_sizeNumber of items queued for storageCount
Temporary out of memory errors by bucketcouchbase.kv_ep_tmp_oom_errorsNumber of times temporary OOMs happened while processing operationsCount
Total engine memory usagecouchbase.kv_mem_used_bytesEngine's total memory usageByte
Get ops per secondcouchbase.kv_vb_ops_getGet Ops Per SecondPerSecond
Set ops per secondcouchbase.kv_vb_ops_setSet Ops Pet SecondPerSecond
Active item resident ratiocouchbase.kv_vb_perc_mem_resident_ratioActive item resident ratioPercent
VB queue draincouchbase.kv_vb_queue_drainVB queue drainUnspecified
VB queue fillcouchbase.kv_vb_queue_fillVB queue fillUnspecified
VB queue pendingcouchbase.kv_vb_queue_pending_bytesVB queue pendingUnspecified
VB queue sizecouchbase.kv_vb_queue_sizeVB queue sizeUnspecified
Metric nameMetric keyDescriptionUnit
Documents indexed per secondcouchbase.index_avg_drain_rateAverage number of documents indexed per second, for this indexPerSecond
Average size of index itemscouchbase.index_avg_item_sizeAverage size of the indexed itemsByte
Uncompressed index data sizecouchbase.index_data_sizeThe approximate size of the valid uncompressed index dataByte
Index total disk spacecouchbase.index_disk_sizeTotal disk space taken up by this index after compression. This includes index data files, checkpoints etc.Byte
Records in memory ratiocouchbase.index_resident_percentRatio of records in memory to total records, for this indexPercent
Metric nameMetric keyDescriptionUnit
CPU Utilization (Deprecated in CB v7.6.0)couchbase.sysproc_cpu_utilizationCPU utilization rateUnspecified
Resident memory usedcouchbase.sysproc_mem_residentAmount of resident memory usedByte
Memory usedcouchbase.sysproc_mem_sizeAmount of memory usedByte
CPU Utilizationcouchbase.sys_cpu_utilization_rateCPU utilization rate in the control groupPercent
Metric nameMetric keyDescriptionUnit
Total active requestscouchbase.n1ql_active_requestsTotal number of active requests.Count
Total N1QL requests with at_plus index consistencycouchbase.n1ql_at_plus.countTotal number of N1QL requests with at_plus index consistency.Count
Total audit records sentcouchbase.n1ql_audit_actions.countThe total number of audit records sent to the server. Some requests cause more than one audit record to be emitted. Records in the output queue that have not yet been sent to the server are not counted.Count
Total failed audit records sentcouchbase.n1ql_audit_actions_failed.countThe total number of audit records sent to the server that failed.Count
Potentially auditable requests with no audit actioncouchbase.n1ql_audit_requests_filtered.countThe number of potentially auditable requests that cause no audit action to be taken.Count
Potentially auditable requests sent to query enginecouchbase.n1ql_audit_requests_total.countThe total number of potentially auditable requests sent to the query engine.Count
Cancelled requestscouchbase.n1ql_cancelled.countTotal number of cancelled requests.Count
Delete operationscouchbase.n1ql_deletes.countTotal number of DELETE operations.Count
N1QL error countcouchbase.n1ql_errors.countThe total number of N1QL errors returned so far.Count
Secondary index scanscouchbase.n1ql_index_scans.countTotal number of secondary index scans.Count
Insert operationscouchbase.n1ql_inserts.countTotal number of INSERT operations.Count
Invalid requestscouchbase.n1ql_invalid_requests.countTotal number of requests for unsupported endpoints.Count
Document mutationscouchbase.n1ql_mutations.countTotal number of document mutations.Count
Prepared statements executedcouchbase.n1ql_prepared.countTotal number of prepared statements executed.Count
Primary index scanscouchbase.n1ql_primary_scans.countTotal number of primary index scans.Count
Query process timecouchbase.n1ql_request_time.countTotal end-to-end time to process all queries.NanoSecond
N1QL requestscouchbase.n1ql_requests.countTotal number of N1QL requests.Count
Queries longer than 1000mscouchbase.n1ql_requests_1000ms.countNumber of queries that take longer than 1000ms.Count
Queries longer than 250mscouchbase.n1ql_requests_250ms.countNumber of queries that take longer than 250ms.Count
Queries longer than 5000mscouchbase.n1ql_requests_5000ms.countNumber of queries that take longer than 5000ms.Count
Queries longer than 500mscouchbase.n1ql_requests_500ms.countNumber of queries that take longer than 500ms.Count
Results (document) returned countcouchbase.n1ql_result_countTotal number of results (documents) returned by the query engine.Count
Result sizecouchbase.n1ql_result_size.countTotal size of data returned by the query engine.Count
N1QL requests with request_plus consistencycouchbase.n1ql_scan_plus.countTotal number of N1QL requests with request_plus index consistency.Count
Select requestscouchbase.n1ql_selects.countTotal number of SELECT requests.Count
Time to execute queriescouchbase.n1ql_service_time.countTime to execute all queries.NanoSecond
Elapsed transaction timecouchbase.n1ql_transaction_time.countTotal elapsed time of transactions so far.NanoSecond
Transaction countcouchbase.n1ql_transactions.countTotal number of transactions.Count
N1QL requests with not_bounded consistencycouchbase.n1ql_unbounded.countTotal number of N1QL requests with not_bounded index consistency.Count
Update requestscouchbase.n1ql_updates.countTotal number of UPDATE requests.Count
N1QL warningscouchbase.n1ql_warnings.countThe total number of N1QL warnings returned so far.Count

Related to Couchbase

ActiveGate logo

ActiveGate

Route traffic, monitor clouds and remote technologies & run Synthetic monitors

Full version history

To have more information on how to install the downloaded package, please follow the instructions on this page.
ReleaseDate

Full version history

This version contains a breaking change that will require recreation of monitoring configurations. This version has no new features for users who are currently monitoring Capella databases and no need for Capella users to upgrade at this time. Future versions will add new features and will require an upgrade and recreation of monitoring configurations.

  • Adds support for self-hosted clusters monitored remotely from ActiveGate
  • Improved first run experience. Adds Fastcheck that checks credentials and provides feedback in Extension app monitoring configuration logs
  • Improved handling of connection strings that lack ports. The extension will now determine if the cluster is self-hosted and assign a default port based on cluster type.
  • Adds the version of the Couchbase cluster to the metric metadata
  • Adds couchbase.sys_cpu_utilization_rate to match CPU metric provided by Couchbase admin UI

Full version history

v1.1.0

  • Node discovery is now done via the API
  • Enhanced node properties
  • Improved handling for malformed dimensions
  • Refactoring of code

Full version history

  • Increased allowed certificate length to 2600 characters
  • Clarified wording around settings related to the Connection String
Dynatrace Hub
Certified PartnersGet data into DynatraceBuild your own app
All (714)Log Management and AnalyticsKubernetesAI/ML ObservabilityInfrastructure ObservabilitySoftware DeliveryApplication ObservabilityApplication SecurityDigital ExperienceBusiness Analytics
Filter
Type
Built and maintained by
Deployment model
SaaS
  • SaaS
  • Managed
Dynatrace Developer
Filter
Type
Built and maintained by
Deployment model
SaaS
  • SaaS
  • Managed

Discover recent additions to Dynatrace

Problems logo

Problems

Analyze abnormal system behavior and performance problems detected by Davis AI.

Logs logo

Logs

Explore all your logs without writing a single query.

Security Investigator logo

Security Investigator

Fast and precise forensics for security and logs on Grail data with DQL queries.

Business Flow logo

Business Flow

Track, analyze, and optimize your critical business processes.

Carbon Impact logo

Carbon Impact

Provides the information about site's carbon footprint

Davis Anomaly Detection logo

Davis Anomaly Detection

Detect anomalies in timeseries using the Davis AI

Analyze your data

Understand your data better with deep insights and clear visualizations.

Notebooks logo

Notebooks

Create powerful, data-driven documents for custom analytics and collaboration.

Dashboards logo

Dashboards

Transform complex data into clear visualizations with custom dashboards.

Automate your processes

Turn data and answers into actions, securely, and at scale.

Workflows logo

Workflows

Automate tasks in your IT landscape, remediate problems, and visualize processes

Jira for Workflows logo

Jira for Workflows

Create, query, comment, transition, and resolve Jira tickets within workflows.

Slack logo

Slack

Automate Slack messaging for security incidents, attacks, remediation, and more.

Secure your cloud application

See vulnerabilities and attacks in your environment.

Security Overview logo

Security Overview

Get a comprehensive overview of the security of your applications.

Third-Party Vulnerabilities logo

Third-Party Vulnerabilities

Detect vulnerabilities in real time, with context and automated risk assessment.

Code-Level Vulnerabilities logo

Code-Level Vulnerabilities

Detect vulnerabilities in your code in real time.

Attacks logo

Attacks

Get a real-time overview of all the attacks on your environment.

Are you looking for something different?

We have hundreds of apps, extensions, and other technologies to customize your environment

Leverage our newest innovations of Dynatrace Saas

Kick-start your app creation

Kick-start your app creation

Whether you’re a beginner or a pro, Dynatrace Developer has the tools and support you need to create incredible apps with minimal effort.
Go to Dynatrace Developer
Upgrading from Dynatrace Managed to SaaS

Upgrading from Dynatrace Managed to SaaS

Drive innovation, speed, and agility in your organization by seamlessly and securely upgrading.
Learn More
Log Management and Analytics

Log Management and Analytics

Innovate faster and more efficiently with unified log management and log analytics for actionable insights and automation.
Learn more