Cassandra Nodetool

Supported OS Linux Mac OS Windows

Integration version3.0.0

Cassandra Nodetool Integration

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

Follow the instructions below to configure this check for an Agent running on a host. For containerized environments, see the Containerized section.

    Host

    1. 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:

instances:
  ## @param keyspaces - list of string - required
  ## The list of keyspaces to monitor.
  ## An empty list results in no metrics being sent.
  #
  - keyspaces:
      - "<KEYSPACE_1>"
      - "<KEYSPACE_2>"

    2. Restart the Agent.

    Log collection

    Cassandra Nodetool logs are collected by the Cassandra integration. See the log collection instructions for Cassandra.

    Containerized

    For containerized environments, use the official Prometheus exporter in the pod, and then use Autodiscovery in the Agent to find the pod and query the endpoint.

    Validation

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

    Data Collected

    Metrics

    cassandra.nodetool.status.load
    (gauge)    		Amount of file system data under the cassandra data directory without snapshot content
    Shown as byte
    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.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)

    Events

    The Cassandra_nodetool check does not include any events.

    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.

    Statuses: ok, critical

    Troubleshooting

    Need help? Contact Datadog support.

    Further Reading