Skip to content

Commit e9b4d39

Browse files
Updating V2 Migrated Database apps docs to standard pattern
1 parent 4b32c89 commit e9b4d39

File tree

12 files changed

+310
-459
lines changed

12 files changed

+310
-459
lines changed

docs/integrations/databases/cassandra.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -474,9 +474,7 @@ At this point, Cassandra metrics and logs should start flowing into Sumo Logic.
474474
This step is not needed if you are using the [Application Components Solution](/docs/observability/application-components) Terraform script.
475475
:::
476476

477-
This section demonstrates how to install the Cassandra app.
478-
479-
import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md';
477+
import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md';
480478

481479
<AppInstall2 />
482480

@@ -624,18 +622,10 @@ Use this dashboard to:
624622
625623
## Create monitors for Cassandra app
626624
627-
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).
628-
629625
import CreateMonitors from '../../reuse/apps/create-monitors.md';
630626
631627
<CreateMonitors/>
632628
633-
:::note
634-
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Cassandra Alerts.
635-
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
636-
:::
637-
638-
639629
### Cassandra Alerts
640630
641631

docs/integrations/databases/couchbase.md

Lines changed: 24 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,7 @@ 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: Configure fields in Sumo Logic
31-
32-
As part of the app installation process, the following fields will be created by default:
33-
* `component`
34-
* `environment`
35-
* `db_system`
36-
* `db_cluster`
37-
* `pod`
38-
39-
Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
40-
* `pod_labels_component`
41-
* `pod_labels_environment`
42-
* `pod_labels_db_system`
43-
* `pod_labels_db_cluster`
44-
45-
46-
For information on setting up fields, see [Fields](/docs/manage/fields).
47-
48-
### Step 2: Configure Collection for Couchbase
30+
### Configure Collection for Couchbase
4931

5032
Sumo Logic supports the collection of logs and metrics data from Couchbase in both Kubernetes and non-Kubernetes environments. Click on the appropriate tab below based on the environment where your Couchbase clusters are hosted.
5133

@@ -346,32 +328,35 @@ At this point, Telegraf should start collecting the Couchbase metrics and forwar
346328
347329
This section demonstrates how to install the Couchbase app.
348330
349-
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**.
331+
import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md';
332+
333+
<AppInstall2 />
350334
351-
1. From the **App Catalog**, search and select the app.
352-
2. Select the version of the service you're using and click **Add to Library**.
353-
:::note
354-
Version selection is not available for all apps.
355-
:::
356-
3. To install the app, complete the following fields.
357-
1. **App Name.** You can retain the existing name, or enter a name of your choice for the app.
358-
2. **Data Source.**
359-
* Choose **Enter a Custom Data Filter**, and enter a custom Couchbase cluster filter. Examples:
360-
1. For all Couchbase clusters `db_cluster=*`
361-
2. For a specific cluster: `db_cluster=couchbase.dev.01`
362-
3. Clusters within a specific environment: `db_cluster=couchbase.dev.01` and `environment=prod`. This assumes you have set the optional environment tag while configuring collection.
363-
3. **Advanced**. Select the **Location in the Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
364-
4. Click **Add to Library**.
365335
366-
Once 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.
336+
As part of the app installation process, the following fields will be created by default:
337+
* `component`
338+
* `environment`
339+
* `db_system`
340+
* `db_cluster`
341+
* `pod`
342+
* `db_cluster_address`
343+
* `db_cluster_port`
344+
345+
Additionally, if you're using Couchbase in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
346+
* `pod_labels_component`
347+
* `pod_labels_environment`
348+
* `pod_labels_db_system`
349+
* `pod_labels_db_cluster`
350+
* `pod_labels_db_cluster_address`
351+
* `pod_labels_db_cluster_port`
367352

368-
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.
353+
For information on setting up fields, see [Fields](/docs/manage/fields).
369354

370355
## Viewing Couchbase Dashboards
371356

372-
:::tip Filter with template variables
373-
Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md).
374-
:::
357+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
358+
359+
<ViewDashboards/>
375360

376361
### Overview
377362

