Skip to content

Commit 379e857

Browse files
chetanchoudhary-sumochetanchoudhary-sumo
committed
removing commented alert install section
1 parent e9b4d39 commit 379e857

File tree

4 files changed

+0
-388
lines changed

4 files changed

+0
-388
lines changed

‎docs/integrations/databases/elasticsearch.md‎

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -334,80 +334,6 @@ At this point, Elasticsearch logs should start flowing into Sumo Logic.
334334
</TabItem>
335335
</Tabs>
336336
337-
<!-- ## Installing Elasticsearch Monitors
338-
339-
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).
340-
341-
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. There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/create-monitor) for details.
342-
343-
### Method 1: Importing a JSON file
344-
345-
1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Elasticsearch/Elasticsearch.json) that describes the monitors.
346-
2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Elasticsearch/Elasticsearch.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 Elasticsearch 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_cluster=*` with `<Your Custom Filter>`. Custom filter examples:
347-
* For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=dev-elasticsearch-01`
348-
* For alerts applicable to all clusters that start with `elasticsearch-prod`, your custom filter would be: `db_cluster=elasticsearch-prod*`
349-
* For alerts applicable to a specific clusters, within a production environment, your custom filter would be: `db_cluster=dev-elasticsearch-01` AND `environment=prod`. This assumes you have set the optional environment tag while configuring collection.
350-
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**.
351-
4. Click **Add**.
352-
5. Click **Import**.
353-
6. On the **Import Content popup**, enter **Elasticsearch** in the Name field, paste in the JSON into the popup, and click **Import**.
354-
7. The monitors are created in a **Elasticsearch** folder. The monitors are disabled by default. See the [Monitors](/docs/alerts/monitors) topic for information about enabling monitors and configuring notifications or connections.
355-
356-
### Method 2: Using a Terraform script
357-
358-
1. Generate a Sumo Logic access key and ID for a user that has the **Manage Monitors** role capability. For instructions, see [Access Keys](/docs/manage/security/access-keys).
359-
2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later, and install it.
360-
3. Download the Sumo Logic Terraform package for Elasticsearch 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/Elasticsearch). You can either download it using the git clone command or as a zip file.
361-
4. Alert Configuration. After extracting the package, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Elasticsearch/` directory.
362-
* Edit the `Elasticsearch.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).
363-
```bash
364-
access_id = "<SUMOLOGIC ACCESS ID>"
365-
access_key = "<SUMOLOGIC ACCESS KEY>"
366-
environment = "<SUMOLOGIC DEPLOYMENT>"
367-
```
368-
* 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 `elasticsearch_data_source` variable. For example:
369-
* To configure alerts for a specific cluster, set `elasticsearch_data_source` to something like `db_cluster=elasticsearch.prod.01`
370-
* To configure alerts for all clusters in an environment, set `elasticsearch_data_source` to something like `environment=prod`
371-
* To configure alerts for multiple clusters using a wildcard, set `elasticsearch_data_source` to something like `db_cluster=elasticsearch-prod*`
372-
* To configure alerts for a specific clusters within a specific environment, set `elasticsearch_data_source` to something like `db_cluster=elasticsearch-1` and `environment=prod`. This assumes you have configured and applied Fields as described in [Configure Sumo Logic Fields](#step-1-configure-fields-in-sumo-logic).
373-
374-
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 "Elasticsearch" folder on the **Monitors** page. To change the name of the folder, update the monitor folder name in the folder variable in the `Elasticsearch.auto.tfvars` file.
375-
5. If you want your alerts to send email or connection notifications, edit the `Elasticsearch_notifications.auto.tfvars` file to populate the `connection_notifications` and `email_notifications` sections. Examples are provided below. 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).
376-
```bash title="Pagerduty connection example"
377-
connection_notifications = [
378-
{
379-
connection_type = "PagerDuty",
380-
connection_id = "<CONNECTION_ID>",
381-
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}}\"}",
382-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
383-
},
384-
{
385-
connection_type = "Webhook",
386-
connection_id = "<CONNECTION_ID>",
387-
payload_override = "",
388-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
389-
}
390-
]
391-
```
392-
393-
For information about overriding the payload for different connection types, see [Set Up Webhook Connections](/docs/alerts/webhook-connections/set-up-webhook-connections).
394-
395-
```bash title="Email notifications example"
396-
email_notifications = [
397-
{
398-
connection_type = "Email",
399-
recipients = ["[email protected]"],
400-
subject = "Monitor Alert: {{TriggerType}} on {{Name}}",
401-
time_zone = "PST",
402-
message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
403-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
404-
}
405-
]
406-
```
407-
6. Installation.
408-
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.
409-
2. Run `terraform plan` to view the monitors that Terraform will create or modify.
410-
3. Run `terraform apply`. -->
411337
412338
## Installing the Elasticsearch app
413339

‎docs/integrations/databases/postgresql.md‎

Lines changed: 0 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -369,97 +369,6 @@ At this point, PostgreSQL logs should start flowing into Sumo Logic.
369369
</TabItem>
370370
</Tabs>
371371

