---
title: Cassandra Nodetool
description: monitor cassandra using the nodetool utility
breadcrumbs: Docs > Integrations > Cassandra Nodetool
---

# Cassandra Nodetool
Supported OS Integration version3.4.0


## Overview{% #overview %}

This check collects metrics for your Cassandra cluster that are not available through [jmx integration](https://github.com/DataDog/integrations-core/tree/master/cassandra). It uses the `nodetool` utility to collect them.

**Minimum Agent version:** 6.6.0

## Setup{% #setup %}

### Installation{% #installation %}

The Cassandra Nodetool check is included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you don't need to install anything else on your Cassandra nodes.

### Configuration{% #configuration %}

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

{% tab title="Host" %}
#### Host{% #host %}

1. Edit the file `cassandra_nodetool.d/conf.yaml` in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory). See the [sample cassandra_nodetool.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/cassandra_nodetool/datadog_checks/cassandra_nodetool/data/conf.yaml.example) for all available configuration options:

   ```yaml
   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>"
   ```

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent).

#### Log collection{% #log-collection %}

Cassandra Nodetool logs are collected by the Cassandra integration. See the [log collection instructions for Cassandra](https://github.com/DataDog/integrations-core/tree/master/cassandra#log-collection).
{% /tab %}

{% tab title="Containerized" %}
#### Containerized{% #containerized %}

For containerized environments, use the official [Prometheus exporter](https://github.com/prometheus/jmx_exporter) in the pod, and then use Autodiscovery in the Agent to find the pod and query the endpoint.
{% /tab %}

### Validation{% #validation %}

[Run the Agent's `status` subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `cassandra_nodetool` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #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{% #events %}

The Cassandra_nodetool check does not include any events.

### Service Checks{% #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{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).

## Further Reading{% #further-reading %}

- [Monitor Cassandra Performance Metrics](https://www.datadoghq.com/blog/how-to-monitor-cassandra-performance-metrics)
- [Collect Cassandra Metrics](https://www.datadoghq.com/blog/how-to-collect-cassandra-metrics)
- [Monitoring Cassandra with Datadog](https://www.datadoghq.com/blog/monitoring-cassandra-with-datadog)