@@ -471,17 +456,10 @@ Use this dashboard to:
471456

472457
## Create monitors for Couchbase app
473458

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-
476459
import CreateMonitors from '../../reuse/apps/create-monitors.md';
477460

478461
<CreateMonitors/>
479462

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-
485463
### Couchbase alerts
486464

487465
<table>

docs/integrations/databases/elasticsearch.md

Lines changed: 33 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -62,42 +62,8 @@ The Elasticsearch app is a unified logs and metrics app that helps you monitor t
6262

6363
Configuring log and metric collection for the Elasticsearch app includes the following tasks.
6464

65-
### Step 1: Configure Fields in Sumo Logic
6665

67-
Create the following Fields in Sumo Logic before configuring the collection. This ensures that your logs and metrics are tagged with relevant metadata required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
68-
69-
<Tabs
70-
groupId="k8s-nonk8s"
71-
defaultValue="k8s"
72-
values={[
73-
{label: 'Kubernetes environments', value: 'k8s'},
74-
{label: 'Non-Kubernetes environments', value: 'non-k8s'},
75-
]}>
76-
77-
<TabItem value="k8s">
78-
79-
If you're using Elasticsearch in a Kubernetes environment, create the fields:
80-
81-
* `pod_labels_component`
82-
* `pod_labels_environment`
83-
* `pod_labels_db_system`
84-
* `pod_labels_db_cluster`
85-
86-
</TabItem>
87-
<TabItem value="non-k8s">
88-
89-
If you're using Elasticsearch in a non-Kubernetes environment, create the fields:
90-
91-
* `component`
92-
* `environment`
93-
* `db_system`
94-
* `db_cluster`
95-
* `pod`
96-
97-
</TabItem>
98-
</Tabs>
99-
100-
### Step 2: Configure Collection for Elasticsearch
66+
### Configure Collection for Elasticsearch
10167

