This page provides configuration details for Cassandra collectors.

Prerequisites

To monitor Cassandra with Database Visibility, you must be running version:

  • Apache Cassandra >= 3.11.4
  • Datastax Enterprise (DSE) Cassandra >= 6.7.3

Connection Details


FieldDescription
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.
JMX PortThe port to remotely connect through JMX (optional for DSE Cassandra). See JMX Configurations.
JMX UsernameThe name of the JMX user who is connecting to and monitoring the database using the Database Agent. See JMX configurations.
JMX PasswordThe password of the JMX user who is connecting to and monitoring the database through the Database Agent.
Username and PasswordUsername

The name of the user who is connecting to and monitoring the database using the Database Agent. The user must have the permissions described in:

PasswordThe password of the user who is connecting to and monitoring the database through the Database Agent.
Advanced Options

SSL 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
Monitor Operating SystemsSee Configure the Database Agent to Monitor Server Hardware.

Cassandra Configurations

These are the required configurations:

  • Query Capture Configurations

  • JMX Configurations for Apache/DSE Cassandra

    1. Open cassandra-env.sh file.
    2. To enable JMX for:

      1. local connection, under the if [ "$LOCAL_JMX" = "yes" ]; then  statement, set:

        JVM_OPTS="$JVM_OPTS -Dcom.sun.management.jmxremote.authenticate=true"
        CODE

      2. for remote connection, under the corresponding else statement, set:

        JVM_OPTS="$JVM_OPTS -Dcom.sun.management.jmxremote.authenticate=true"
        CODE

    3. Set the path to the credentials file, jmxremote.password:

      JVM_OPTS="$JVM_OPTS -Dcom.sun.management.jmxremote.password.file=PATH TO FILE"
      CODE

    4. In the jmxremote.password file, set JMX credentials to be the same as that of the database user credentials to be specified in the collector configuration:

      username password
      CODE

      You may choose to give ReadOnly JMX access to the database monitoring user by defining in the jmxremote.access file as mentioned in Enabling JMX authentication and authorization.