Skip to content

Commit b13a656

Browse files
Fix monitors and install section in activemq, kafka, rabbitmq
1 parent 316a2b1 commit b13a656

File tree

3 files changed

+80
-128
lines changed

3 files changed

+80
-128
lines changed

docs/integrations/containers-orchestration/activemq.md

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -51,27 +51,7 @@ Host: broker-3-activemq Name: /opt/activemq/data/activemq.log Category:logfile
5151
This App has been tested with following ActiveMQ versions:
5252
* 5.16.2.
5353

54-
### Step 1: Configure fields in Sumo Logic
55-
56-
Configuring log and metric collection for the ActiveMQ app includes the following tasks:
57-
58-
The following [fields](/docs/manage/fields/) will always be created automatically as a part of the app installation process:
59-
* `component`
60-
* `environment`
61-
* `messaging_system`
62-
* `messaging_cluster`
63-
* `pod`
64-
65-
If you're using ActiveMQ in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
66-
* `pod_labels_component`
67-
* `pod_labels_environment`
68-
* `pod_labels_messaging_system`
69-
* `pod_labels_messaging_cluster`
70-
71-
For information on setting up fields, see [Fields](/docs/manage/fields).
72-
73-
74-
### Step 2: Configure ActiveMQ logs and metrics collection
54+
### Configure ActiveMQ logs and metrics collection
7555

7656
Choose your environment:
7757

@@ -419,35 +399,31 @@ At this point, ActiveMQ logs should start flowing into Sumo Logic.
419399
</TabItem>
420400
</Tabs>
421401

402+
## Installing the ActiveMQ app
422403

423-
## ActiveMQ monitors
424-
425-
import CreateMonitors from '../../reuse/apps/create-monitors.md';
404+
import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md';
426405

427-
<CreateMonitors/>
428-
There are limits to how many alerts can be enabled.
406+
<AppInstall2/>
429407

430-
:::note permissions required
431-
To install these monitors, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
432-
:::
408+
As part of the app installation process, the following fields will be created by default:
409+
* `component`
410+
* `environment`
411+
* `messaging_system`
412+
* `messaging_cluster`
413+
* `pod`
433414

434-
### ActiveMQ alerts
415+
If you're using ActiveMQ in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
416+
* `pod_labels_component`
417+
* `pod_labels_environment`
418+
* `pod_labels_messaging_system`
419+
* `pod_labels_messaging_cluster`
435420
436-
| Alert Name | Alert Description and conditions | Alert Condition | Recover Condition |
437-
|:--|:--|:--|:--|
438-
| `ActiveMQ - High CPU Usage Alert` | This alert gets triggered when CPU usage on a node in a ActiveMQ cluster is high. | Count >= 80 | Count < 80 |
439-
| `ActiveMQ - High Memory Usage Alert` | This alert gets triggered when memory usage on a node in a ActiveMQ cluster is high. | Count >= 80 | Count < 80 |
440-
| `ActiveMQ - High Storage Used Alert` | This alert gets triggered when there is high store usage on a node in a ActiveMQ cluster. | Count >= 80 | Count < 80 |
441-
| `ActiveMQ - Maximum Connection Alert` | This alert gets triggered when one node in ActiveMQ cluster exceeds the maximum allowed client connection limit. | Count >= 1 | Count < 1 |
442-
| `ActiveMQ - No Consumers on Queues Alert` | This alert gets triggered when a ActiveMQ queue has no consumers. | Count < 1 | Count >= 1 |
443-
| `ActiveMQ - Node Down Alert` | This alert gets triggered when a node in the ActiveMQ cluster is down. | Count >= 1 | Count < 1 |
444-
| `ActiveMQ - Too Many Connections Alert` | This alert gets triggered when there are too many connections to a node in a ActiveMQ cluster. | Count >= 1000 | Count < 1000 |
445421
446422
## Viewing the ActiveMQ Dashboards
447423
448-
### Dashboard Filters with Template Variables
424+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
449425
450-
Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the [Filter with template variables](/docs/dashboards/filter-template-variables.md) help page.
426+
<ViewDashboards/>
451427
452428
### Overview
453429
@@ -530,3 +506,21 @@ Use this dashboard to:
530506
* Quickly determine patterns across all logs in a given ActiveMQ cluster.
531507
532508
<img src={useBaseUrl('img/integrations/containers-orchestration/activemq-images.png')} alt="ActiveMQ dashboards" />
509+
510+
## Create monitors for ActiveMQ app
511+
512+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
513+
514+
<CreateMonitors/>
515+
516+
### ActiveMQ alerts
517+
518+
| Alert Name | Alert Description and conditions | Alert Condition | Recover Condition |
519+
|:--|:--|:--|:--|
520+
| `ActiveMQ - High CPU Usage Alert` | This alert gets triggered when CPU usage on a node in a ActiveMQ cluster is high. | Count >= 80 | Count < 80 |
521+
| `ActiveMQ - High Memory Usage Alert` | This alert gets triggered when memory usage on a node in a ActiveMQ cluster is high. | Count >= 80 | Count < 80 |
522+
| `ActiveMQ - High Storage Used Alert` | This alert gets triggered when there is high store usage on a node in a ActiveMQ cluster. | Count >= 80 | Count < 80 |
523+
| `ActiveMQ - Maximum Connection Alert` | This alert gets triggered when one node in ActiveMQ cluster exceeds the maximum allowed client connection limit. | Count >= 1 | Count < 1 |
524+
| `ActiveMQ - No Consumers on Queues Alert` | This alert gets triggered when a ActiveMQ queue has no consumers. | Count < 1 | Count >= 1 |
525+
| `ActiveMQ - Node Down Alert` | This alert gets triggered when a node in the ActiveMQ cluster is down. | Count >= 1 | Count < 1 |
526+
| `ActiveMQ - Too Many Connections Alert` | This alert gets triggered when there are too many connections to a node in a ActiveMQ cluster. | Count >= 1000 | Count < 1000 |

