Skip to content

Commit e4233c0

Browse files
chetanchoudhary-sumochetanchoudhary-sumo
committed
SUMO-254678: Doc update Database apps migration V1 to V2
1 parent bdefe7b commit e4233c0

File tree

5 files changed

+30
-458
lines changed

5 files changed

+30
-458
lines changed

‎docs/integrations/databases/cassandra.md‎

Lines changed: 7 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -522,91 +522,7 @@ At this point, Cassandra metrics and logs should start flowing into Sumo Logic.
522522
</TabItem>
523523
</Tabs>
524524

525-
## Installing Cassandra Monitors
526525

527-
:::note
528-
This step is not needed if you are using the [Application Components Solution](/docs/observability/application-components) Terraform script.
529-
:::
530-
531-
To install these monitors, you must have the **Manage Monitors** role capability. You can install monitors by importing a JSON file or using a Terraform script.
532-
533-
Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if a 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, see [Cassandra Alerts](#cassandra-alerts).
534-
535-
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/create-monitor) for details.
536-
537-
### Method A: Importing a JSON file
538-
539-
1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Memcached/Memcached.json) that describes the monitors.
540-
2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Memcached/Memcached.json) contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Cassandra clusters, the data for which has been collected via the instructions in the previous sections.
541-
542-
However, if you would like to restrict these alerts to specific clusters or environments, update the JSON file by replacing the text `db_cluster=*` with `<Your Custom Filter>`. Custom filter examples:
543-
* For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=dev-cassandra-01`.
544-
* For alerts applicable to all clusters that start with `cassandra-prod`, your custom filter would be: `db_cluster=cassandra-prod*`.
545-
* For alerts applicable to specific clusters, within a production environment, your custom filter would be:`db_cluster=dev-cassandra-01` AND `environment=prod`. This assumes you have set the optional environment tag while configuring collection.
546-
3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
547-
4. Click **Add**.
548-
5. Click **Import**.
549-
6. On the **Import Content popup**, enter **Cassandra** in the Name field, paste the JSON into the popup, and click **Import**.
550-
7. The monitors are created in a "Cassandra" folder. The monitors are disabled by default. See the [Monitors](/docs/alerts/monitors) topic for information about enabling monitors and configuring notifications or connections.
551-
552-
### Method B: Using a Terraform script
553-
554-
1. Generate an access key and access ID for a user that has the **Manage Monitors** role capability. For instructions, see [Access Keys](/docs/manage/security/access-keys).
555-
2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later and install it.
556-
3. Download the Sumo Logic Terraform package for Cassandra monitors. The alerts package is available in the Sumo Logic GitHub [repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/Memcached). You can either download it using the git clone command or as a zip file.
557-
4. Alert Configuration. After extracting the package, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Cassandra/` directory.
558-
5. Edit the Cassandra.auto.tfvars file and add the Sumo Logic Access Key and Access ID from Step 1 and your Sumo Logic deployment. If you're not sure of your deployment, see [Sumo Logic Endpoints and Firewall Security](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
559-
```bash
560-
access_id = "<SUMOLOGIC ACCESS ID>"
561-
access_key = "<SUMOLOGIC ACCESS KEY>"
562-
environment = "<SUMOLOGIC DEPLOYMENT>"
563-
```
564-
6. The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific clusters or environments, update the `cassandra_data_source` variable. For example:
565-
* To configure alerts for a specific cluster, set `cassandra_data_source` to something like `db_cluster=cassandra.prod.01`
566-
* To configure alerts for all clusters in an environment, set `cassandra_data_source` to something like `environment=prod`
567-
* To configure alerts for multiple clusters using a wildcard, set `cassandra_data_source` to something like `db_cluster=cassandra-prod*`
568-
* To configure alerts for...A specific clusters within a specific environment, set `cassandra_data_source` to something like `db_cluster=cassandra-1` and `environment=prod`. This assumes you have configured and applied Fields as described [Configure Fields in Sumo Logic](#step-1-configure-fields-in-sumo-logic) step.
569-
570-
All monitors are disabled by default on installation. To enable all of the monitors, set the `monitors_disabled` parameter to `false`. By default, the monitors will be located in a "Cassandra" folder on the **Monitors** page. To change the name of the folder, update the monitor folder name in the folder variable in the `Cassandra.auto.tfvars` file.
571-
572-
7. If you want your alerts to send email or connection notifications, edit the `Cassandra_notifications.auto.tfvars` file to populate the `connection_notifications` and `email_notifications` sections. Examples are provided below.
573-
574-
In the variable definition below, replace `<CONNECTION_ID>` with the connection ID of the Webhook connection. You can obtain the Webhook connection ID by calling the [Monitors API](https://api.sumologic.com/docs/#operation/listConnections).
575-
576-
```bash title="Pagerduty connection example"
577-
connection_notifications = [
578-
{
579-
connection_type = "PagerDuty",
580-
connection_id = "<CONNECTION_ID>",
581-
payload_override = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
582-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
583-
},
584-
{
585-
connection_type = "Webhook",
586-
connection_id = "<CONNECTION_ID>",
587-
payload_override = "",
588-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
589-
}
590-
]
591-
```
592-
593-
For information about overriding the payload for different connection types, see [Set Up Webhook Connections](/docs/alerts/webhook-connections/set-up-webhook-connections).
594-
```bash title="Email notifications example"
595-
email_notifications = [
596-
{
597-
connection_type = "Email",
598-
recipients = ["[email protected]"],
599-
subject = "Monitor Alert: {{TriggerType}} on {{Name}}",
600-
time_zone = "PST",
601-
message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
602-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
603-
}
604-
]
605-
```
606-
607-
8. To install the Monitors, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Cassandra/` directory and run `terraform init`. This will initialize Terraform and download the required components.
608-
9. Run `terraform plan` to view the monitors that Terraform will create or modify.
609-
10. Run `terraform apply`.
610526

611527
## Installing the Cassandra app
612528

@@ -739,7 +655,13 @@ Use this dashboard to:
739655

740656
<img src={useBaseUrl('img/integrations/databases/Cassandra-Write-Path.png')} alt="Cassandra dashboards" />
741657

742-
## Cassandra Alerts
658+
## Create monitors for Cassandra app
659+
660+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
661+
662+
<CreateMonitors/>
663+
664+
### Cassandra Alerts
743665

744666
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.
745667

‎docs/integrations/databases/couchbase.md‎

Lines changed: 6 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -378,101 +378,6 @@ At this point, Telegraf should start collecting the Couchbase metrics and forwar
378378
</TabItem>
379379
</Tabs>
380380
381-
382-
## Installing Couchbase Monitors
383-
384-
The next sections provides instructions for installing the Couchbase app, as well as examples of each of the app dashboards. These instructions assume you have already set up the collection as described in the **Collecting Logs and Metrics for the Couchbase app** section.
385-
386-
#### Pre-Packaged Alerts
387-
388-
Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you monitor your Couchbase clusters. These alerts are built based on metrics and logs datasets and include preset thresholds based on industry best practices and recommendations.
389-
390-
For details on the individual alerts, see [Couchbase Alerts](#couchbase-alerts).
391-
* To install these alerts, you need to have the Manage Monitors role capability.
392-
* Alerts can be installed by either importing a JSON file or a Terraform script.
393-
394-
There are limits to how many alerts can be enabled - see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq) for details.
395-
396-
397-
### Method A: Importing a JSON file
398-
399-
1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Couchbase/couchbase.json) that describes the monitors.
400-
2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Couchbase/couchbase.json) contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Couchbase clusters, the data for which has been collected via the instructions in the previous sections. However, if you would like to restrict these alerts to specific clusters or environments, update the JSON file by replacing the text `db_system=couchbase` with `<Your Custom Filter>`. Custom filter examples:
401-
1. For alerts applicable only to a specific cluster, your custom filter would be `'db_cluster=couchbase-standalone.01'`.
402-
2. For alerts applicable to all cluster that start with couchbase-standalone, your custom filter would be,`db_cluster=couchbase-standalone*`.
403-
3. For alerts applicable to a specific cluster within a production environment, your custom filter would be `db_cluster=couchbase-1` and `environment=standalone` (This assumes you have set the optional environment tag while configuring collection).
404-
3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
405-
4. Click **Add**:
406-
5. Click **Import** and then copy-paste the above JSON to import monitors.
407-
6. The monitors are disabled by default. Once you have installed the alerts using this method, navigate to the Couchbase folder under **Monitors** to configure them. See [Monitor Settings](/docs/alerts/monitors/settings) to learn how to enable monitors to send notifications to teams or connections. See the instructions detailed in [Create a Monitor](/docs/alerts/monitors/create-monitor).
408-
409-
### Method B: Using a Terraform script method
410-
411-
1. **Generate a Sumo Logic access key and ID**. Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using instructions in [Access Keys](/docs/manage/security/access-keys). Identify which deployment your Sumo Logic account is in using this [link](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
412-
2. **[Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later**.
413-
3. **Download the Sumo Logic Terraform package for Couchbase alerts**. The alerts package is available in the Sumo Logic GitHub [repository](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/SquidProxy). You can either download it through the “git clone” command or as a zip file.
414-
4. **Alert Configuration**. After the package has been extracted, navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/Couchbase/`
415-
5. Edit the **couchbase.auto.tfvars** file and add the Sumo Logic Access Key, Access Id, and Deployment from Step 1.
416-
```bash
417-
access_id = "<SUMOLOGIC ACCESS ID>"
418-
access_key = "<SUMOLOGIC ACCESS KEY>"
419-
environment = "<SUMOLOGIC DEPLOYMENT>"
420-
```
421-
422-
The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific farms or environments, update the variable `couchbase_data_source`. Custom filter examples:
423-
* A specific cluster `db_cluster=couchbase.standalone.01`.
424-
* All clusters in an environment `environment=standalone`.
425-
* For alerts applicable to all clusters that start with `couchbase-standalone`, your custom filter would be: `db_cluster=couchbase-standalone`.
426-
* For alerts applicable to a specific cluster within a production environment, your custom filter would be: `db_system=couchbase` and `environment=standalone`. This assumes you have set the optional environment tag while configuring collection.
427-
428-
All monitors are disabled by default on installation. If you would like to enable all the monitors, set the parameter `monitors_disabled` to `false` in this file.
429-
430-
By default, the monitors are configured in a monitor folder called “Couchbase”. If you would like to change the name of the folder, update the monitor folder name in “folder” key at `couchbase.auto.tfvars` file.
431-
432-
If you would like the alerts to send email or connection notifications, configure these in the file `couchbase_notifications.auto.tfvars`. For configuration examples, refer to the next section.
433-
434-
6. **Email and Connection Notification Configuration Examples**. Modify the file **couchbase_notifications.auto.tfvars** and populate `connection_notifications` and `email_notifications` as per below examples.
435-
436-
```bash title="Pagerduty Connection Example"
437-
connection_notifications = [
438-
{
439-
connection_type = "PagerDuty",
440-
connection_id = "<CONNECTION_ID>",
441-
payload_override = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
442-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
443-
},
444-
{
445-
connection_type = "Webhook",
446-
connection_id = "<CONNECTION_ID>",
447-
payload_override = "",
448-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
449-
}
450-
]
451-
```
452-
453-
Replace `<CONNECTION_ID>` with the connection id of the webhook connection. The webhook connection id can be retrieved by calling the [Monitors API](https://api.sumologic.com/docs/#operation/listConnections).
454-
455-
For overriding payload for different connection types, refer to this [document](/docs/alerts/webhook-connections/set-up-webhook-connections).
456-
457-
```bash title="Email Notifications Example"
458-
email_notifications = [
459-
{
460-
connection_type = "Email",
461-
recipients = ["[email protected]"],
462-
subject = "Monitor Alert: {{TriggerType}} on {{Name}}",
463-
time_zone = "PST",
464-
message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
465-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
466-
}
467-
]
468-
```
469-
470-
7. **Install the Alerts**. Navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/Couchbase/` and run `terraform init`. This will initialize Terraform and will download the required components.
471-
8. Run `terraform plan` to view the monitors which will be created/modified by Terraform.
472-
9. Run `terraform apply`.
473-
10. **Post Installation**. If you haven’t enabled alerts and/or configured notifications through the Terraform procedure outlined above, we highly recommend enabling alerts of interest and configuring each enabled alert to send notifications to other users or services. This is detailed in Step 4 of [this document](/docs/alerts/monitors/create-monitor). There are limits to how many alerts can be enabled - see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md).
474-
475-
476381
## Installing the Couchbase app
477382
478383
This section demonstrates how to install the Couchbase app.
@@ -600,9 +505,13 @@ Use this dashboard to:
600505
601506
<img src={useBaseUrl('img/integrations/databases/Couchbase-HTTP-Access.png')} alt="Cassandra dashboards" />
602507
603-
## Couchbase Alerts
508+
## Create monitors for Couchbase app
509+
510+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
511+
512+
<CreateMonitors/>
604513
605-
Sumo Logic has provided out-of-the-box alerts available via[ Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Couchbase database cluster is available and performing as expected.
514+
### Couchbase alerts
606515
607516
<table>
608517
<tr>

0 commit comments

Comments
 (0)