Cassandra plugin


This plugin

 collects metrics from Cassandra.


Prerequisites

Meter 4.2 or later must be installed.

The Cassandra plugin 2.1 or later supports the following Operating Systems.

Linux

✅️

Windows

✅️

OS X

✅️

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.
    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

 

Field Name

Description

Host

Host of the Cassandra JMX endpoint

Port

Port of the Cassandra JMX endpoint. Defaults to 7199

User

Username to access the Cassandra JMX endpoint

Password

Password to access the Cassandra JMX endpoint

Poll Interval

How often should the plugin poll for metrics.

Source

The Source to display in the legend for the metrics data. It will default to the hostname of the server.

Poll Interval

How often should the plugin poll for metrics.

Advanced configuration

To customize this plugin, see Cassandra plugin on GitHub.

Plugin metrics

Metric Name

Description

CASSANDRA_COMPACTION_PENDING_TASKS

Estimated number of pending compaction tasks.

CASSANDRA_COMPACTION_COMPLETED_TASKS

Estimated number of completed compaction tasks.

CASSANDRA_COMPACTION_TOTAL_COMPLETED_RATE

Estimated number of completed compaction tasks per second.

CASSANDRA_COMPACTION_BYTES_COMPACTED

Number of bytes compacted since node started.

CASSANDRA_CACHE_KEYCACHE_HITRATE

Cache hit rate for KeyCache.

CASSANDRA_CACHE_KEYCACHE_REQUESTS_RATE

Cache request count for KeyCache per second.

CASSANDRA_CACHE_KEYCACHE_ENTRIES

Number of entries on KeyCache.

CASSANDRA_CACHE_KEYCACHE_SIZE

Cache size in bytes for KeyCache.

CASSANDRA_CACHE_KEYCACHE_CAPACITY

Cache capacity in bytes for KeyCache.

CASSANDRA_CACHE_ROWCACHE_HITRATE

Cache hit rate for RowCache.

CASSANDRA_CACHE_ROWCACHE_REQUESTS_RATE

Cache request count for RowCache per second.

CASSANDRA_CACHE_ROWCACHE_ENTRIES

Number of entries on RowCache.

CASSANDRA_CACHE_ROWCACHE_SIZE

Cache size in bytes for RowCache.

CASSANDRA_CACHE_ROWCACHE_CAPACITY

Cache capacity in bytes for RowCache.

CASSANDRA_CACHE_COUNTERCACHE_HITRATE

Cache hit rate for CounterCache.

CASSANDRA_CACHE_COUNTERCACHE_REQUESTS_RATE

Cache request count for CounterCache per second.

CASSANDRA_CACHE_COUNTERCACHE_ENTRIES

Number of entries on CounterCache.

CASSANDRA_CACHE_COUNTERCACHE_SIZE

Cache size in bytes for CounterCache.

CASSANDRA_CACHE_COUNTERCHE_CAPACITY

Cache capacity in bytes for CounterCache.

CASSANDRA_HEAP_MEMORY_USED

Total Heap Memory used by the Cassandra instance.

CASSANDRA_WRITE_LATENCY_MEAN

Latency on write operations.

CASSANDRA_WRITE_FAILURES_RATE

Number of failures per second on write operations.

CASSANDRA_WRITE_TIMEOUTS_RATE

Number of timeouts per second on write operations.

CASSANDRA_READ_LATENCY_MEAN

Latency on read operations.

CASSANDRA_READ_FAILURES_RATE

Number of failures per second on read operations.

CASSANDRA_READ_TIMEOUTS_RATE

Number of timeouts per second on read operations.

CASSANDRA_CLIENT_CONNECTED_NATIVE_CLIENTS

Number of native clients connected.

CASSANDRA_CLIENT_CONNECTED_THRIFT_CLIENTS

Number of thrift clients connected.

CASSANDRA_STORAGE_LOAD_BYTES

Total disk space in bytes used for this node.

CASSANDRA_STORAGE_COMMITLOG_SIZE

Current data size of all commit log segments.

CASSANDRA_WRITE_LATENCY_95P

Write latency 95th percentile.

CASSANDRA_WRITE_1MIN_RATE

Write 1m rate.

CASSANDRA_READ_LATENCY_95P

Read latency 95th percentile.

CASSANDRA_READ_1MIN_RATE

Read 1m rate.

CASSANDRA_RANGE_SLICE_LATENCY_MEAN

Range slice latency mean.

CASSANDRA_RANGE_SLICE_LATENCY_95P

Range slice latency 95th percentile.

CASSANDRA_RANGE_SLICE_1MIN_RATE

Range slice 1m rate.

CASSANDRA_RANGE_SLICE_FAILURES_RATE

Range slice failure rate.

CASSANDRA_RANGE_SLICE_TIMEOUTS_RATE

Range slice timeout rate.

CASSANDRA_CAS_READ_LATENCY_MEAN

CAS read latency mean.

CASSANDRA_CAS_READ_LATENCY_95P

CAS read latency 95th percentile.

CASSANDRA_CAS_READ_1MIN_RATE

CAS read 1m rate.

CASSANDRA_CAS_READ_FAILURES_RATE

CAS read failures rate.

CASSANDRA_CAS_READ_TIMEOUTS_RATE

CAS read timeouts rate.

CASSANDRA_CAS_WRITE_LATENCY_MEAN

CAS write latency mean.

CASSANDRA_CAS_WRITE_LATENCY_95P

CAS write latency 95th percentile.

CASSANDRA_CAS_WRITE_1MIN_RATE

CAS write 1m rate.

CASSANDRA_CAS_WRITE_FAILURES_RATE

CAS write failures rate.

CASSANDRA_CAS_WRITE_TIMEOUTS_RATE

CAS write timeouts rate.

CASSANDRA_DROPPED_MUTATION_RATE

Dropped mutation rate.

CASSANDRA_DROPPED_READ_RATE

Dropped read rate.

CASSANDRA_DROPPED_COUNTER_MUTATION_RATE

Dropped counter mutation rate.

CASSANDRA_DROPPED_HINT_RATE

Dropped hint rate.

CASSANDRA_PENDING_MUTATIONS

Pending mutations.

CASSANDRA_PENDING_COUNTER_MUTATIONS

Pending counter mutations.

CASSANDRA_PENDING_READS

Pending reads.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*