Skip to main content
Sumo Logic

Install the Cassandra Monitors, App, and View the Dashboards

This page has instructions for installing the Sumo App for Cassandra Monitors, App, as well as descriptions and examples for each of the dashboards.

This page has instructions for installing Sumo Logic Monitors for Cassandra, the app, and descriptions of each of the app dashboards.

Install Monitors

Sumo Logic has provided pre-packaged alerts available through Sumo Logic monitors to help you proactively determine if a Cassandra cluster is available and performing as expected. These monitors are based on metric and log data and include pre-set thresholds that reflect industry best practices and recommendations. For more information about individual alerts, see Cassandra Alerts.

To install these monitors, you must have the Manage Monitors role capability.

You can install monitors by importing a JSON file or using a Terraform script.

Method One: Install Monitors by importing a JSON file

  1. Download the JSON file that describes the monitors. 

  2. The JSON contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Cassandra clusters, the data for which has been collected via the instructions in the previous sections.  

However, if you would like to restrict these alerts to specific clusters or environments, update the JSON file by replacing the text db_cluster=* with <Your Custom Filter>.  

Custom filter examples: 

  1. For alerts applicable only to a specific cluster, your custom filter would be:  db_cluster=dev-cassandra-01

  2. For alerts applicable to all clusters that start with cassandra-prod, your custom filter would be: db_cluster=cassandra-prod*

  3. For alerts applicable to specific clusters, within a production environment, your custom filter would be:db_cluster=dev-cassandra-01 AND environment=prod (This assumes you have set the optional environment tag while configuring collection)

  1. Go to Manage Data > Alerts > Monitors.

  2. Click Add.

  3. Click Import.
    import-option.png

  4. On the Import Content popup, enter Cassandra in the Name field, paste the JSON into the popup, and click Import.
    import-content.png

  5. The monitors are created in a "Cassandra" folder. The monitors are disabled by default. See the Monitors topic for information about enabling monitors and configuring notifications or connections.

Method Two: Install Monitors using a Terraform script

Generate a Sumo Logic access key and ID

Generate an access key and access ID for a user that has the Manage Monitors role capability. For instructions see  Access Keys

Download and install Terraform

Download Terraform 0.13 or later, and install it. 

Download the Sumo Logic Terraform package for Cassandra monitors

The alerts package is available in the Sumo Logic github repository. You can either download it using the git clone command or as a zip file. 

Alert Configuration 

After extracting the package, navigate to the  terraform-sumologic-sumo-logic-monitor/monitor_packages/Cassandra/ directory.

Edit the Cassandra.auto.tfvars file and add the Sumo Logic Access Key and Access ID from Step 1 and your Sumo Logic deployment. If you're not sure of your deployment, see Sumo Logic Endpoints and Firewall Security

access_id   = "<SUMOLOGIC ACCESS ID>"

access_key  = "<SUMOLOGIC ACCESS KEY>"

environment = "<SUMOLOGIC DEPLOYMENT>"

The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific clusters or environments, update the cassandra_data_source variable. For example:

To configure alerts for...

Set cassandra_data_source to something like :

A specific clusters

db_cluster=cassandra.prod.01

All clusters in an environment

environment=prod

Multiple clusters using a wildcard

db_cluster=cassandra-prod*

A specific clusters within a specific environment

db_cluster=cassandra-1 and environment=prod

 

This assumes you have configured and applied Fields as described in Step 1: Configure Fields of the Sumo Logic of the Collect Logs and Metrics for Cassandra topic.

All monitors are disabled by default on installation. To enable all of the monitors, set the monitors_disabled parameter to false.

By default, the monitors will be located in a "Cassandra" folder on the Monitors page. To change the name of the folder, update the monitor folder name in the folder variable in the Cassandra.auto.tfvars file.

If you want the alerts to send email or connection notifications, follow the instructions in the next section.

Email and Connection Notification Configuration Examples

Edit the Cassandra_notifications.auto.tfvars file to populate the connection_notifications and email_notifications sections. Examples are provided below.

Pagerduty connection example

In the variable definition below, replace <CONNECTION_ID> with the connection ID of the Webhook connection. You can obtain the Webhook connection ID by calling the Monitors API.