10268
<Tabs
10369
groupId="k8s-nonk8s"
@@ -368,7 +334,7 @@ At this point, Elasticsearch logs should start flowing into Sumo Logic.
368334
</TabItem>
369335
</Tabs>
370336
371-
## Installing Elasticsearch Monitors
337+
<!-- ## Installing Elasticsearch Monitors
372338
373339
Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Elasticsearch 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, see [Elasticsearch Alerts](#elasticsearch-alerts).
374340
@@ -441,19 +407,38 @@ email_notifications = [
441407
6. Installation.
442408
1. Navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Elasticsearch/` directory and run terraform init. This will initialize Terraform and download the required components.
443409
2. Run `terraform plan` to view the monitors that Terraform will create or modify.
444-
3. Run `terraform apply`.
410+
3. Run `terraform apply`. -->
445411
446412
## Installing the Elasticsearch app
447413
448-
import AppInstall from '../../reuse/apps/app-install.md';
414+
import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md';
449415
450-
<AppInstall/>
416+
<AppInstall2 />
417+
418+
As part of the app installation process, the following fields will be created by default:
419+
* `component`
420+
* `environment`
421+
* `db_system`
422+
* `db_cluster`
423+
* `pod`
424+
* `db_cluster_address`
425+
* `db_cluster_port`
426+
427+
Additionally, if you're using Elasticsearch in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
428+
* `pod_labels_component`
429+
* `pod_labels_environment`
430+
* `pod_labels_db_system`
431+
* `pod_labels_db_cluster`
432+
* `pod_labels_db_cluster_address`
433+
* `pod_labels_db_cluster_port`
434+
435+
For information on setting up fields, see [Fields](/docs/manage/fields).
451436
452437
## Viewing Elasticsearch dashboards
453438
454-
:::tip Filter with template variables
455-
Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables.md).
456-
:::
439+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
440+
441+
<ViewDashboards/>
457442
458443
### Overview
459444
@@ -533,9 +518,13 @@ The **ElasticSearch - Queries** dashboard shows Elasticsearch provides analytics
533518
534519
<img src={useBaseUrl('img/integrations/databases/elasticsearch-q.png')} alt="elasticsearch dashboards" />
535520
536-
## Elasticsearch Alerts
521+
## Create monitors for Elasticsearch app
522+
523+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
524+
525+
<CreateMonitors/>
537526
538-
Sumo Logic has provided out-of-the-box alerts available via[ Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Elasticsearch database cluster is available and performing as expected.
527+
### Elasticsearch Alerts
539528
540529
| Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition |
541530
|---|---|---|---|---|---|

docs/integrations/databases/mariadb.md

Lines changed: 23 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,8 @@ 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: Configure fields in Sumo Logic
2625

27-
As part of the app installation process, the following fields will be created by default:
28-
* `component`
29-
* `environment`
30-
* `db_system`
31-
* `db_cluster`
32-
* `db_cluster_address`
33-
* `db_cluster_port`
34-
35-
Additionally, if you are using MariaDB in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
36-
* `pod_labels_component`
37-
* `pod_labels_environment`
38-
* `pod_labels_db_system`
39-
* `pod_labels_db_cluster`
40-
* `pod_labels_db_cluster_address`
41-
* `pod_labels_db_cluster_port`
42-
43-
44-
For information on setting up fields, see [Fields](/docs/manage/fields).
45-
46-
### Step 2: Configure Collection
26+
### Configure Collection
4727

4828
Sumo Logic supports the collection of logs and metrics data from MariaDB in both Kubernetes and non-Kubernetes environments. Click on the appropriate links below based on the environment where your MariaDB clusters are hosted.
4929

@@ -398,32 +378,34 @@ At this point, Telegraf should start collecting the MariaDB metrics and forward
398378

399379
This section demonstrates how to install the MariaDB app. To install the app:
400380

401-
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**.
381+
import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md';
402382

403-
1. From the **App Catalog**, search for and select the app.
404-
2. Select the version of the service you're using and click **Add to Library**.
405-
:::note
406-
Version selection is not available for all apps.
407-
:::
408-
3. To install the app, complete the following fields.
409-
1. **App Name.** You can retain the existing name, or enter a name of your choice for the app.
410-
2. **Data Source.**
411-
* Choose **Enter a Custom Data Filter**, and enter a custom MariaDB cluster filter. Examples;
412-
1. For all MariaDB clusters, `db_cluster=*`.
413-
2. For a specific cluster, `db_cluster=mariadb.dev.01`.
414-
3. Clusters within a specific environment `db_cluster=mariadb.dev.01` and `environment=prod`. This assumes you have set the optional environment tag while configuring collection.
415-
3. **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
416-
4. Click **Add to Library**.
383+
<AppInstall2 />
384+
385+
As part of the app installation process, the following fields will be created by default:
386+
* `component`
387+
* `environment`
388+
* `db_system`
389+
* `db_cluster`
390+
* `db_cluster_address`
391+
* `db_cluster_port`
417392

418-
Once 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.
393+
Additionally, if you are using MariaDB in the Kubernetes environment, the following additional fields will be created by default during the app installation process:
394+
* `pod_labels_component`
395+
* `pod_labels_environment`
396+
* `pod_labels_db_system`
397+
* `pod_labels_db_cluster`
398+
* `pod_labels_db_cluster_address`
399+
* `pod_labels_db_cluster_port`
419400

420-
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.
401+
402+
For information on setting up fields, see [Fields](/docs/manage/fields).
421403

422404
## Viewing MariaDB Dashboards
423405

424-
:::tip Filter with template variables
425-
Template variables provide dynamic dashboards that can rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you view dynamic changes to the data for a quicker resolution to the root cause. You can use template variables to drill down and examine the data on a granular level. For more information, see [Filter with template variables](/docs/dashboards/filter-template-variables).
426-
:::
406+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
407+
408+
<ViewDashboards/>
427409

428410
### Overview
429411

@@ -528,17 +510,10 @@ Use this dashboard to:
528510

529511
## Create monitors for MariaDB app
530512

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-
533513
import CreateMonitors from '../../reuse/apps/create-monitors.md';
534514

535515
<CreateMonitors/>
536516

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-
542517
### MariaDB alerts
543518

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

0 commit comments

Comments
 (0)