Cassandra Integration¶

Protocol Integration¶

Cassandra protocol datasources related to request/response are available out-of-the-box within the AOC. Please look at pre-canned dashboards for Cassandra or use the Analytics Sandbox to plot charts without any additional configuration.

Note: Protocol metrics are captured by collectors running with EPOCH_ANALYSIS_DEPTH=layer7 set in their configuration.

Note: Only Cassandra protocol v5 is supported for protocol metrics.

In order to access infrastructure datasources, follow the steps listed in the infrastructure integration section below.

Attributes¶

Below attributes can be used in filters and group by operations in analytics within alerts, dashboards, etc.

Metric	Description	Value / Example
cassandra.error.code	Numeric error code	In this error message: `ERROR 1146 (42S02): Table 'test.no_such_table' doesn't exist`, the error code is `1146`.
cassandra.error.string	Description of the error	In this error message: `ERROR 1146 (42S02): Table 'test.no_such_table' doesn't exist`, error string is `Table 'test.no_such_table' doesn't exist`
cassandra.query	Full query statements captured as strings	`SELECT select_expression FROM keyspace_name.table_name`

There are some attributes that are common across the integrations. The description to the relevant attributes for this integration can be found here: shared attributes

Protocol Datasources¶

Metric	Available Aggregations	Value / Example	Description
cassandra.request_response.latency	`sum` `avg` `min` `max` `std_dev`	millisecond	The aggregated latency across all Cassandra request/response.
cassandra.request_response.throughput	`throughput`	/s	The total number of Cassandra request/response per second.
cassandra.request_response.count	`count`		The total number of Cassandra request/response.
cassandra.request.bytes	`sum` `avg` `min` `max`	byte	The aggregated number of bytes across all Cassandra requests.
cassandra.request.bytes.rate	`rate`	byte/s	The rate of bytes transferred across all Cassandra requests.
cassandra.request.count	`count`		The total number of Cassandra requests.
cassandra.request.packets	`sum` `avg` `min` `max`	packet	The aggregated number of packets across all Cassandra requests.
cassandra.request.packets.rate	`rate`	packet/s	The rate of packets transferred across all Cassandra requests.
cassandra.request.throughput	`throughput`	/s	The rate of total number of Cassandra requests.
cassandra.response.bytes	`sum` `avg` `min` `max`	byte	The aggregated number of bytes across all Cassandra responses.
cassandra.response.bytes.rate	`rate`	byte/s	The rate of bytes transferred across all Cassandra responses.
cassandra.response.count	`count`		The total number of Cassandra responses.
cassandra.response.packets	`sum` `avg` `min` `max`	packet	The aggregated number of packets across all Cassandra responses.
cassandra.response.packets.rate	`rate`	packet/s	The rate of packets transferred across all Cassandra responses.
cassandra.response.throughput	`throughput`	/s	The rate of total number of Cassandra responses.

Infrastructure Integration¶

Instructions¶

Follow the installation guide below for your given collector environment.

During installation, use the configuration section below as reference.

After installation, the infrastructure datasources in the table below will be available in the AOC.

Installation Guide¶

Installing this integration consists of creating a yaml file in the filesystem of your collectors. Click below for instructions on how to do so for your given collectors environment.

Configuration¶

Edit cassandra.yaml to configure the agent. Please refer cassandra.yaml for all available configuration options.

      instances:
        - host: localhost
          port: 7199
          cassandra_aliasing: true
          user: monitorRole
          password: QED
          name: cassandra_instance
          max_returned_metrics: 2000

      init_config:
        # List of metrics to be collected by the integration
        conf:
          - include:
              domain: org.apache.cassandra.metrics
              type: ClientRequest
              scope:
                - Read
                - Write
                name:
                - Latency
                - Timeouts
                - Unavailables
              attribute:
                - Count
                - OneMinuteRate
          - include:
              domain: org.apache.cassandra.metrics
              type: ClientRequest
              scope:
                - Read
                - Write
              name:
                - TotalLatency
          - include:
              domain: org.apache.cassandra.metrics
              type: Storage
              name:
                - Load
                - Exceptions

Infrastructure Datasources¶