372-
<!-- ## Installing PostgreSQL Alerts
373-
374-
This section provides instructions for installing the Sumo app and Alerts for PostgreSQL. These instructions assume you have already set up collection as described in the Collect Logs and Metrics from PostgreSQL app section.
375-
376-
Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you monitor your PostgreSQL cluster. These alerts are built based on metrics and logs datasets and include preset thresholds based on industry best practices and recommendations. For details on the individual alerts, please see the [alerts section](#postgresql-alerts).
377-
* To install these alerts, you need to have the Manage Monitors role capability.
378-
* Alerts can be installed by either importing them a JSON or a Terraform script.
379-
380-
There are limits to how many alerts can be enabled - please see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md) for details.
381-
382-
### Method A: Importing a JSON file
383-
384-
1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/postgresql/postgresql.json) describing all the monitors.
385-
1. The 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 PostgreSQL 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=postgresql` with `<Your Custom Filter> db_system=postgresql`. Custom filter examples:
386-
* For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=postgresql-prod.01`.
387-
* For alerts applicable to all clusters that start with postgresql-prod, your custom filter would be: `db_cluster=postgresql-prod*`.
388-
* For alerts applicable to a specific cluster within a production environment, your custom filter would be `db_cluster=postgresql-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection.
389-
2. Go to Manage Data > Alerts > Monitors.
390-
3. Click **Add**:
391-
4. Click Import to import monitors from the JSON above.
392-
393-
The monitors are disabled by default. Once you have installed the alerts using this method, navigate to the PostgreSQL folder under Monitors to configure them. See [this](/docs/alerts/monitors) document to enable monitors, to configure each monitor, to send notification to teams or connections please see the instructions detailed in step 4 of this [document](/docs/alerts/monitors/create-monitor).
394-
395-
### Method B: Using a Terraform script
396-
397-
1. Generate a Sumo Logic access key and ID for a user that has the Manage Monitors role capability in Sumo Logic using instructions in [Access Keys](/docs/manage/security/access-keys). Please identify which deployment your Sumo Logic account is in, using this [ link](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
398-
2. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later.
399-
3. Download the Sumo Logic Terraform package for PostgreSQL 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/postgresql). You can either download it through the “git clone” command or as a zip file.
400-
4. Alert Configuration: After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/**postgresql**/
401-
402-
Edit the **postgresql.auto.tfvars** file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1 .
403-
```bash
404-
access_id = "<SUMOLOGIC ACCESS ID>"
405-
access_key = "<SUMOLOGIC ACCESS KEY>"
406-
environment = "<SUMOLOGIC DEPLOYMENT>"
407-
```
408-
409-
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 variable `postgresql_data_source`. Custom filter examples:
410-
* A specific cluster `db_cluster=postgresql.prod.01`
411-
* All clusters in an environment `environment=prod`
412-
* For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=postgresql-.prod.01`
413-
* For alerts applicable to all clusters that start with postgresql-prod, your custom filter would be `db_cluster=postgresql-prod*`
414-
* For alerts applicable to a specific cluster within a production environment, your custom filter would be `db_cluster=postgresql-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection.
415-
416-
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.
417-
418-
By default, the monitors are configured in a monitor folder called “PostgreSQL”, if you would like to change the name of the folder, update the monitor folder name in this file.
419-
420-
If you would like the alerts to send email or connection notifications, configure these in the file **postgresql_notifications.auto.tfvars**. For configuration examples, refer to the next section.
421-
422-
423-
5. Email and Connection Notification Configuration Examples. To **configure notifications**, modify the file `postgresql_notifications.auto.tfvars` file and fill in the `connection_notifications` and `email_notifications` sections. See the examples for PagerDuty and email notifications below. See this [document](/docs/alerts/webhook-connections/set-up-webhook-connections) for creating payloads with other connection types.
424-
425-
```bash title="Pagerduty Connection Example"
426-
connection_notifications = [
427-
{
428-
connection_type = "PagerDuty",
429-
connection_id = "<CONNECTION_ID>",
430-
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}}\"}",
431-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
432-
},
433-
{
434-
connection_type = "Webhook",
435-
connection_id = "<CONNECTION_ID>",
436-
payload_override = "",
437-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
438-
}
439-
]
440-
```
441-
442-
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).
443-
444-
```bash title="Email Notifications Example"
445-
email_notifications = [
446-
{
447-
connection_type = "Email",
448-
recipients = ["[email protected]"],
449-
subject = "Monitor Alert: {{TriggerType}} on {{Name}}",
450-
time_zone = "PST",
451-
message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
452-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
453-
}
454-
]
455-
```
456-
457-
6. Install the Alerts.
458-
1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/**postgresql**/ and run `terraform init`. This will initialize Terraform and will download the required components.
459-
2. Run **`terraform plan`** to view the monitors which will be created/modified by Terraform.
460-
3. Run **`terraform apply`**.
461-
7. 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 people or services. This is detailed in [this document](/docs/alerts/monitors/create-monitor). -->
462-
463372
## Installing the PostgreSQL app
464373

465374
import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md';

0 commit comments

Comments
 (0)