To monitor Couchbase with Database Visibility, you must have:

  • Couchbase >= 4.5
  • Database Agent >= 20.x 

Connection Details

SectionFieldDescription
Create New CollectorDatabase TypeThe database type that you want to monitor.
AgentThe Database Agent that manages the collector.
Collector NameThe name you want to identify the collector by.
Connection DetailsHostname or IP AddressThe hostname or IP address of the machine that your database is running on.
Listener PortThe TCP/IP address of the port on which your database communicates with the Database Agent
Username and PasswordUsernameThe name of the user who is connecting to and monitoring the database through the Database Agent. The user should have the permissions described in User Permissions for Couchbase.
PasswordThe password of the user who is connecting to and monitoring the database through the Database Agent.
CyberArkClick to enable CyberArk for database username and password. When CyberArk is enabled, information about Application, Safe, Folder, and Object is required to fetch the username and password for your database. To use CyberArk with Database Visibility, you must download the JavaPasswordSDK.jar file from the CyberArk website and rename the file to cyberark-sdk-9.5.jar. Then, you must copy the JAR file to the lib directory of the database agent zip file.
Advanced OptionsSSL Connection

Click to enable SSL Connection:

  • Truststore Location: Location of the certificate on the DB Agent host.
  • Truststore Type: Type of SSL Connection. There are two truststore types:
    PKCS12 (default)
    SSO: Enables auto-login. If you use SSO, you only need to provide the truststore location and truststore type
  • Truststore Password: Password for SSL Connection.

If you also use client certificate authentication, then click the Enable SSL Client Authentication box. 

  • Keystore Location: location of the certificate on the DB Agent host
  • Keystore Type: type of SSL Connection
  • Keystore Password: password for SSL Connection

You can set the context protocol for the SSL environment using the COUCHBASE_SSL_CONTEXT_PROTOCOL system variable. If you do not set the context protocol through the system variable, TLSv1.3 is used by default.

These platforms support TLSv1.3:

  • Oracle JDK >= 8u261-b12
  • AdoptOpenJDK >= 8u262-b10
  • Azul Platform Prime >= 20.07.0.0

If a JDK version does not support TLSv1.3 or the specified context protocol, Splunk AppDynamics switches to TLSv1.2.

Exclude DatabasesThe databases that you want to exclude, separated by commas.
Monitor Operating SystemsSee this page for more details, Configure the Database Agent to Monitor Server Hardware.

User Permissions for Couchbase

The monitoring user must have Full Administrator or Read-only Administrator privileges. Alternatively, if you do not want the monitoring user to have Administrator privileges, you can assign a combination of Data Monitoring and Query System Catalog privileges (available for Couchbase >= 5).