You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations/databases/cassandra.md
+54-53Lines changed: 54 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
13
13
14
14
The Cassandra app is a unified logs and metrics app that helps you monitor the availability, performance, health, and resource utilization of your Cassandra clusters. Preconfigured dashboards provide insight into cluster health, resource utilization, cache/Gossip/Memtable statistics, compaction, garbage collection, thread pools, and write paths.
15
15
16
-
## Log types
16
+
## Log types and Metrics
17
17
18
18
The app supports Logs and Metrics from the open-source version of Cassandra. The app is tested on the 3.11.10 version of Cassandra.
19
19
@@ -27,29 +27,7 @@ The Sumo Logic app for Cassandra supports metrics generated by the [Jolokia2 plu
27
27
28
28
This section provides instructions for configuring log and metric collection for the Sumo Logic app for Cassandra.
29
29
30
-
31
-
### Step 1: Configure fields in Sumo Logic
32
-
33
-
As part of the app installation process, the following fields will be created by default:
34
-
*`component`
35
-
*`environment`
36
-
*`db_system`
37
-
*`db_cluster`
38
-
*`pod`
39
-
*`db_cluster_address`
40
-
*`db_cluster_port`
41
-
42
-
Additionally, if you're using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
43
-
*`pod_labels_component`
44
-
*`pod_labels_environment`
45
-
*`pod_labels_db_system`
46
-
*`pod_labels_db_cluster`
47
-
*`pod_labels_db_cluster_address`
48
-
*`pod_labels_db_cluster_port`
49
-
50
-
For information on setting up fields, see [Fields](/docs/manage/fields).
51
-
52
-
### Step 2: Configure Collection for Cassandra
30
+
### Configure Collection for Cassandra
53
31
54
32
<Tabs
55
33
groupId="k8s-nonk8s"
@@ -76,7 +54,7 @@ In the logs pipeline, Sumo Logic Distribution for OpenTelemetry Collector collec
76
54
It’s assumed that you're using the latest helm chart version. If not, upgrade using the instructions [here](/docs/send-data/kubernetes).
77
55
:::
78
56
79
-
####Configure Metrics Collection
57
+
### Configure Metrics Collection
80
58
81
59
Follow the steps listed below to collect Cassandra metrics from a Kubernetes environment.
82
60
@@ -188,7 +166,7 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra
188
166
3. Sumo Logic Kubernetes collection will automatically start collecting metrics from the pods having the labels and annotations defined in the previous step.
189
167
4. Verify metrics in Sumo Logic.
190
168
191
-
####Configure Logs Collection
169
+
### Configure Logs Collection
192
170
193
171
This section explains the steps to collect Cassandra logs from a Kubernetes environment.
194
172
@@ -271,7 +249,7 @@ We use the Telegraf operator for Cassandra metric collection and Sumo Logic Inst
This section provides instructions for configuring metrics collection for the Sumo Logic app for Cassandra.
277
255
@@ -390,7 +368,7 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra
390
368
Once you have finalized your telegraf.conf file, you can start or reload the telegraf service using instructions from the [doc](https://docs.influxdata.com/telegraf/v1.17/introduction/getting-started/#start-telegraf-service). At this point, Cassandra metrics should start flowing into Sumo Logic.
391
369
392
370
393
-
#### Configure Logs Collection
371
+
### Configure Logs Collection
394
372
395
373
This section provides instructions for configuring log collection for Cassandra running on a non-Kubernetes environment.
396
374
@@ -498,15 +476,38 @@ This step is not needed if you are using the [Application Components Solution](/
498
476
499
477
This section demonstrates how to install the Cassandra app.
As part of the app installation process, the following fields will be created by default:
484
+
*`component`
485
+
*`environment`
486
+
*`db_system`
487
+
*`db_cluster`
488
+
*`pod`
489
+
*`db_cluster_address`
490
+
*`db_cluster_port`
491
+
492
+
Additionally, if you're using Cassandra in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
493
+
* `pod_labels_component`
494
+
* `pod_labels_environment`
495
+
* `pod_labels_db_system`
496
+
* `pod_labels_db_cluster`
497
+
* `pod_labels_db_cluster_address`
498
+
* `pod_labels_db_cluster_port`
499
+
500
+
For information on setting up fields, see [Fields](/docs/manage/fields).
504
501
505
502
## Viewing Cassandra dashboards
506
503
504
+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
505
+
506
+
<ViewDashboards/>
507
+
507
508
### Overview
508
509
509
-
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.
510
+
The **Cassandra (Classic) - Overview** dashboard provides an at-a-glance view of Cassandra backend and frontend HTTP error codes percentage, visitor location, URLs, and clients causing errors.
510
511
511
512
Use this dashboard to:
512
513
* Identify Frontend and Backend Sessions percentage usage to understand active sessions. This can help you increase the session limit.
@@ -518,7 +519,7 @@ Use this dashboard to:
518
519
519
520
### Cache Stats
520
521
521
-
The **Cassandra - Cache Stats** dashboard provides insight into the database cache status, schedule, and items.
522
+
The **Cassandra (Classic) - Cache Stats** dashboard provides insight into the database cache status, schedule, and items.
522
523
523
524
Use this dashboard to:
524
525
* Monitor Cache performance.
@@ -528,7 +529,7 @@ Use this dashboard to:
528
529
529
530
### Errors and Warnings
530
531
531
-
The **Cassandra - Errors and Warnings** dashboard provides details of the database errors and warnings.
532
+
The **Cassandra (Classic) - Errors and Warnings** dashboard provides details of the database errors and warnings.
532
533
533
534
Use this dashboard to:
534
535
* Review errors and warnings generated by the server.
@@ -538,7 +539,7 @@ Use this dashboard to:
538
539
539
540
### Gossip
540
541
541
-
The **Cassandra - Gossip** dashboard provides details about communication between various cassandra nodes.
542
+
The **Cassandra (Classic) - Gossip** dashboard provides details about communication between various cassandra nodes.
542
543
543
544
Use this dashboard to:
544
545
* Determine nodes with errors resulting in failures.
@@ -548,7 +549,7 @@ Use this dashboard to:
548
549
549
550
### Memtable
550
551
551
-
The **Cassandra - Memtable** dashboard provides insights into memtable statistics.
552
+
The **Cassandra (Classic) - Memtable** dashboard provides insights into memtable statistics.
552
553
553
554
Use this dashboard to:
554
555
* Review flush activity and memtable status.
@@ -557,7 +558,7 @@ Use this dashboard to:
557
558
558
559
### Resource Usage
559
560
560
-
The **Cassandra - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters.
561
+
The **Cassandra (Classic) - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters.
561
562
562
563
Use this dashboard to:
563
564
* Identify resource utilization. This can help you to determine whether are resources over- or under-allocated.
@@ -566,7 +567,7 @@ Use this dashboard to:
566
567
567
568
### Compactions
568
569
569
-
The **Cassandra - Compactions** dashboard provides details of compactions.
570
+
The **Cassandra (Classic) - Compactions** dashboard provides details of compactions.
570
571
571
572
Use this dashboard to:
572
573
* Review pending/completed compactions and flushes.
@@ -575,7 +576,7 @@ Use this dashboard to:
575
576
576
577
### Garbage Collection
577
578
578
-
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.
579
+
The **Cassandra (Classic) - 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.
579
580
580
581
Use this dashboard to:
581
582
* Understand the garbage collection time. If the time keeps on increasing, you may have more CPU usage.
@@ -585,7 +586,7 @@ Use this dashboard to:
585
586
586
587
### Read Path
587
588
588
-
The **Cassandra - Read Path** dashboard shows read operation statistics.
| Cassandra - Increase in Authentication Failures | This alert fires when there is an increase of Cassandra authentication failures. | >5 | `<=`5 |
644
-
| Cassandra - Cache Hit Rate below 85 Percent | This alert fires when the cache key hit rate is below 85%. | `<`85 | `>=`85 |
645
-
| Cassandra - High Commitlog Pending Tasks | This alert fires when there are more than 15 Commitlog tasks that are pending. | >15 | `<=`15 |
646
-
| Cassandra - High Number of Compaction Executor Blocked Tasks | This alert fires when there are more than 15 compaction executor tasks blocked for more than 5 minutes. | >15 | `<=`15 |
647
-
| Cassandra - Compaction Task Pending | This alert fires when there are many Cassandra compaction tasks that are pending. You might need to increase I/O capacity by adding nodes to the cluster. | >100 | `<=`100 |
648
-
| Cassandra - High Number of Flush Writer Blocked Tasks | This alert fires when there is a high number of flush writer tasks which are blocked. | >15 | `<=`15 |
649
-
| Cassandra - Many Compaction Tasks Are Pending | Many Cassandra compaction tasks are pending | >100 | `<=`100 |
650
-
| Cassandra - Node Down | This alert fires when one or more Cassandra nodes are down | >0 | `<=`0 |
651
-
| Cassandra - Blocked Repair Tasks | This alert fires when the repair tasks are blocked | >2 | `<=`2 |
652
-
| Cassandra - Repair Tasks Pending | This alert fires when repair tasks are pending. | >2 | `<=`2 |
653
-
| Cassandra - High Tombstone Scanning | This alert fires when tombstone scanning is very high (>1000 99th Percentile) in queries. | >1000 | `<=`1000 |
644
+
| Cassandra (Classic) - Increase in Authentication Failures | This alert fires when there is an increase of Cassandra authentication failures. | >5 | `<=` 5 |
645
+
| Cassandra (Classic) - Cache Hit Rate below 85 Percent | This alert fires when the cache key hit rate is below 85%. | `<`85 | `>=` 85 |
646
+
| Cassandra (Classic) - High Commitlog Pending Tasks | This alert fires when there are more than 15 Commitlog tasks that are pending. | >15 | `<=` 15 |
647
+
| Cassandra (Classic) - High Number of Compaction Executor Blocked Tasks | This alert fires when there are more than 15 compaction executor tasks blocked for more than 5 minutes. | >15 | `<=` 15 |
648
+
| Cassandra (Classic) - Compaction Task Pending | This alert fires when there are many Cassandra compaction tasks that are pending. You might need to increase I/O capacity by adding nodes to the cluster. | >100 | `<=` 100 |
649
+
| Cassandra (Classic) - High Number of Flush Writer Blocked Tasks | This alert fires when there is a high number of flush writer tasks which are blocked. | >15 | `<=` 15 |
650
+
| Cassandra (Classic) - Many Compaction Tasks Are Pending | Many Cassandra compaction tasks are pending | >100 | `<=` 100 |
651
+
| Cassandra (Classic) - Node Down | This alert fires when one or more Cassandra nodes are down | >0 | `<=` 0 |
652
+
| Cassandra (Classic) - Blocked Repair Tasks | This alert fires when the repair tasks are blocked | >2 | `<=` 2 |
653
+
| Cassandra (Classic) - Repair Tasks Pending | This alert fires when repair tasks are pending. | >2 | `<=` 2 |
654
+
| Cassandra (Classic) - High Tombstone Scanning | This alert fires when tombstone scanning is very high (>1000 99th Percentile) in queries. | >1000 | `<=` 1000 |
Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, Manage Collectors capability depending upon the different content types part of the app.
4
+
:::
5
+
1. Select **App Catalog**.
6
+
1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it.
7
+
1. Click **Install App**.
8
+
:::note
9
+
Sometimes this button says **Add Integration**.
10
+
:::
11
+
1. Click **Next** in the **Setup Data** section.
12
+
1. In the **Configure** section of your respective app, complete the following fields.
13
+
1.**Field Name**. If you already have collectors and sources setup, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata **Field Value** .
14
+
2.**Is K8S deployment involved**. Specify if resources being monitored are partially or fully deployed on Kubernetes (K8s)
15
+
1. Click **Next**. You will be redirected to the **Preview & Done** section.
16
+
17
+
**Post-installation**
18
+
19
+
Once your app is installed, it will appear in your **Installed Apps** folder, and dashboard panels will start to fill automatically.
20
+
21
+
Each panel slowly fills with data matching the time range query and received since the panel was created. Results will not immediately be available, but will update with full graphs and charts over time.
0 commit comments