Skip to content

Commit dde2b09

Browse files
Addressing review comments from PR #5017
1 parent d3f313d commit dde2b09

File tree

11 files changed

+132
-53
lines changed

11 files changed

+132
-53
lines changed

docs/integrations/amazon-aws/dynamodb.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,12 +107,12 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**.
107107
2. Click **Save**.
108108

109109

110-
### Fields in Sumo Logic
110+
### Configure fields in Sumo Logic
111111

112-
Following fields will always be created automatically as a part of app installation process:
112+
As part of the app installation process, the following fields will created by default:
113113
* `tablename`
114114

115-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
115+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
116116

117117
### Field Extraction Rule(s)
118118

docs/integrations/databases/cassandra.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ The Sumo Logic app for Cassandra supports metrics generated by the [Jolokia2 plu
2828
This section provides instructions for configuring log and metric collection for the Sumo Logic app for Cassandra.
2929

3030

31-
### Step 1: Fields in Sumo Logic
31+
### Step 1: Configure fields in Sumo Logic
3232

33-
Following fields will always be created automatically as a part of app installation process:
33+
As part of the app installation process, the following fields will created by default:
3434
* `component`
3535
* `environment`
3636
* `db_system`
@@ -39,15 +39,15 @@ Following fields will always be created automatically as a part of app installat
3939
* `db_cluster_address`
4040
* `db_cluster_port`
4141

42-
If you're using Cassandra in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
42+
Additionally, if you are using Redis in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process:
4343
* `pod_labels_component`
4444
* `pod_labels_environment`
4545
* `pod_labels_db_system`
4646
* `pod_labels_db_cluster`
4747
* `pod_labels_db_cluster_address`
4848
* `pod_labels_db_cluster_port`
4949

50-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
50+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
5151

5252
### Step 2: Configure Collection for Cassandra
5353

@@ -246,7 +246,9 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra
246246
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
247247
6. Verify logs in Sumo Logic.
248248

249-
3. **FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityCassandraDatabaseFER**.
249+
250+
<br/>**FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityCassandraDatabaseFER**.
251+
<br/>
250252

251253
</TabItem>
252254
<TabItem value="non-k8s">
@@ -621,13 +623,20 @@ Use this dashboard to:
621623

622624
## Create monitors for Cassandra app
623625

626+
Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an 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, refer to the [Cassandra Alerts](/docs/integrations/databases/cassandra#cassandra-alerts).
627+
624628
import CreateMonitors from '../../reuse/apps/create-monitors.md';
625629

626630
<CreateMonitors/>
627631

632+
:::note
633+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Cassandra Alerts.
634+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
635+
:::
636+
637+
628638
### Cassandra Alerts
629639

630-
Sumo Logic has provided out-of-the-box alerts available via [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Cassandra cluster is available and performing as expected.
631640

632641
| Alert Name | Alert Description | Alert Condition | Recover Condition |
633642
|:-----------|:--------------|:-----------|:------------|

docs/integrations/databases/couchbase.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,23 +27,23 @@ Telegraf 1.14 default of Kubernetes Collection will not work.
2727

2828
This section provides instructions for configuring log and metric collection for the Sumo Logic app for Couchbase.
2929

30-
### Step 1: Fields in Sumo Logic
30+
### Step 1: Configure fields in Sumo Logic
3131

32-
Following fields will always be created automatically as a part of app installation process:
32+
As part of the app installation process, the following fields will created by default:
3333
* `component`
3434
* `environment`
3535
* `db_system`
3636
* `db_cluster`
3737
* `pod`
3838

39-
If you're using Couchbase in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
39+
Additionally, if you are using Redis in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process:
4040
* `pod_labels_component`
4141
* `pod_labels_environment`
4242
* `pod_labels_db_system`
4343
* `pod_labels_db_cluster`
4444

4545

46-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
46+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
4747

4848
### Step 2: Configure Collection for Couchbase
4949

@@ -182,7 +182,9 @@ This section explains the steps to collect Couchbase logs from a Kubernetes envi
182182
```
183183
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
184184
6. Verify logs in Sumo Logic.
185-
3. **FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityCouchbaseDatabaseFER**.
185+
186+
<br/>**FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityCouchbaseDatabaseFER**.
187+
<br/>
186188

187189
</TabItem>
188190
<TabItem value="non-k8s">
@@ -456,7 +458,7 @@ The **Couchbase - Events** dashboard provides insights into events from couchba
456458
Use this dashboard to:
457459
* To audit the activities happening in the cluster. This helps to determine what activities have occurred in the system, helping to control system security.
458460
459-
<img src={useBaseUrl('img/integrations/databases/Couchbase-Events.png')} alt="Cassandra dashboards" />
461+
<img src={useBaseUrl('img/integrations/databases/Couchbase-Events.png')} alt="Couchbase dashboards" />
460462
461463
### HTTP Access
462464
@@ -465,14 +467,21 @@ The **Couchbase - HTTP Access** dashboard provides insights into HTTP Rest API
465467
Use this dashboard to:
466468
* To understand user behavior accessing clusters and servers through Rest API.
467469
468-
<img src={useBaseUrl('img/integrations/databases/Couchbase-HTTP-Access.png')} alt="Cassandra dashboards" />
470+
<img src={useBaseUrl('img/integrations/databases/Couchbase-HTTP-Access.png')} alt="Couchbase dashboards" />
469471
470472
## Create monitors for Couchbase app
471473
474+
Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Couchbase 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, refer to the [Couchbase Alerts](/docs/integrations/databases/couchbase#couchbase-alerts).
475+
472476
import CreateMonitors from '../../reuse/apps/create-monitors.md';
473477
474478
<CreateMonitors/>
475479
480+
:::note
481+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Couchbase Alerts.
482+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
483+
:::
484+
476485
### Couchbase alerts
477486
478487
<table>

docs/integrations/databases/mariadb.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ This app is tested with the following MariaDB versions:
2222

2323
Configuring log and metric collection for the MariaDB app includes the following tasks.
2424

25-
### Step 1: Fields in Sumo Logic
25+
### Step 1: Configure fields in Sumo Logic
2626

27-
Following fields will always be created automatically as a part of app installation process:
27+
As part of the app installation process, the following fields will created by default:
2828
* `component`
2929
* `environment`
3030
* `db_system`
3131
* `db_cluster`
3232
* `db_cluster_address`
3333
* `db_cluster_port`
3434

35-
If you're using MariaDB in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
35+
Additionally, if you are using MariaDB in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process:
3636
* `pod_labels_component`
3737
* `pod_labels_environment`
3838
* `pod_labels_db_system`
@@ -41,7 +41,7 @@ If you're using MariaDB in a Kubernetes environment, these additional fields wil
4141
* `pod_labels_db_cluster_port`
4242

4343

44-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
44+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
4545

4646
### Step 2: Configure Collection
4747

@@ -183,9 +183,11 @@ This section explains the steps to collect MariaDB logs from a Kubernetes enviro
183183
```
184184
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
185185
6. Verify logs in Sumo Logic.
186-
3. **FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityMariaDBDatabaseFER**.
187186

188187

188+
<br/>**FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityMariaDBDatabaseFER**.
189+
<br/>
190+
189191
</TabItem>
190192
<TabItem value="non-k8s">
191193

@@ -526,10 +528,17 @@ Use this dashboard to:
526528

527529
## Create monitors for MariaDB app
528530

531+
Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an MariaDB 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, refer to the [MariaDB Alerts](/docs/integrations/databases/mariadb#mariadb-alerts).
532+
529533
import CreateMonitors from '../../reuse/apps/create-monitors.md';
530534

531535
<CreateMonitors/>
532536

537+
:::note
538+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the MariaDB Alerts.
539+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
540+
:::
541+
533542
### MariaDB alerts
534543

535544
| Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition |

docs/integrations/databases/memcached.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,22 @@ Jun 23 07:35:01 node03 memcached: \
5252

5353
Configuring log and metric collection for the Memcached app includes the following tasks.
5454

55-
### Step 1: Fields in Sumo Logic
55+
### Step 1: Configure fields in Sumo Logic
5656

57-
Following fields will always be created automatically as a part of app installation process:
57+
As part of the app installation process, the following fields will created by default:
5858
* `component`
5959
* `environment`
6060
* `db_system`
6161
* `db_cluster`
6262
* `pod`
6363

64-
If you're using Memcached in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
64+
Additionally, if you are using Memcached in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process:
6565
* `pod_labels_component`
6666
* `pod_labels_environment`
6767
* `pod_labels_db_system`
6868
* `pod_labels_db_cluster`
6969

70-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
70+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
7171

7272
### Step 2: Configure Logs and Metrics Collection for Memcached
7373

@@ -199,8 +199,9 @@ This section explains the steps to collect Memcached logs from a Kubernetes envi
199199
kubectl describe pod <Memcached_pod_name>
200200
```
201201
4. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
202-
3. **FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityMemcachedDatabaseFER**.
203202

203+
<br/> **FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityMemcachedDatabaseFER**.
204+
<br/>
204205
</TabItem>
205206
<TabItem value="non-k8s">
206207

@@ -361,10 +362,17 @@ The **Memcached - Logs** dashboard helps you quickly analyze your Memcached erro
361362
362363
## Create monitors for Memcached app
363364
365+
Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Memcached 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, refer to the [Memcached Alerts](/docs/integrations/databases/memcached#memcached-alerts).
366+
364367
import CreateMonitors from '../../reuse/apps/create-monitors.md';
365368
366369
<CreateMonitors/>
367370
371+
:::note
372+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Memcached Alerts.
373+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
374+
:::
375+
368376
### Memcached alerts
369377
<table>
370378
<tr>

docs/integrations/databases/mongodb.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,22 +71,22 @@ environment=* db_cluster=* db_system=mongodb | json "log" as _rawlog nodrop
7171

7272
This section provides instructions for configuring log and metric collection for the Sumo Logic app for MongoDB.
7373

74-
### Step 1: Fields in Sumo Logic
74+
### Step 1: Configure fields in Sumo Logic
7575

76-
Following fields will always be created automatically as a part of app installation process:
76+
As part of the app installation process, the following fields will created by default:
7777
* `component`
7878
* `environment`
7979
* `db_system`
8080
* `db_cluster`
8181

82-
If you're using MongoDB in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
82+
Additionally, if you are using Redis in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process:
8383
* `pod_labels_component`
8484
* `pod_labels_environment`
8585
* `pod_labels_db_system`
8686
* `pod_labels_db_cluster`
8787

8888

89-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
89+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
9090

9191

9292
### Step 2: Configure Collection for MongoDB
@@ -218,7 +218,8 @@ Pivoting to Tracing data from Entity Inspector is possible only for “MongoDB a
218218
```
219219
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
220220

221-
3. **FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityMongoDBDatabaseFER**.
221+
<br/>**FER to normalize the fields in Kubernetes environments.** Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we will have Field Extraction Rule automatically created for Database Application Components named as **AppObservabilityMongoDBDatabaseFER**.
222+
<br/>
222223

223224
</TabItem>
224225
<TabItem value="non-k8s">
@@ -460,10 +461,17 @@ Use this dashboard to:
460461

461462
## Create monitors for MongoDB app
462463

464+
Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an MongoDB 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, refer to the [MongoDB Alerts](/docs/integrations/databases/mongodb#mongodb-alerts).
465+
463466
import CreateMonitors from '../../reuse/apps/create-monitors.md';
464467

465468
<CreateMonitors/>
466469

470+
:::note
471+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Couchbase Alerts.
472+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
473+
:::
474+
467475
### MongoDB alerts
468476

469477
| Name | Description | Trigger Type | Alert Conditions | Recover Conditions |

0 commit comments

Comments
 (0)