The Service Map for APM is here!

Cassandra

Agent Check Agent Check

Supported OS: Linux Mac OS Windows

Cassandra default dashboard

Overview

Get metrics from Cassandra service in real time to:

  • Visualize and monitor Cassandra states
  • Be notified about Cassandra failovers and events.

Setup

Installation

The Cassandra check is included in the Datadog Agent package, so you don’t need to install anything else on your Cassandra nodes.

We recommend the use of Oracle’s JDK for this integration.

This check has a limit of 350 metrics per instance. The number of returned metrics is indicated in the info page. You can specify the metrics you are interested in by editing the configuration below. To learn how to customize the metrics to collect visit the JMX Checks documentation for more detailed instructions. If you need to monitor more metrics, please send us an email at support@datadoghq.com

Configuration

Edit the cassandra.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Cassandra metrics and logs. See the sample cassandra.d/conf.yaml for all available configuration options.

Metric Collection

The default configuration of your cassandra.d/conf.yaml file activate the collection of your Cassandra metrics. See the sample cassandra.d/conf.yaml for all available configuration options.

Log Collection

Available for Agent >6.0

  • Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:
  logs_enabled: true
  • Add this configuration block to your cassandra.d/conf.yaml file to start collecting your Cassandra logs:
  logs:
    - type: file
      path: /var/log/cassandra/*.log
      source: cassandra
      sourcecategory: database
      service: myapplication

Change the path and service parameter values and configure them for your environment. See the sample cassandra.d/conf.yaml for all available configuration options.

Validation

Run the Agent’s status subcommand and look for cassandra under the Checks section.

Data Collected

Metrics

cassandra.bloom_filter_false_ratio
(gauge)
The ratio of Bloom filter false positives to total checks.
shown as fraction
cassandra.bytes_flushed.count
(gauge)
The amount of data that was flushed since (re)start.
shown as byte
cassandra.cas_commit_latency.75th_percentile
(gauge)
The latency of paxos commit round - p75.
shown as microsecond
cassandra.cas_commit_latency.95th_percentile
(gauge)
The latency of paxos commit round - p95.
shown as microsecond
cassandra.cas_commit_latency.one_minute_rate
(gauge)
The number of paxos commit round per second.
shown as operation
cassandra.cas_prepare_latency.75th_percentile
(gauge)
The latency of paxos prepare round - p75.
shown as microsecond
cassandra.cas_prepare_latency.95th_percentile
(gauge)
The latency of paxos prepare round - p95.
shown as microsecond
cassandra.cas_prepare_latency.one_minute_rate
(gauge)
The number of paxos prepare round per second.
shown as operation
cassandra.cas_propose_latency.75th_percentile
(gauge)
The latency of paxos propose round - p75.
shown as microsecond
cassandra.cas_propose_latency.95th_percentile
(gauge)
The latency of paxos propose round - p95.
shown as microsecond
cassandra.cas_propose_latency.one_minute_rate
(gauge)
The number of paxos propose round per second.
shown as operation
cassandra.col_update_time_delta_histogram.75th_percentile
(gauge)
The column update time delta - p75.
shown as microsecond
cassandra.col_update_time_delta_histogram.95th_percentile
(gauge)
The column update time delta - p95.
shown as microsecond
cassandra.col_update_time_delta_histogram.min
(gauge)
The column update time delta - min.
shown as microsecond
cassandra.compaction_bytes_written.count
(gauge)
The amount of data that was compacted since (re)start.
shown as byte
cassandra.compression_ratio
(gauge)
The compression ratio for all SSTables. /!\ A low value means a high compression contrary to what the name suggests. Formula used is: 'size of the compressed SSTable / size of original'
shown as fraction
cassandra.currently_blocked_tasks
(gauge)
The number of currently blocked tasks for the thread pool.
shown as task
cassandra.currently_blocked_tasks.count
(gauge)
The number of currently blocked tasks for the thread pool.
shown as task
cassandra.db.droppable_tombstone_ratio
(gauge)
The estimate of the droppable tombstone ratio.
shown as fraction
cassandra.dropped.one_minute_rate
(gauge)
The tasks dropped during execution for the thread pool.
shown as thread
cassandra.exceptions.count
(gauge)
The number of exceptions thrown from ‘Storage’ metrics.
shown as error
cassandra.key_cache_hit_rate
(gauge)
The key cache hit rate.
shown as fraction
cassandra.latency.75th_percentile
(gauge)
The client request latency - p75.
shown as microsecond
cassandra.latency.95th_percentile
(gauge)
The client request latency - p95.
shown as microsecond
cassandra.latency.one_minute_rate
(gauge)
The number of client requests.
shown as request
cassandra.live_disk_space_used.count
(gauge)
The disk space used by "live" SSTables (only counts in use files).
shown as byte
cassandra.live_ss_table_count
(gauge)
Number of "live" (in use) SSTables.
shown as file
cassandra.load.count
(gauge)
The disk space used by live data on a node.
shown as byte
cassandra.max_partition_size
(gauge)
The size of the largest compacted partition.
shown as byte
cassandra.max_row_size
(gauge)
The size of the largest compacted row.
shown as byte
cassandra.mean_partition_size
(gauge)
The average size of compacted partition.
shown as byte
cassandra.mean_row_size
(gauge)
The average size of compacted rows.
shown as byte
cassandra.pending_compactions
(gauge)
The number of pending compactions.
shown as task
cassandra.pending_flushes.count
(gauge)
The number of pending flushes.
shown as flush
cassandra.pending_tasks
(gauge)
The number of pending tasks for the thread pool.
shown as task
cassandra.range_latency.75th_percentile
(gauge)
The local range request latency - p75.
shown as microsecond
cassandra.range_latency.95th_percentile
(gauge)
The local range request latency - p95.
shown as microsecond
cassandra.range_latency.one_minute_rate
(gauge)
The number of local range requests.
shown as request
cassandra.read_latency.75th_percentile
(gauge)
The local read latency - p75.
shown as microsecond
cassandra.read_latency.95th_percentile
(gauge)
The local read latency - p95.
shown as microsecond
cassandra.read_latency.99th_percentile
(gauge)
The local read latency - p99.
shown as microsecond
cassandra.read_latency.one_minute_rate
(gauge)
The number of local read requests.
shown as read
cassandra.row_cache_hit_out_of_range.count
(gauge)
The number of row cache hits that do not satisfy the query filter and went to disk.
shown as hit
cassandra.row_cache_hit.count
(gauge)
The number of row cache hits.
shown as hit
cassandra.row_cache_miss.count
(gauge)
The number of table row cache misses.
shown as miss
cassandra.snapshots_size
(gauge)
The disk space truly used by snapshots.
shown as byte
cassandra.ss_tables_per_read_histogram.75th_percentile
(gauge)
The number of SSTable data files accessed per read - p75.
shown as file
cassandra.ss_tables_per_read_histogram.95th_percentile
(gauge)
The number of SSTable data files accessed per read - p95.
shown as file
cassandra.tombstone_scanned_histogram.75th_percentile
(gauge)
Number of tombstones scanned per read - p75.
shown as record
cassandra.tombstone_scanned_histogram.95th_percentile
(gauge)
Number of tombstones scanned per read - p95.
shown as record
cassandra.total_blocked_tasks
(gauge)
Total blocked tasks
shown as task
cassandra.total_blocked_tasks.count
(count)
Total count of blocked tasks
shown as task
cassandra.total_commit_log_size
(gauge)
The size used on disk by commit logs.
shown as byte
cassandra.total_disk_space_used.count
(gauge)
Total disk space used by SSTables including obsolete ones waiting to be GC’d.
shown as byte
cassandra.view_lock_acquire_time.75th_percentile
(gauge)
The time taken acquiring a partition lock for materialized view updates - p75.
shown as microsecond
cassandra.view_lock_acquire_time.95th_percentile
(gauge)
The time taken acquiring a partition lock for materialized view updates - p95.
shown as microsecond
cassandra.view_lock_acquire_time.one_minute_rate
(gauge)
The number of requests to acquire a partition lock for materialized view updates.
shown as request
cassandra.view_read_time.75th_percentile
(gauge)
The time taken during the local read of a materialized view update - p75.
shown as microsecond
cassandra.view_read_time.95th_percentile
(gauge)
The time taken during the local read of a materialized view update - p95.
shown as microsecond
cassandra.view_read_time.one_minute_rate
(gauge)
The number of local reads for materialized view updates.
shown as request
cassandra.waiting_on_free_memtable_space.75th_percentile
(gauge)
The time spent waiting for free memtable space either on- or off-heap - p75.
shown as microsecond
cassandra.waiting_on_free_memtable_space.95th_percentile
(gauge)
The time spent waiting for free memtable space either on- or off-heap - p95.
shown as microsecond
cassandra.write_latency.75th_percentile
(gauge)
The local write latency - p75.
shown as microsecond
cassandra.write_latency.95th_percentile
(gauge)
The local write latency - p95.
shown as microsecond
cassandra.write_latency.99th_percentile
(gauge)
The local write latency - p99.
shown as microsecond
cassandra.write_latency.one_minute_rate
(gauge)
The number of local write requests.
shown as write

Events

The Cassandra check does not include any events at this time.

Service Checks

cassandra.can_connect

Returns CRITICAL if the Agent is unable to connect to and collect metrics from the monitored Cassandra instance. Returns OK otherwise.

Troubleshooting

Need help? Contact Datadog Support.

Further Reading


Mistake in the docs? Feel free to contribute!

Agent Check: Cassandra Nodetool

Cassandra default dashboard

Overview

This check collects metrics for your Cassandra cluster that are not available through jmx integration. It uses the nodetool utility to collect them.

Setup

Installation

The Cassandra Nodetool check is included in the Datadog Agent package, so you don’t need to install anything else on your Cassandra nodes.

Configuration

Edit the file cassandra_nodetool.d/conf.yaml in the conf.d/ folder at the root of your Agent’s configuration directory. See the sample cassandra_nodetool.d/conf.yaml for all available configuration options:

init_config:
  # command or path to nodetool (e.g. /usr/bin/nodetool or docker exec container nodetool)
  # can be overwritten on an instance
  # nodetool: /usr/bin/nodetool

instances:

  # the list of keyspaces to monitor
  - keyspaces: []

  # host that nodetool will connect to.
  # host: localhost

  # the port JMX is listening to for connections.
  # port: 7199

  # a set of credentials to connect to the host. These are the credentials for the JMX server.
  # For the check to work, this user must have a read/write access so that nodetool can execute the `status` command
  # username:
  # password:

  # a list of additional tags to be sent with the metrics
  # tags: []

Validation

Run the Agent’s status subcommand and look for cassandra_nodetool under the Checks section.

Data Collected

Metrics

cassandra.nodetool.status.replication_availability
(gauge)
Percentage of data available per keyspace times replication factor
shown as percent
cassandra.nodetool.status.replication_factor
(gauge)
Replication factor per keyspace
cassandra.nodetool.status.status
(gauge)
Node status: up (1) or down (0)
cassandra.nodetool.status.owns
(gauge)
Percentage of the data owned by the node per datacenter times the replication factor
shown as percent
cassandra.nodetool.status.load
(gauge)
Amount of file system data under the cassandra data directory without snapshot content
shown as byte

Events

The Cassandra_nodetool check does not include any events at this time.

Service Checks

cassandra.nodetool.node_up: The agent sends this service check for each node of the monitored cluster. Returns CRITICAL if the node is down, otherwise OK.

Troubleshooting

Need help? Contact Datadog Support.

Further Reading


Mistake in the docs? Feel free to contribute!