Skip to content

Commit ba035b0

Browse files
authored
Update cassandra-opentelemetry.md
1 parent bef13ee commit ba035b0

File tree

1 file changed

+26
-37
lines changed

1 file changed

+26
-37
lines changed

docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md

Lines changed: 26 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
id: cassandra-opentelemetry
33
title: Cassandra - OpenTelemetry Collector
44
sidebar_label: Cassandra - OTel Collector
5-
description: Learn about the Sumo Logic OpenTelemetry App for Cassandra.
5+
description: Learn about the Sumo Logic OpenTelemetry app for Cassandra.
66
---
77

88
import useBaseUrl from '@docusaurus/useBaseUrl';
@@ -15,7 +15,7 @@ The [Cassandra](https://cassandra.apache.org/_/cassandra-basics.html) app is a l
1515

1616
Cassandra logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) and cassandra metrics are sent to Sumo Logic using [JMX opentelemetry receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) with the `target_system` set as [`cassandra`](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/cassandra.md).
1717

18-
The app supports Logs from the open-source version of Cassandra. The App is tested on the 4.0.0 version of Cassandra.
18+
The app supports logs from the open-source version of Cassandra. The app is tested on the 4.0.0 version of Cassandra.
1919

2020
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Schematics.png' alt="Schematics" />
2121

@@ -40,17 +40,17 @@ Following are the [Fields](/docs/manage/fields/) which will be created as part o
4040
JMX receiver collects Cassandra metrics from Cassandra server as part of the OpenTelemetry Collector (OTC).
4141

