Cassandra

• Overview
• Setup
  • Prerequisites
  • Configuration
  • Testing Integration
• Metrics and Tags
  • Cache Metrics
  • Cache Metric Tags
  • Client Metrics
  • Client Metric Tags
  • Client Request Metrics
  • ClientRequest Metric Tags
  • CommitLog Metrics
  • CommitLog Metric Tags
  • Compaction Metrics
  • Compaction Metric Tags
  • Storage Metrics
  • Tags
  • Table Metrics
  • Table Metric Tags
  • Thread Pool Metrics
  • Thread Pool Metric Tags
  • Java GC Metrics
  • Java GC Metric Tags
  • Java Memory Metrics
  • Java Memory Metrics Tags

Overview

This integration collects JMX metrics from Cassandra. The plugin uses the Jolokia read service.

Setup

The cassandra monitoring is accomplished by bridge plugin which is included with the SolarWinds Snap Agent by default. Follow the directions below to enable it for a agent instance.

The bridge plugin utilize Telegraf Cassandra plugin.

Prerequisites

This integration requires that the Jolokia read service be available. This line of code should return results from the service:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl "http://localhost:8778/jolokia/read/java.lang:type=Memory/HeapMemoryUsage"
# response
{
   "request":{
      "mbean":"java.lang:type=Memory",
      "attribute":"HeapMemoryUsage",
      "type":"read"
   },
   "value":{
      "init":520093696,
      "committed":509607936,
      "max":509607936,
      "used":137689336
   },
   "timestamp":1510095659,
   "status":200
}

If there is an issue getting a valid response, you will need to add the read service. Download the JVM agent jar here. Then copy the jar to the Cassandra lib directory (/usr/share/cassandra/lib). Add the following line to the cassandra-env.sh file:

# Jolokia javaagent. Make sure you use the appropriate version number
JVM_OPTS="$JVM_OPTS -javaagent:$CASSANDRA_HOME/lib/jolokia-jvm-1.3.7-agent.jar"

Optionally you can change the default port if you like:

JVM_OPTS="$JVM_OPTS -javaagent:$CASSANDRA_HOME/lib/jolokia-jvm-1.3.7-agent.jar=port=<agent_port>,host=<node_ip>", or
JVM_OPTS="$JVM_OPTS -javaagent:$CASSANDRA_HOME/lib/jolokia-jvm-1.3.7-agent.jar=config=/path/to/config.properties

There are more configuration options here. You need to restart the Cassandra service.

sudo service cassandra restart

Configuration

The agent provides an example task file to help you get started quickly, but requires you to provide the correct settings for your Cassandra installation. To enable the task:

1. Make a copy of the cassandra example task file task-bridge-cassandra.yaml.example, renaming it to task-bridge-cassandra.yaml:

   On Windows, using Explorer or PowerShell:

   Copy

   > copy "C:\ProgramData\SolarWinds\Snap\tasks-autoload.d\task-bridge-cassandra.yaml.example" "C:\ProgramData\SolarWinds\Snap\tasks-autoload.d\task-bridge-cassandra.yaml"

   On Linux using command line:

   Copy

   $ sudo cp /opt/SolarWinds/Snap/Snaptics/etc/tasks-autoload.d/task-bridge-cassandra.yaml.example /opt/SolarWinds/Snap/etc/tasks-autoload.d/task-bridge-cassandra.yaml

2. Edit the task file with settings specific to your Cassandra install:

   If you wish to also collect logs for this service, uncomment the last section in the example task file. For more information on collecting logs, see the logs collector docs.

   Copy

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   ---
   version: 2
   
   schedule:
     type: cron
     interval: "0 * * * * *"
     
   plugins:
     - plugin_name: bridge
     
       config:
         cassandra:
         
           # This is the context root used to compose the jolokia url
           context: "/jolokia/read"
           
           ## List of cassandra servers exposing jolokia read service
           servers:
             - "myuser:mypassword@10.10.10.1:8778"
             - "10.10.10.2:8778"
             - ":8778"
             
           ## List of metrics collected on above servers
           ## Each metric consists of a jmx path.
           ## This will collect all heap memory usage metrics from the jvm and
           ## ReadLatency metrics for all keyspaces and tables.
           ## "type=Table" in the query works with Cassandra3.0. Older versions might
           ## need to use "type=ColumnFamily"
           metrics:
             - /java.lang:type=Memory/HeapMemoryUsage
             - /org.apache.cassandra.metrics:type=Table,keyspace=*,scope=*,name=ReadLatency
             
       publish:
         - plugin_name: publisher-appoptics
   
   ## If you want to gather logs for this integration, uncomment the following section.
   #  - plugin_name: logs
   #    config:
   #      sources:
   #        log_files:
   #          file_paths:
   #            - path: /var/log/cassandra/*.log
   #            ## For windows:
   #            - path: C:\\var\log\cassandra\*.log
   #    publish:
   #      - plugin_name: publisher-appoptics

   Take care to only add metrics you're interested in tracking because the metric count and cardinality can grow rapidly, particularly with the Table metrics.

3. Restart the agent:

   On Windows command line:

   Copy

   > net stop swisnapd
   > net start swisnapd

   On Linux command line:

   Copy

   $ sudo service swisnapd restart

4. Enable the Cassandra integration in AppOptics

   On the Integrations Page you will see Cassandra integration available if the previous steps were successful. It may take a couple minutes before the Cassandra integration is identified. Select the Cassandra integration to open the configuration menu in the UI, and enable it. If you do not see it, see Troubleshooting Linux.

Testing Integration

To check if and what metrics can be collected with given configuration, run bridge plugin in debug mode:

On Windows command line:

> "C:\Program Files\SolarWinds\Snap\bin\snap-plugin-collector-bridge.exe" --debug-mode --plugin-config "{\"cassandra\": {\"context\": \"/jolokia/read\", \"servers\": [\"myuser:mypassword@10.10.10.1:8778\"], \"metrics\": [\"/java.lang:type=Memory/HeapMemoryUsage\"]}}"

On Linux command line:

$ /opt/SolarWinds/Snap/bin/snap-plugin-collector-bridge --debug-mode --plugin-config "{\"cassandra\": {\"context\": \"/jolokia/read\", \"servers\": [\"myuser:mypassword@10.10.10.1:8778\"], \"metrics\": [\"/java.lang:type=Memory/HeapMemoryUsage\"]}}"

Metrics and Tags

The table below lists each of the metrics gathered from the status endpoint.

Cache Metrics

Cache Metric Tags

The table below outlines the default set of tags provided for each metric.

Client Metrics

Client Metric Tags

The table below outlines the default set of tags provided for each metric.

Client Request Metrics

ClientRequest Metric Tags

The table below outlines the default set of tags provided for each metric.

CommitLog Metrics

CommitLog Metric Tags

The table below outlines the default set of tags provided for each metric.

Compaction Metrics

Compaction Metric Tags

The table below outlines the default set of tags provided for each metric.

Storage Metrics

Tags

The table below outlines the default set of tags provided for each metric.

Table Metrics

Table Metric Tags

The table below outlines the default set of tags provided for each metric.

Thread Pool Metrics

Thread Pool Metric Tags

The table below outlines the default set of tags provided for each metric.

Java GC Metrics

Java GC Metric Tags

The table below outlines the default set of tags provided for each metric.

Java Memory Metrics

Java Memory Metrics Tags

The table below outlines the default set of tags provided for each metric.

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.