Ship Cassandra metrics

You can ship Cassandra metrics to Logz.io using Metricbeat.

Configuration

Before you begin, you’ll need:

A server or cluster with Cassandra installed
Metricbeat 7.1 or higher installed

Expose metrics

The first step is to expose Cassandra metrics using the Prometheus JMX exporter.

You will need to download the JMX exporter on each Cassandra node.

JMX exporter

Go to the directory where Cassandra is installed on your machine:

cd {path_to_cassandra_dir}

Download the Prometheus JMX exporter:

curl -L -O https://search.maven.org/remotecontent?filepath=io/prometheus/jmx/jmx_prometheus_javaagent/0.13.0/jmx_prometheus_javaagent-0.13.0.jar

Download the exporter configuration file for Cassandra:

curl -L -O https://raw.githubusercontent.com/prometheus/jmx_exporter/master/example_configs/cassandra.yml

Configure Cassandra to forward metrics via JMX exporter

In order to integrate Cassandra with the JMX exporter, we’ll need to add one line to the Cassandra configuration file.

Navigate to the Cassandra configuration directory. (Depending on the installation method, it may be located under /etc/cassandra or /etc/cassandra/conf.) Open the file cassandra-env.sh in edit mode.

Without deleting or changing any of the content of the file, add the following line (after making the necessary changes to match the paths to your details):

JVM_OPTS="$JVM_OPTS -javaagent:/lib/jmx_prometheus_javaagent-0.13.0.jar=7070:/lib/cassandra.yml"

Restart Cassandra

Save your changes and restart Cassandra.

systemctl restart cassandra

Verify the JMX exporter metrics endpoint

At this point, the metrics for your Cassandra server should be locally exposed in Prometheus format. It’s recommended that you test your JMX exporter metrics endpoint:

curl http://<<Cassandra_host>>:7070

Metricbeat setup

Now that metrics are exposed, set up Metricbeat monitoring to send the data to Logz.io.

Download the Logz.io public certificate

For HTTPS shipping, download the Logz.io public certificate to your certificate authority folder.

sudo curl https://raw.githubusercontent.com/logzio/public-certificates/master/AAACertificateServices.crt --create-dirs -o /etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt

Add Logz.io to your Metricbeat configuration

Open the Metricbeat configuration file (<<PATH_TO_METRICBEAT>>/metricbeat.yml) with your preferred text editor.

Copy and paste the code block below, overwriting the previous contents, to replace the general configuration with the following Logz.io settings:

# ===== General =====
fields:
  logzio_codec: json
  token: <<SHIPPING-TOKEN>>
fields_under_root: true

Replace <<SHIPPING-TOKEN>> with a token for the Metrics account you want to ship to.
Here’s how to look up your Metrics token.

Set Logz.io as the output

Still in the same configuration file, check if Logz.io is already an output. If not, add it now.

# ===== Outputs =====
output.logstash:
  hosts: ["<<LISTENER-HOST>>:5015"]
    ssl.certificate_authorities: ['/etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt']

Replace <<LISTENER-HOST>> with your region’s listener host (for example, listener.logz.io). For more information on finding your account’s region, see Account region.

One last validation - make sure Logz.io is the only output and appears only once. If the file has other outputs, remove them.

Add the Cassandra configuration

Still in the same configuration file, copy and paste the code block below:

metricbeat.modules:

# Prometheus JMX metrics
- module: prometheus
  period: 10s
  metricsets: ["collector"]
  hosts: ["<<CASSANDRA-HOST>>:7070"]
  metrics_path: /

processors:
  - add_host_metadata: ~
  - add_fields:
      target: fields
      fields:
        module: cassandra
        cassandra.cluster:<<CLUSTER-TAG>>

fields:
  logzio_codec: json
  token: <<SHIPPING-TOKEN>>
fields_under_root: true
ignore_older: 3hr
type: metrics
output.logstash:
  hosts: ["<<LISTENER-HOST>>:5015"]
  ssl.certificate_authorities: ['/etc/pki/tls/certs/COMODORSADomainValidationSecureServerCA.crt']

For a full list of available Metricbeat configuration options for the Prometheus module, including explanations about TLS connections, please see Metricbeat’s documentation.

Replace the placeholders in the configuration

Still in the same configuration file, replace the placeholders to match your specifics.

Replace <<SHIPPING-TOKEN>> with a token for the Metrics account you want to ship to.
Here’s how to look up your Metrics token.
Replace <<LISTENER-HOST>> with your region’s listener host (for example, listener.logz.io). For more information on finding your account’s region, see Account region.
Edit the hosts field for prometheus JMX metrics. Specify a comma-separated list of your Cassandra server adresses, (for example: hosts: ["cassandra1:7070","cassandra2:7070"]).
Replace <<CLUSTER-TAG>> with a custom string value to help you identify your Cassandra cluster. This can be helpful if you’re running a multi-cluster Cassandra environment.

Start Metricbeat

Start or restart Metricbeat for the changes to take effect.

Open your Cassandra dashboard in Logz.io

Give your metrics a few minutes to get from your system to ours, and then open Logz.io.

Your metrics should appear in the preconfigured dashboard in your Metrics account. To open it, click > Manage in the left menu, then click Logz.io Dashboards > Cassandra.