docs/integrations/containers-orchestration/kafka.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,6 @@ messaging_cluster=* messaging_system="kafka" \
6767

6868
This section provides instructions for configuring log and metric collection for the Sumo Logic App for Kafka.
6969

70-
### Step 1: Configure fields in Sumo Logic
71-
72-
The following [fields](/docs/manage/fields/) will always be created automatically as a part of the app installation process:
73-
* `component`
74-
* `environment`
75-
* `messaging_system`
76-
* `messaging_cluster`
77-
* `pod`
78-
79-
If you're using Kafka in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
80-
* `pod_labels_component`
81-
* `pod_labels_environment`
82-
* `pod_labels_messaging_system`
83-
* `pod_labels_messaging_cluster`
84-
85-
For information on setting up fields, see [Fields](/docs/manage/fields).
86-
8770
### Configure collection for Kafka
8871

8972
Sumo Logic supports collection of logs and metrics data from Kafka in both Kubernetes and non-Kubernetes environments.
@@ -354,33 +337,28 @@ At this point, Kafka metrics and logs should start flowing into Sumo Logic.
354337

355338
## Installing the Kafka app
356339

357-
This section demonstrates how to install the Kafka App.
358-
359-
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**.
340+
import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md';
360341

361-
1. From the **App Catalog**, search for and select the app.
362-
2. Select the version of the service you're using and click **Add to Library**. :::note
363-
Version selection is not available for all apps.
364-
:::
365-
3. To install the app, complete the following fields.
366-
* **App Name.** You can retain the existing name, or enter a name of your choice for the app.
367-
* **Data Source.** Choose **Enter a Custom Data Filter**, and enter a custom Kafka cluster filter. Examples:
368-
* For all Kafka clusters `messaging_cluster=*`
369-
* For a specific cluster: `messaging_cluster=Kafka.dev.01`.
370-
* Clusters within a specific environment: `messaging_cluster=Kafka-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection.
371-
4. **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
372-
5. Click **Add to Library**.
373-
374-
When 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.
342+
<AppInstall2/>
375343

376-
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.
344+
As part of the app installation process, the following fields will be created by default:
345+
* `component`
346+
* `environment`
347+
* `messaging_system`
348+
* `messaging_cluster`
349+
* `pod`
377350

351+
If you're using Kafka in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
352+
* `pod_labels_component`
353+
* `pod_labels_environment`
354+
* `pod_labels_messaging_system`
355+
* `pod_labels_messaging_cluster`
378356

379357
## Viewing the Kafka Dashboards
380358

381-
### Filters with Template Variables
359+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
382360

383-
Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the Filter with template variables help page.
361+
<ViewDashboards/>
384362

385363

386364
### Kafka - Cluster Overview
@@ -598,7 +576,13 @@ Use this dashboard to:
598576
<img src={useBaseUrl('img/integrations/containers-orchestration/Kafka-Topic-Details.png')} alt="Kafka dashboards" />
599577

600578

601-
## Kafka alerts
579+
## Create monitors for Kafka app
580+
581+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
582+
583+
<CreateMonitors/>
584+
585+
### Kafka alerts
602586

603587
#### Pre-packaged alerts
604588

docs/integrations/containers-orchestration/rabbitmq.md

Lines changed: 23 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -50,24 +50,7 @@ Host: broker-1 Name: /var/log/rabbitmq/rabbit.log Category: logfile
5050

5151
This section provides instructions for configuring log and metric collection for the Sumo Logic App for RabbitMQ.
5252

53-
### Step 1: Configure fields in Sumo Logic
54-
55-
The following [fields](/docs/manage/fields/) are created automatically as a part of the app installation process:
56-
* `component`
57-
* `environment`
58-
* `messaging_system`
59-
* `messaging_cluster`
60-
* `pod`
61-
62-
If you're using RabbitMQ in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
63-
* `pod_labels_component`
64-
* `pod_labels_environment`
65-
* `pod_labels_messaging_system`
66-
* `pod_labels_messaging_cluster`
67-
68-
For information on setting up fields, see [Fields](/docs/manage/fields).
69-
70-
### Step 2: Configure collection for RabbitMQ
53+
### Configure collection for RabbitMQ
7154

7255
Sumo Logic supports collection of logs and metrics data from RabbitMQ in both Kubernetes and non-Kubernetes environments.
7356

@@ -324,44 +307,30 @@ At this point, RabbitMQ logs should start flowing into Sumo Logic.
324307
</TabItem>
325308
</Tabs>
326309
327-
## RabbitMQ monitors
328-
329-
import CreateMonitors from '../../reuse/apps/create-monitors.md';
330-
331-
<CreateMonitors/>
332-
333-
There are limits to how many alerts can be enabled.
334-
335-
:::note permissions required
336-
To install these monitors, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
337-
:::
338310
## Installing the RabbitMQ App
339311
340-
This section demonstrates how to install the RabbitMQ App.
312+
import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md';
341313
342-
1. From the **App Catalog**, search for and select the RabbitMQ app.
343-
2. Select the version of the service you're using and click **Add to Library**.
344-
:::note
345-
Version selection is not available for all apps.
346-
:::
347-
3. To install the app, complete the following fields.
348-
1. **App Name.** You can retain the existing name, or enter a name of your choice for the app.
349-
2. **Data Source.** Choose **Enter a Custom Data Filter**, and enter a custom RabbitMQ cluster filter. Examples:
350-
1. For all RabbitMQ clusters: `messaging_cluster=*`
351-
2. For a specific cluster: `messaging_cluster=rabbitmq.dev.01`
352-
3. Clusters within a specific environment: `messaging_cluster=rabbitmq-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection.
353-
4. **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
354-
5. Click **Add to Library**.
314+
<AppInstall2/>
355315
356-
Once an app is installed, it will appear in your **Personal** folder, or other folder that you specified. From here, you can share it with your organization.
316+
As part of the app installation process, the following fields will be created by default:
317+
* `component`
318+
* `environment`
319+
* `messaging_system`
320+
* `messaging_cluster`
321+
* `pod`
357322
358-
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.
323+
If you're using RabbitMQ in a Kubernetes environment, the following additional fields will be automatically created as a part of the app installation process:
324+
* `pod_labels_component`
325+
* `pod_labels_environment`
326+
* `pod_labels_messaging_system`
327+
* `pod_labels_messaging_cluster`
359328

360-
## Viewing RabbitMQ Dashboards
329+
## Viewing the RabbitMQ Dashboards
361330

362-
#### Dashboard Filters with Template Variables
331+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
363332

364-
Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the Filter with template variables help page.
333+
<ViewDashboards/>
365334

366335

367336
### Overview
@@ -433,8 +402,13 @@ Use this dashboard to:
433402
<img src={useBaseUrl('img/integrations/containers-orchestration/RabbitMQ-Logs.png')} alt="RabbitMQ dashboards" />
434403

435404

405+
## Create monitors for RabbitMQ app
406+
407+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
408+
409+
<CreateMonitors/>
436410

437-
## RabbitMQ Alerts
411+
### RabbitMQ Alerts
438412

439413
Sumo Logic provides out-of-the-box alerts available via [Sumo Logic monitors](/docs/alerts/monitors). These alerts are built based on logs and metrics datasets and have preset thresholds based on industry best practices and recommendations.
440414

0 commit comments

Comments
 (0)