4242
1. Follow the instructions in [JMX - OpenTelemetry's prerequisites section](/docs/integrations/app-development/opentelemetry/jmx-opentelemetry/#prerequisites) to download the [JMX Metric Gatherer](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/README.md). This gatherer is used by the [JMX Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver#details).
43-
4443
2. Set the JMX port as part of `JAVA_OPTS` for Tomcat startup. Usually, it is set in the `/etc/systemd/system/cassandra.service` or `C:\Program Files\apache-tomcat\bin\tomcat.bat` file.
4544

4645
```json
4746
JAVA_OPTS="$JAVA_OPTS -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=11099 -Dcom.sun.management.jmxremote.authenticate=true -Dcom.sun.management.jmxremote.ssl=false -Dcom.sun.management.jmxremote.password.file=${CASSANDRA_CONF_DIR}/jmx.password -Dcom.sun.management.jmxremote.access.file=${CASSANDRA_CONF_DIR}/jmx.access"
4847
```
4948

5049
#### For log collection
51-
Cassandra has three main logs: system.log, debug.log, and gc.log which hold general logging messages, debugging logging messages, and java garbage collection logs respectively.
5250

53-
These logs by default live in `${CASSANDRA_HOME}/logs`, but most Linux distributions relocate logs to `/var/log/cassandra`. Operators can tune this location as well as what levels are logged using the provided logback.xml file. For more details on Cassandra logs, see[ this](https://cassandra.apache.org/doc/latest/troubleshooting/reading_logs.html) link.
51+
Cassandra has three main logs: `system.log`, `debug.log`, and `gc.log`, which hold general logging messages, debugging logging messages, and java garbage collection logs respectively.
52+
53+
These logs by default live in `${CASSANDRA_HOME}/logs`, but most Linux distributions relocate logs to `/var/log/cassandra`. Operators can tune this location as well as what levels are logged using the provided logback.xml file. For more details on Cassandra logs, see [this](https://cassandra.apache.org/doc/latest/troubleshooting/reading_logs.html).
5454

5555
import LogsCollectionPrereqisites from '../../../reuse/apps/logs-collection-prereqisites.md';
5656

@@ -82,7 +82,7 @@ You can add any custom fields which you want to be tagged with the data ingested
8282

8383
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
8484

85-
### Step 3: Send logs to Sumo
85+
### Step 3: Send logs to Sumo Logic
8686

8787
import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md';
8888

@@ -137,7 +137,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md';
137137

138138
<LogsOutro/>
139139

140-
## Sample log messages
140+
## Sample log message
141141

142142
```sql
143143
INFO [ScheduledTasks:1] 2023-01-08 09:18:47,347 StatusLogger.java:101 - system.schema_aggregates
@@ -180,7 +180,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md';
180180
}
181181
```
182182

183-
## Sample log queries 
183+
## Sample log query 
184184

185185
Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Nodes Up panel:
186186

@@ -195,6 +195,7 @@ Following is a query from the Cassandra app's **Cassandra - Overview** dashboard
195195
```
196196

197197
## Sample metrics query
198+
198199
Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel:
199200

200201
```sql
@@ -209,20 +210,15 @@ The **Cassandra - Overview** dashboard provides an at-a-glance view of Cassandra
209210

210211
Use this dashboard to:
211212

212-
- Identify number of nodes which are up and down
213-
- Gain insights into Memory - Init, used, Max and committed
214-
- Gain insights into the error and warning logs by thread and Node activity
213+
- Identify number of nodes which are up and down.
214+
- Gain insights into Memory - Init, used, Max, and committed.
215+
- Gain insights into the error and warning logs by thread and Node activity.
215216

216217
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Overview.png' alt="Collector" />
217218

218219
### Cache Stats
219220

220-
The **Cassandra - Cache Stats** dashboard provides insight into the database cache status, schedule, and items.
221-
222-
Use this dashboard to:
223-
224-
- Monitor Cache performance.
225-
- Identify Cache usage statistics.
221+
The **Cassandra - Cache Stats** dashboard provides insight into the database cache status, schedule, and items. Use this dashboard to monitor cache performance and identify cache usage statistics.
226222

227223
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Cache-Stats.png' alt="Cache Stats" />
228224

@@ -250,32 +246,26 @@ Use this dashboard to:
250246

251247
### Memtable
252248

253-
The **Cassandra - Memtable** dashboard provides insights into memtable statistics.
254-
255-
Use this dashboard to:
256-
257-
- Review flush activity and memtable status.
249+
The **Cassandra - Memtable** dashboard provides insights into memtable statistics. Use this dashboard to review flush activity and memtable status.
258250

259251
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Memtable.png' alt="Memtable" />
260252

261253
### Resource Usage
262254

263-
The **Cassandra - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters.
264-
265-
Use this dashboard to:
266-
267-
- Identify resource utilization. This can help you to determine whether resources are over-allocated or under-allocated.
255+
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 whether resources are over-allocated or under-allocated.
268256

269257
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Resource-Usage-Logs.png' alt="Resource Usage" />
270258

271259
### Compaction
272260

273261
The **Cassandra - Compactions** dashboard provides insight into the completed and pending compaction tasks.
262+
274263
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Compaction.png' alt="Compaction" />
275264

276265
### Requests
277266

278267
The **Cassandra - Requests** dashboard provides insight into the number of request served, number of error request, and their distribution by status and operation. Also you can monitor the read and write latency of the cluster instance using this dashboard.
268+
279269
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Requests.png' alt="Requests" />
280270

281271
### Storage
@@ -284,7 +274,6 @@ The **Cassandra - Storage** dashboard provides insight into the current value of
284274

285275
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-Storage.png' alt="Storage" />
286276

287-
288277
## Create monitors for Cassandra app
289278

290279
import CreateMonitors from '../../../reuse/apps/create-monitors.md';
@@ -295,12 +284,12 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
295284

296285
| Name | Description | Alert Condition | Recover Condition |
297286
|:--|:--|:--|:--|
298-
| `Cassandra - Compaction Task Pending` | This alert is triggered when there are more than 15 Compaction tasks which are pending. | Count `>=` 15 | Count `<` 15 |
299-
| `Cassandra - High Hints Backlog` | This alert is triggered when the number of in-progress hints exceeds given value (Default 5000) for 5 minutes. | Count `>=` 5000 | Count `<` 5000 |
300-
| `Cassandra - High Memory Usage` | This alert is triggered when memory used exceeds 85% of committed memory for more than 10 minutes. | Count `>=` 1 | Count `<` 1 |
301-
| `Cassandra - Node Down Alert` | This alert is triggered when a Cassandra node status changes to DOWN for more than 5 minutes. | Count `>=` 1 | Count `<` 1 |
302-
| `Cassandra - Operation Error Rate High` | This alert is triggered when the error rate of operations exceeds given value (Default 5%) for 5 minutes. | Count `>` 5 | Count `<=` 5 |
303-
| `Cassandra - Range Query Latency High (99th Percentile)` | This alert is triggered when the 99th percentile of range query latency exceeds the given value (Default 2 seconds) for 5 minutes. | Count `>=` 2000000 | Count `<` 2000000 |
304-
| `Cassandra - Read Latency High (99th Percentile)` | This alert is triggered when the 99th percentile of read latency exceeds given value (Default 500ms) for 5 minutes. | Count `>=` 500000 | Count `<` 500000 |
305-
| `Cassandra - Storage Growth Rate Abnormal` | This alert is triggered when the storage growth rate exceeds given value (Default 25MB/minute) for 5 minutes. | Count `>=` 26214400 | Count `<` 26214400 |
306-
| `Cassandra - Write Latency High (99th Percentile)` | This alert is triggered when the 99th percentile of write latency exceeds given value (Default 200ms) for 5 minutes. | Count `>=` 200000 | Count `<` 200000 |
287+
| `Cassandra - Compaction Task Pending` | This alert is triggered when there are more than 15 pending Compaction tasks. | Count > = 15 | Count < 15 |
288+
| `Cassandra - High Hints Backlog` | This alert is triggered when the number of in-progress hints exceeds the given value for 5 minutes. | Count > = 5000 | Count < 5000 |
289+
| `Cassandra - High Memory Usage` | This alert is triggered when memory used exceeds 85% of committed memory for more than 10 minutes. | Count > = 1 | Count < 1 |
290+
| `Cassandra - Node Down Alert` | This alert is triggered when a Cassandra node status changes to DOWN for more than 5 minutes. | Count > = 1 | Count < 1 |
291+
| `Cassandra - Operation Error Rate High` | This alert is triggered when the error rate of operations exceeds given value (Default 5%) for 5 minutes. | Count > 5 | Count < = 5 |
292+
| `Cassandra - Range Query Latency High (99th Percentile)` | This alert is triggered when the 99th percentile of range query latency exceeds the given value (Default 2 seconds) for 5 minutes. | Count > = 2000000 | Count < 2000000 |
293+
| `Cassandra - Read Latency High (99th Percentile)` | This alert is triggered when the 99th percentile of read latency exceeds given value (Default 500ms) for 5 minutes. | Count > = 500000 | Count < 500000 |
294+
| `Cassandra - Storage Growth Rate Abnormal` | This alert is triggered when the storage growth rate exceeds given value (Default 25MB/minute) for 5 minutes. | Count > = 26214400 | Count < 26214400 |
295+
| `Cassandra - Write Latency High (99th Percentile)` | This alert is triggered when the 99th percentile of write latency exceeds given value (Default 200ms) for 5 minutes. | Count > = 200000 | Count < 200000 |

0 commit comments

Comments
 (0)