Skip to content

Commit 87a12b3

Browse files
authored
Update strimzi-kafka.md
1 parent e7b328f commit 87a12b3

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

docs/integrations/containers-orchestration/strimzi-kafka.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ This App has been tested with the following Kafka Operator versions:
2121
This App has been tested with the following Kafka versions:
2222
* 3.4.0
2323

24-
2524
## Sample log messages
2625

2726
```json
@@ -48,14 +47,13 @@ messaging_cluster=* messaging_system="kafka" \
4847

4948
The list of metrics collected can be found [here](/docs/integrations/containers-orchestration/kafka/#kafka-metrics).
5049

51-
52-
## Collecting logs and metrics for Strimzi Kafka Pods
50+
## Collecting logs and metrics for Strimzi Kafka pods
5351

5452
Collection architecture is similar to Kafka and described [here](/docs/integrations/containers-orchestration/strimzi-kafka/#collecting-logs-and-metrics-for-strimzi-kafka-pods).
5553

5654
This section provides instructions for configuring log and metric collection for the Sumo Logic App for Strimzi Kafka.
5755

58-
### Prerequisites for Kafka Cluster Deployment
56+
### Prerequisites for Kafka cluster deployment
5957

6058
Before configuring the collection, you will require the following items:
6159

@@ -65,7 +63,7 @@ Before configuring the collection, you will require the following items:
6563

6664
3. Download the [kafka-metrics-sumologic-telegraf.yaml](https://drive.google.com/file/d/1pvMqYiJu7_nEv2F2RsPKIn_WWs8BKcxQ/view?usp=sharing). If you already have an existing yaml, you will have to merge the contents of both files. This file contains the Kafka resource.
6765

68-
### Deploying Sumo Logic Kubernetes Collection
66+
### Deploying Sumo Logic Kubernetes collection
6967

7068
1. Create a new namespace to deploy resources. The below command creates a **sumologiccollection** namespace.
7169

@@ -92,7 +90,7 @@ Before configuring the collection, you will require the following items:
9290

9391
A collector will be created in your Sumo Logic org with the cluster name provided in the above command. You can verify it by referring to the [collection page](/docs/send-data/collection/).
9492

95-
### Configure Metrics Collection
93+
### Configure metrics collection
9694

9795
Follow these steps to collect metrics from a Kubernetes environment:
9896

@@ -143,8 +141,7 @@ Follow these steps to collect metrics from a Kubernetes environment:
143141

144142
For more information on configuring the Joloka input plugin for Telegraf, see [this doc](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/jolokia2).
145143

146-
147-
### Configure Logs Collection
144+
### Configure logs collection
148145
If your Kafka helm chart/pod is writing the logs to standard output, then the [Sumologic Kubernetes Collection](/docs/integrations/containers-orchestration/kubernetes/#collecting-metrics-and-logs-for-the-kubernetes-app) will automatically capture the logs from stdout and will send the logs to Sumologic. If no, then you have to use [tailing-sidecar](https://github.com/SumoLogic/tailing-sidecar/blob/main/README.md) approach.
149146

150147
1. **Add labels on your Kafka pods**
@@ -177,16 +174,15 @@ If your Kafka helm chart/pod is writing the logs to standard output, then the [S
177174

178175
<img src={useBaseUrl('img/integrations/containers-orchestration/appobservability-messaging-fer.png')} alt="Sumo Logic FER"/>
179176

180-
### Deploying Kafka Pods
177+
### Deploying Kafka pods
181178

182179
After updating **kafka-metrics-sumologic-telegraf.yaml**, you can use the below command to deploy the Kafka pods
183180

184181
```bash
185182
kubectl apply -f kafka-metrics-sumologic-telegraf.yaml -n <<NAMESPACE>>
186183
```
187184

188-
189-
### Deployment Verification
185+
### Deployment verification
190186

191187
1. Make sure that the Kafka pods are running and correct annotations/labels are applied by using the command:
192188
```bash
@@ -233,8 +229,7 @@ If your Kafka helm chart/pod is writing the logs to standard output, then the [S
233229
values: ["sumologiccollection"]
234230
```
235231
236-
237-
## Installing the Kafka App
232+
## Installing the Kafka app
238233
239234
import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md';
240235
@@ -253,7 +248,7 @@ Additionally, if you're using Squid Proxy in the Kubernetes environment, the fol
253248
* `pod_labels_messaging_system`
254249
* `pod_labels_messaging_cluster`
255250

256-
## Viewing the Kafka Dashboards
251+
## Viewing the Kafka dashboards
257252

258253
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
259254

@@ -270,7 +265,6 @@ Use this dashboard to:
270265

271266
<img src={useBaseUrl('img/integrations/containers-orchestration/kafka-cluster-overview.png')} alt="Kafka dashboards" />
272267

273-
274268
### Strimzi Kafka - Outlier Analysis
275269

276270
The **Strimzi Kafka - Outlier Analysis** dashboard helps you identify outliers for key metrics across your Kafka clusters.
@@ -280,7 +274,6 @@ Use this dashboard to:
280274

281275
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Outlier-Analysis.png')} alt="Kafka dashboards" />
282276

283-
284277
### Strimzi Kafka - Replication
285278

286279
The Strimzi Kafka - Replication dashboard helps you understand the state of replicas in your Kafka clusters.
@@ -296,7 +289,6 @@ Use this dashboard to monitor the following key metrics:
296289

297290
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Replication.png')} alt="Kafka dashboards" />
298291

299-
300292
### Strimzi Kafka - Zookeeper
301293

302294
The **Strimzi Kafka -Zookeeper** dashboard provides an at-a-glance view of the state of your partitions, active controllers, leaders, throughput, and network across Kafka brokers and clusters.
@@ -323,7 +315,6 @@ Use this dashboard to:
323315

324316
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Broker.png')} alt="Kafka dashboards" />
325317

326-
327318
### Strimzi Kafka - Failures and Delayed Operations
328319

329320
The **Strimzi Kafka - Failures and Delayed Operations** dashboard gives you insight into all failures and delayed operations associated with your Kafka clusters.
@@ -340,7 +331,6 @@ Use this dashboard to:
340331

341332
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Failures-Delayed-Operations.png')} alt="Kafka dashboards" />
342333

343-
344334
### Strimzi Kafka - Request-Response Times
345335

346336
The **Strimzi Kafka - Request-Response** **Times** dashboard helps you get insight into key request and response latencies of your Kafka cluster.
@@ -397,7 +387,6 @@ Use this dashboard to:
397387

398388
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Broker-Memory.png')} alt="Kafka dashboards" />
399389

400-
401390
### Kafka Broker - Disk Usage
402391

403392
The **Kafka Broker - Disk Usage** dashboard helps monitor disk usage across your Kafka Brokers.
@@ -421,7 +410,6 @@ Use this dashboard to:
421410

422411
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Broker-Garbage-Collection.png')} alt="Kafka dashboards" />
423412

424-
425413
### Kafka Broker - Threads
426414

427415
The **Kafka Broker - Threads** dashboard shows the key insights into the usage and type of threads created in your Kafka broker JVM
@@ -443,7 +431,6 @@ Use this dashboard to:
443431

444432
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Broker-Class-Loading-Compilation.png')} alt="Kafka dashboards" />
445433

446-
447434
### Strimzi Kafka - Topic Overview
448435

449436
The Strimzi Kafka - Topic Overview dashboard helps you quickly identify under-replicated partitions and incoming bytes by Kafka topic, server, and cluster.
@@ -459,8 +446,6 @@ Use this dashboard to:
459446

460447
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Topic-Overview.png')} alt="Kafka dashboards" />
461448

462-
463-
464449
### Strimzi Kafka - Topic Details
465450

466451
The Strimzi Kafka - Topic Details dashboard gives you insight into throughput, partition sizes, and offsets across Kafka brokers, topics, and clusters.

0 commit comments

Comments
 (0)