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:
- 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).
- Instrument the java client with OpenTelemetry.
- 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.
This initial release focuses on support for Capella, Couchbase's cloud database platform. Future versions will add support for the Couchbase Server self-hosted solution.
Monitoring Cappella is handled by deploying the extension on an ActiveGate.
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 UI. Below are guidelines for the required configurations.
Connection Hostname
This is the Capella Connection String. In the Capella UI, go to the Connect tab on a Database and copy the full connection string.
User Credentials
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)
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.