connection_notifications = [
    {
      connection_type       = "PagerDuty",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    },
    {
      connection_type       = "Webhook",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]
Email notifications example
email_notifications = [
    {
      connection_type       = "Email",
      recipients            = ["abc@example.com"],
      subject               = "Monitor Alert: {{TriggerType}} on {{Name}}",
      time_zone             = "PST",
      message_body          = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]

Install Monitors

  1. Navigate to the terraform-sumologic-sumo-logic-monitor/monitor_packages/Cassandra/ directory and run terraform init. This will initialize Terraform and download the required components.

  2. Run terraform plan to view the monitors that Terraform will create or modify.

  3. Run terraform apply.

This section demonstrates how to install the Cassandra App.

Install the App

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 

  2. Select the version of the service you're using and click Add to Library.

  1. To install the app, complete the following fields.

    1. App Name. You can retain the existing name, or enter a name of your choice for the app.


    2. Data Source

      • Choose Enter a Custom Data Filter, and enter a custom SQL Server cluster filter. Examples: 

      1. For all Cassandra clusters
        db_cluster=*
      2. For a specific cluster:
        db_cluster=cassandra.dev.01
      3. Clusters within a specific environment:
        db_cluster=cassandra.dev.01 and environment=prod
        (This assumes you have set the optional environment tag while configuring collection)
      4. Advanced. Select the Location in the Library (the default is the Personal folder in the library), or click New Folder to add a new folder.
  2. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or another folder that you specified. From here, you can share it with your organization. 

Panels will start to fill automatically. It's important to note that each panel slowly fills with data matching the time range query and received since the panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps. 

Dashboards

Cassandra - Overview

The Cassandra - Overview dashboard provides an at-a-glance view of Cassandra backend and frontend HTTP error codes percentage, visitor location, URLs, and clients causing errors.

Use this dashboard to:

  • Identify Frontend and Backend Sessions percentage usage to understand active sessions. This can help you increase the session limit.
  • Gain insights into originated traffic location by region. This can help you allocate computer resources to different regions according to their needs.
  • Gain insights into the client, server responses on the server. This helps you identify errors in the server.
  • Gain insights into network traffic for the frontend and backend systems of your server.

Cassandra Cache Stats

The Cassandra - Cache Stats dashboard provides insight into the database cache status, schedule, and items.

Use this dashboard to:

  • Monitor Cache performance. 
  • Identify Cache usage statistics.

Cassandra Errors and Warnings

The Cassandra - Errors and Warnings dashboard provides details of the database errors and warnings.

Use this dashboard to:

  • Review errors and warnings generated by the server. 
  • Review the Threads errors and warning events.

Cassandra Gossip

The Cassandra - Gossip dashboard provides details about communication between various cassandra nodes.

Use this dashboard to:

  • Determine nodes with errors resulting in failures. 
  • Review the node activity and pending tasks.

Cassandra Memtable

The Cassandra - Memtable dashboard provides insights into memtable statistics.

Use this dashboard to:

  • Review flush activity and memtable status. 

Cassandra Resource Usage

The Cassandra - Resource Usage dashboard provides details of resource utilization across Cassandra clusters.

Use this dashboard to:

  • Identify resource utilization. This can help you to determine resources over or under allocation.

Cassandra Compactions

The Cassandra - Compactions dashboard provides details of compactions.

Use this dashboard to:

  • Review pending/completed compactions and flushes.

Cassandra Garbage Collection

The Cassandra - Garbage Collection dashboard shows key Garbage Collector statistics like the duration of the last GC run, objects collected, threads used, and memory cleared in the last GC run.

Use this dashboard to:

  • Understand the garbage collection time. If the time keeps on increasing, you may have more CPU usage.
  • Understand the amount of memory cleared by garbage collectors across memory pools and its impact on the Heap memory.

Cassandra Read Path

The Cassandra - Read Path dashboard shows read operation statistics.

Use this dashboard to:

  • Gather insights into read operations, cache statistics, Tombstone, and SSTTables summary.
  • Review thread pool and memtable usage for read operations. 

Cassandra Resource Usage Logs

The Cassandra - Resource Usage Logs dashboard provides details of resource utilization across Cassandra clusters.

Use this dashboard to:

  • Identify resource utilization. This can help you to determine resources over or under allocation.

Cassandra Thread Pool

The Cassandra - Thread Pool dashboard shows thread pool statistics.

Use this dashboard to:

  • Review thread pool usage and statistics for different kinds of operations.

Cassandra Write Path

The Cassandra - Write Path dashboard shows write operation statistics.

Use this dashboard to:

  • Gather insights into write operations, cache statistics, Tombstone, and SSTTables summary.
  • Review thread pool and memtable usage for write operations.