Metric	Available Aggregations	Value / Example	Description
cassandra.active_tasks	`AVG` `MAX` `MIN` `SUM`	task	The number of tasks that the thread pool is actively executing.
cassandra.bloom_filter_disk_space_used	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used by the Bloom filters.
cassandra.bloom_filter_false_positives	`AVG` `MAX` `MIN` `SUM`	event	The number of Bloom filter false positives.
cassandra.bloom_filter_false_ratio	`AVG` `MAX` `MIN` `SUM`	fraction	The ratio of Bloom filter false positives to total checks.
cassandra.capacity	`AVG` `MAX` `MIN` `SUM`	byte	The capacity of the caches, such as the key cache and row cache.
cassandra.completed_tasks	`AVG` `MAX` `MIN` `SUM`	task	The number of tasks that the thread pool has completed.
cassandra.compression_ratio	`AVG` `MAX` `MIN` `SUM`	fraction	The compression ratio for all SSTables in a column family.
cassandra.currently_blocked_tasks.count	`AVG` `MAX` `MIN` `SUM`	task	The number of currently blocked tasks for the thread pool.
cassandra.exceptions.count	`AVG` `MAX` `MIN` `SUM`	error	The number of exceptions thrown.
cassandra.hits.count	`AVG` `MAX` `MIN` `SUM`	hit	The number of hits to a cache.
cassandra.latency.count	`AVG` `MAX` `MIN` `SUM`	request	The number of client requests.
cassandra.latency.one_minute_rate	`AVG` `MAX` `MIN` `SUM`	request/second	Recent rate of client requests, as an exponentially weighted moving average over a one-minute interval.
cassandra.live_disk_space_used.count	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used by "live" SSTables (only counts non-obsolete files).
cassandra.live_ss_table_count	`AVG` `MAX` `MIN` `SUM`	file	Number of "live" (non-obsolete) SSTables.
cassandra.load.count	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used on a node.
cassandra.max_row_size	`AVG` `MAX` `MIN` `SUM`	byte	Size of the largest compacted row.
cassandra.mean_row_size	`AVG` `MAX` `MIN` `SUM`	byte	Average size of compacted rows.
cassandra.memtable_columns_count	`AVG` `MAX` `MIN` `SUM`	column	Number of columns in memtable.
cassandra.memtable_live_data_size	`AVG` `MAX` `MIN` `SUM`	byte	Size of data stored in memtable.
cassandra.memtable_switch_count.count	`AVG` `MAX` `MIN` `SUM`	event	Number of times a full memtable has been switched out for an empty one due to flushing.
cassandra.min_row_size	`AVG` `MAX` `MIN` `SUM`	byte	Size of the smallest compacted row.
cassandra.pending_tasks	`AVG` `MAX` `MIN` `SUM`	task	The number of pending tasks for the thread pool.
cassandra.requests.count	`AVG` `MAX` `MIN` `SUM`	request	The number of requests to a cache.
cassandra.size	`AVG` `MAX` `MIN` `SUM`	byte	Size of cache.
cassandra.timeouts.count	`AVG` `MAX` `MIN` `SUM`	timeout	Count of requests not acknowledged within configurable timeout window.
cassandra.timeouts.one_minute_rate	`AVG` `MAX` `MIN` `SUM`	timeout/second	Recent timeout rate, as an exponentially weighted moving average over a one-minute interval.
cassandra.total_disk_space_used.count	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used by a column family.
cassandra.total_latency.count	`AVG` `MAX` `MIN` `SUM`	microsecond	Total latency for all client requests.
cassandra.unavailables.count	`AVG` `MAX` `MIN` `SUM`	error	Count of requests for which the required number of nodes was unavailable.
cassandra.unavailables.one_minute_rate	`AVG` `MAX` `MIN` `SUM`	error/second	Recent rate of unavailable exceptions, as an exponentially weighted moving average over a one-minute interval.
cassandra.db.update_interval	`AVG` `MAX` `MIN` `SUM`	millisecond	The configurable update interval for the dynamic snitch, which monitors read latency to route requests away from slow nodes.
cassandra.db.write_count	`AVG` `MAX` `MIN` `SUM`	write	The number of local write requests for a column family. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.latency.count instead)
cassandra.db.read_count	`AVG` `MAX` `MIN` `SUM`	read	The number of local read requests for a column family. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.latency.count instead)
cassandra.db.live_ss_table_count	`AVG` `MAX` `MIN` `SUM`	file	Number of "live" (non-obsolete) SSTables. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.live_ss_table_count instead)
cassandra.db.total_disk_space_used	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used by a column family. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.total_disk_space_used.count instead)
cassandra.db.memtable_data_size	`AVG` `MAX` `MIN` `SUM`	byte	Size of data stored in memtable. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.memtable_live_data_size instead)
cassandra.internal.currently_blocked_tasks	`AVG` `MAX` `MIN` `SUM`	task	The number of currently blocked tasks for the thread pool. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.currently_blocked_tasks.count instead)
cassandra.db.max_row_size	`AVG` `MAX` `MIN` `SUM`	byte	Size of the largest compacted row. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.max_row_size instead)
cassandra.db.live_disk_space_used	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used by "live" SSTables (only counts non-obsolete files). (Metric may not be available for Cassandra versions > 2.2. Use cassandra.live_disk_space_used.count instead)
cassandra.internal.active_count	`AVG` `MAX` `MIN` `SUM`	task	The number of tasks that the thread pool is actively executing. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.active_tasks instead)
cassandra.internal.completed_tasks	`AVG` `MAX` `MIN` `SUM`	task	The number of tasks that the thread pool has completed. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.completed_tasks instead)
cassandra.db.total_write_latency_micros	`AVG` `MAX` `MIN` `SUM`	microsecond	Total latency for all write requests. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.total_latency.count instead)
cassandra.db.total_read_latency_micros	`AVG` `MAX` `MIN` `SUM`	microsecond	Total latency for all read requests. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.total_latency.count instead)
cassandra.internal.total_blocked_tasks	`AVG` `MAX` `MIN` `SUM`	task	The cumulative total of currently blocked tasks for the thread pool. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.mean_row_size	`AVG` `MAX` `MIN` `SUM`	byte	Average size of compacted rows. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.mean_row_size instead)
cassandra.db.compression_ratio	`AVG` `MAX` `MIN` `SUM`	fraction	The compression ratio for all SSTables in a column family. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.compression_ratio instead)
cassandra.db.memtable_switch_count	`AVG` `MAX` `MIN` `SUM`	event	Number of times a full memtable has been switched out for an empty one due to flushing. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.memtable_switch_count.count instead)
cassandra.db.memtable_columns_count	`AVG` `MAX` `MIN` `SUM`	column	Number of columns in memtable. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.memtable_columns_count instead)
cassandra.db.min_row_size	`AVG` `MAX` `MIN` `SUM`	byte	Size of the smallest compacted row. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.min_row_size instead)
cassandra.db.bloom_filter_false_positives	`AVG` `MAX` `MIN` `SUM`	event	The number of Bloom filter false positives. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.bloom_filter_false_positives instead)
cassandra.db.bloom_filter_disk_space_used	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used by the Bloom filters. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.bloom_filter_disk_space_used instead)
cassandra.db.bloom_filter_false_ratio	`AVG` `MAX` `MIN` `SUM`	fraction	The ratio of Bloom filter false positives to total checks. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.bloom_filter_false_ratio instead)
cassandra.net.total_timeouts	`AVG` `MAX` `MIN` `SUM`	timeout	Count of requests not acknowledged within configurable timeout window. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.timeouts.count instead)
cassandra.db.completed_tasks	`AVG` `MAX` `MIN` `SUM`	task	Completed compaction or commitlog tasks. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.pending_tasks	`AVG` `MAX` `MIN` `SUM`	task	Pending compaction, commitlog, or column family tasks. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.pending_tasks instead)
cassandra.db.load	`AVG` `MAX` `MIN` `SUM`	byte	Disk space used on a node. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.load.count instead)
cassandra.db.exception_count	`AVG` `MAX` `MIN` `SUM`	error	The number of exceptions thrown. (Metric may not be available for Cassandra versions > 2.2. Use cassandra.exceptions.count instead)
cassandra.db.recent_read_latency_micros	`AVG` `MAX` `MIN` `SUM`	microsecond	The latency of reads since the last time this attribute was read. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.recent_write_latency_micros	`AVG` `MAX` `MIN` `SUM`	microsecond	The latency of writes since the last time this attribute was read. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.key_cache_recent_hit_rate	`AVG` `MAX` `MIN` `SUM`	fraction	Ratio of key cache hits to key cache requests since the last time this attribute was read. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.recent_range_latency_micros	`AVG` `MAX` `MIN` `SUM`	microsecond	The latency of range scans since the last time this attribute was read. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.total_range_latency_micros	`AVG` `MAX` `MIN` `SUM`	microsecond	Total latency for all range scans. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.write_operations	`AVG` `MAX` `MIN` `SUM`	operation	Count of write operations. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.read_operations	`AVG` `MAX` `MIN` `SUM`	operation	Count of read operations. (Metric may not be available for Cassandra versions > 2.2.)
cassandra.db.range_operations	`AVG` `MAX` `MIN` `SUM`	operation	Count of range scan operations. (Metric may not be available for Cassandra versions > 2.2.)