Skip to content

Latest commit

 

History

History
 
 

cassandra

README.md

Cassandra Integration

Cassandra default dashboard

Overview

Get metrics from Cassandra 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. It's recommended to use Oracle's JDK for this integration.

Note: 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, contact Datadog support.

Configuration

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

Host

Metric Collection

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

  2. Restart the Agent.

Log Collection

Available for Agent versions >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, enable it in your datadog.yaml file:

    logs_enabled: true

  2. 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
      service: myapplication
      log_processing_rules:
         - type: multi_line
           name: log_start_with_date
           # pattern to match: DEBUG [ScheduledTasks:1] 2019-12-30
           pattern: '[A-Z]+ +\[[^\]]+\] +\d{4}-\d{2}-\d{2}'

    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.

    To make sure that stacktraces are properly aggregated as one single log, a multiline processing rule can be added.

  3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection

For containerized environments, see the Autodiscovery with JMX guide.

Log collection

Available for Agent versions >6.0

Collecting logs is disabled by default in the Datadog Agent. To enable it, see Kubernetes log collection documentation.

Parameter Value
<LOG_CONFIG> {"source": "cassandra", "service": "<SERVICE_NAME>"}

Validation

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

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

The Cassandra check does not include any events.

Service Checks

cassandra.can_connect:
Returns CRITICAL if the Agent is unable to connect to and collect metrics from the monitored Cassandra instance, otherwise returns OK.

Troubleshooting

Need help? Contact Datadog support.

Further Reading