From e4233c009f7c02c76fa0a4ba335d21d126dbe568 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Wed, 29 Jan 2025 10:53:21 +0530 Subject: [PATCH 01/38] SUMO-254678: Doc update Database apps migration V1 to V2 --- docs/integrations/databases/cassandra.md | 92 ++----------------- docs/integrations/databases/couchbase.md | 103 ++------------------- docs/integrations/databases/memcached.md | 95 ++------------------ docs/integrations/databases/mongodb.md | 90 ++----------------- docs/integrations/databases/redis.md | 108 ++--------------------- 5 files changed, 30 insertions(+), 458 deletions(-) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index 1dd12df004..de7b54ea2e 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -522,91 +522,7 @@ At this point, Cassandra metrics and logs should start flowing into Sumo Logic. -## Installing Cassandra Monitors -:::note -This step is not needed if you are using the [Application Components Solution](/docs/observability/application-components) Terraform script. -::: - -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. - -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). - -There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/create-monitor) for details. - -### Method A: Importing a JSON file - -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. -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. - - 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 ``. Custom filter examples: - * For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=dev-cassandra-01`. - * For alerts applicable to all clusters that start with `cassandra-prod`, your custom filter would be: `db_cluster=cassandra-prod*`. - * 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. -3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -4. Click **Add**. -5. Click **Import**. -6. On the **Import Content popup**, enter **Cassandra** in the Name field, paste the JSON into the popup, and click **Import**. -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. - -### Method B: Using a Terraform script - -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). -2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later and install it. -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. -4. Alert Configuration. After extracting the package, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Cassandra/` directory. -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). -```bash -access_id = "" -access_key = "" -environment = "" -``` -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: - * To configure alerts for a specific cluster, set `cassandra_data_source` to something like `db_cluster=cassandra.prod.01` - * To configure alerts for all clusters in an environment, set `cassandra_data_source` to something like `environment=prod` - * To configure alerts for multiple clusters using a wildcard, set `cassandra_data_source` to something like `db_cluster=cassandra-prod*` - * 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. - -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. - -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. - - In the variable definition below, replace `` 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). - -```bash title="Pagerduty connection example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -For information about overriding the payload for different connection types, see [Set Up Webhook Connections](/docs/alerts/webhook-connections/set-up-webhook-connections). -```bash title="Email notifications example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -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. -9. Run `terraform plan` to view the monitors that Terraform will create or modify. -10. Run `terraform apply`. ## Installing the Cassandra app @@ -739,7 +655,13 @@ Use this dashboard to: Cassandra dashboards -## Cassandra Alerts +## Create monitors for Cassandra app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + + +### Cassandra Alerts 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. diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index 16a8ae1b30..99fa295c34 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -378,101 +378,6 @@ At this point, Telegraf should start collecting the Couchbase metrics and forwar - -## Installing Couchbase Monitors - -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. - -#### Pre-Packaged Alerts - -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. - -For details on the individual alerts, see [Couchbase Alerts](#couchbase-alerts). -* To install these alerts, you need to have the Manage Monitors role capability. -* Alerts can be installed by either importing a JSON file or a Terraform script. - -There are limits to how many alerts can be enabled - see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq) for details. - - -### Method A: Importing a JSON file - -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. -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 ``. Custom filter examples: - 1. For alerts applicable only to a specific cluster, your custom filter would be `'db_cluster=couchbase-standalone.01'`. - 2. For alerts applicable to all cluster that start with couchbase-standalone, your custom filter would be,`db_cluster=couchbase-standalone*`. - 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). -3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -4. Click **Add**: -5. Click **Import** and then copy-paste the above JSON to import monitors. -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). - -### Method B: Using a Terraform script method - -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). -2. **[Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later**. -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. -4. **Alert Configuration**. After the package has been extracted, navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/Couchbase/` -5. Edit the **couchbase.auto.tfvars** file and add the Sumo Logic Access Key, Access Id, and Deployment from Step 1. -```bash -access_id = "" -access_key = "" -environment = "" -``` - -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: - * A specific cluster `db_cluster=couchbase.standalone.01`. - * All clusters in an environment `environment=standalone`. - * For alerts applicable to all clusters that start with `couchbase-standalone`, your custom filter would be: `db_cluster=couchbase-standalone`. - * 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. - -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. - -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. - -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. - -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. - -```bash title="Pagerduty Connection Example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -Replace `` 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). - -For overriding payload for different connection types, refer to this [document](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```bash title="Email Notifications Example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -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. -8. Run `terraform plan` to view the monitors which will be created/modified by Terraform. -9. Run `terraform apply`. -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). - - ## Installing the Couchbase app This section demonstrates how to install the Couchbase app. @@ -600,9 +505,13 @@ Use this dashboard to: Cassandra dashboards -## Couchbase Alerts +## Create monitors for Couchbase app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + -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. +### Couchbase alerts diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index f2c984678f..b04fdc895e 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -353,94 +353,6 @@ At this point, Memcached logs should start flowing into Sumo Logic. - -## Installing Memcached Monitors - -Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if a 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, see [Memcached Alerts](#memcached-alerts). - -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. - - -### Method A: Importing a JSON file - -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. -2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Memcached/Memcached.json) contains alerts from Sumo Logic searches that do not have any scope filters and, therefore, will apply to all Memcached 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 ``. Custom filter examples: - * For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=dev-memcached-01` - * For alerts applicable to all clusters that start with `memcached-prod`, your custom filter would be: `db_cluster=memcachedt-prod*` - * For alerts applicable to specific clusters within a production environment, your custom filter would be: `db_cluster=dev-memcached-01` AND `environment=prod`. This assumes you have set the optional environment tag while configuring collection. -3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -4. Click **Add**. -4. Click **Import**. -6. On the **Import Content popup**, enter **Memcached** in the Name field, paste the JSON into the popup, and click **Import**. -7. The monitors are created in "Memcached" folder. The monitors are disabled by default. See the [Monitors](/docs/alerts/monitors) topic for information about enabling monitors and configuring notifications or connections. - - -### Method B: Using a Terraform script - -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). -2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later, and install. -3. Download the Sumo Logic Terraform package for Memcached 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. -4. Alert Configuration. After extracting the package, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/Memcached/` directory. -5. Edit the `Memcached.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). - ```bash - access_id = "" - access_key = "" - environment = "" - ``` -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 `memcached_data_source` variable. For example: - * To configure alerts for a specific clusters, set `memcached_data_source` to something like: `db_cluster=memcached.prod.01` - * To configure alerts for All clusters in an environment, set `memcached_data_source` to something like: `environment=prod` - * To configure alerts for Multiple clusters using a wildcard, set `memcached_data_source` to something like: `db_cluster=memcached-prod*` - * To configure alerts for specific clusters within a specific environment, set `memcached_data_source` to something like: `db_cluster=memcached-1 and environment=prod`. This assumes you have configured and applied Fields as described in Step 1: Configure Fields of the Sumo Logic of the Collect Logs and Metrics for Memcached topic. - - 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 "Memcached" folder on the **Monitors** page. To change the name of the folder, update the monitor folder name in the folder variable in the `Memcached.auto.tfvars` file. - -7. If you want the alerts to send email or connection notifications, edit the `Memcached_notifications.auto.tfvars` file to populate the `connection_notifications` and `email_notifications` sections. Examples are provided below. - * In the variable definition below, replace `` 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). - -```bash title="Pagerduty connection example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` -For information about overriding the payload for different connection types, see [Set Up Webhook Connections](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```bash title="Email notifications example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -7. Install Monitors. - 1. Navigate to the terraform-sumologic-sumo-logic-monitor/monitor_packages/Memcached/ directory and run `terraform init`. This will initialize Terraform and download the required components. - 2. Run `terraform plan` to view the monitors that Terraform will create or modify. - 3. Run `terraform apply`. - - ## Installing the Memcached app This section demonstrates how to install the Memcached app. @@ -485,10 +397,13 @@ The **Memcached - Logs** dashboard helps you quickly analyze your Memcached erro Memcached dashboards -## Memcached Alerts +## Create monitors for Memcached app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; -Sumo Logic has provided out-of-the-box alerts available via [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Memcached database cluster is available and performing as expected. + +### Memcached alerts
diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 233b3da29d..4d0d4273d1 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -410,88 +410,6 @@ At this point, MongoDB logs should start flowing into Sumo Logic. - -## Installing MongoDB Monitors - -The next few sections have instructions for installing Sumo Logic Monitors for MongoDB, the app, and descriptions of each of the app dashboards. These instructions assume you have already set up collection as described in the [Collecting Logs and Metrics for MongoDB](#collecting-logs-and-metrics-for-mongodb). - -Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if a 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, see [MongoDB Alerts](#mongodb-alerts). - -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/overview/#rules) for details. - -### Method A: Importing a JSON file - -1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/MongoDB/MongoDB.json) that describes the monitors. -2. Replace `$$mongodb_data_source` with a custom source filter. To configure alerts for a specific database cluster, use a filter like `db_system=mongodb` or `db_cluster=dev-mongodb`. To configure the alerts for all of your clusters, set `$$mongodb_data_source` to blank (`""`). -3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -4. Click **Add**. -5. Click **Import**. -6. On the **Import Content popup**, enter `MongoDB` in the Name field, paste in the JSON into the the popup, and click **Import**. -7. The monitors are created in a "MongoDB" folder. The monitors are disabled by default. See the [Monitors](/docs/alerts/monitors) topic for information about enabling monitors and configuring notifications or connections. - -### Method B: Using a Terraform script - -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). -2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later, and install it. -3. Download the Sumo Logic Terraform package for MongoDB 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/MongoDB). You can either download it using the `git clone` command or as a zip file. -4. Alert Configuration. After extracting the package , navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/MongoDB/` directory. Edit the `MongoDB.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). - ```bash - access_id = "" - access_key = "" - environment = "" - ``` - - 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 `mongodb_data_source` variable. For example: - * To configure alerts for A specific cluster set `mongodb_data_source` to something like `db_cluster = mongodb.prod.01` - * To configure alerts for All clusters in an environment set `mongodb_data_source` to something like `environment = prod` - * To configure alerts for Multiple clusters using a wildcard set `mongodb_data_source` to something like `db_cluster = mongodb-prod*` - * To configure alerts for A specific cluster within a specific environment, set `mongodb_data_source` to something like `db_cluster = mongodb-1` and `environment = prod`. This assumes you have configured and applied Fields as described in [Step 1: Configure Sumo Logic Fields](#step-1-configure-fields-in-sumo-logic). - - 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 "MongoDB" folder on the **Monitors** page. To change the name of the folder, update the monitor folder name in the `folder` variable in the `MongoDB.auto.tfvars` file. - -5. If you want the alerts to send email or connection notifications, edit the `MongoDB_notifications.auto.tfvars` file to populate the `connection_notifications` and `email_notifications` sections. Examples are provided below. In the variable definition below, replace `` 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). -```bash title="Pagerduty connection example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -For information about overriding the payload for different connection types, see [Set Up Webhook Connections](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```bash title="Email notifications example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -6. Install Monitors - 1. Navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/MongoDB/` directory and run `terraform init`. This will initialize Terraform and download the required components. - 2. Run `terraform plan` to view the monitors that Terraform will create or modify. - 3. Run `terraform apply`. - - ## Installing the MongoDB app Now that you have set up collection for MongoDB, install the Sumo Logic app for MongoDB to use the preconfigured searches and dashboards to analyze your data. @@ -576,9 +494,13 @@ Use this dashboard to: MongoDB dashboards -## MongoDB Alerts +## Create monitors for MongoDB app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + -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. +### MongoDB alerts | Name | Description | Trigger Type | Alert Conditions | Recover Conditions | |:----------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------|:------------------|:--------------------| diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index 0384642472..e58320c1e5 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -429,106 +429,6 @@ After determining the location of conf file, modify the **redis.conf** configura -## Installing Redis Monitors/Alerts - -:::note -This step is not needed if you are using the application components solution terraform script. -::: - -This section has instructions for installing the Sumo app and Alerts for Redis ULM, as well as descriptions and examples for each of the dashboards. These instructions assume you have already set up collection as described in the **Collecting Logs and Metrics for Redis app** section. - -Sumo Logic has provided out-of-the-box alerting capabilities available via [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Redis database cluster is available and performing as expected. These monitors fire alerts (notifications) on top of preset thresholds on metrics data using industry best practices and recommendations. - -For details on the individual monitors, please see [Alerts](#redis-alerts). - -* To install these alerts, you need to have the Manage Monitors role capability. -* Alerts can be installed by either importing them via a JSON or via a Terraform script. - -:::note -There are limits for how many alerts can be enabled - please see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md) for details. -::: - -### Method A: Importing a JSON file - -1. Download a [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/tree/main/monitor_packages/redis) that describes the monitors. 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 Redis 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=redis` with ` db_system=redis`. Custom filter examples: - * For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=redis-.prod.01`. - * For alerts applicable to all clusters that start with `redis-prod`, your custom filter would be: `db_cluster=redis-prod*`. - * For alerts applicable to a specific cluster within a production environment, your custom filter would be: `db_cluster=redis-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection. -2. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -3. Click **Add**. -4. Click **Import** to import monitors from the JSON above. - -:::note -Monitors are disabled by default. Once you have installed the alerts via this method, navigate to the Redis folder under **Monitors** to configure them. See [Monitor Settings](/docs/alerts/monitors/settings/#monitor-details-pane) to enable monitors. To send notifications to teams or connections, see the instructions detailed in Step 4 of [Create a Monitor](/docs/alerts/monitors/create-monitor). -::: - -### Method B: Using a Terraform script - -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). -2. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later. -3. Download the Sumo Logic Terraform package for Redis 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/redis). You can either download it via the “git clone” command or as a zip file. -4. Monitor Configuration. After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/**redis**/ - -Edit the redis.auto.tfvars file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1. -```bash -access_id = "" -access_key = "" -environment = "" -``` -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 `redis_cluster_filter`. Custom filter examples: - * For alerts applicable only to a specific cluster, your custom filter would be: `db_cluster=redis-.prod.01`. - * For alerts applicable to all clusters that start with redis-prod, your custom filter would be: `db_cluster=redis-prod*`. - * For alerts applicable to a specific cluster within a production environment, your custom filter would be: `db_cluster=redis-1 and environment=prod`. This assumes you have set the optional environment tag while configuring collection. - - 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. - - By default, the monitors are configured in a monitor folder called “Redis”, if you would like to change the name of the folder, update the monitor folder name in this file. - - If you would like the alerts to send email or connection notifications, configure these in the file **redis_notifications.auto.tfvars**. For configuration examples, refer to the next section. - -5. Email and Connection Notification Configuration Examples. To configure notifications, modify the file redis_notifications.auto.tfvars file and fill in the connection_notifications 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. -```bash title="Pagerduty Connection Example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -Replace `` with the connection id of the webhook connection. The webhook connection id can be retrieved via calling the [Monitors API](https://api.sumologic.com/docs/#operation/listConnections). - -For overriding payload for different connection types, refer to [this document](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```bash title="Email Notifications Example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -6. Install the Monitors. - 1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/**redis**/ and run **terraform init.** This will initialize Terraform and will download the required components. - 2. Run `terraform plan` to view the monitors which will be created/modified by Terraform. - 3. Run `terraform apply`. - -7. Post Installation. If you haven’t enabled alerts and/or configured notifications via 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 [Add a Monitor](/docs/alerts/monitors/create-monitor). - - ## Installing the Redis app This section demonstrates how to install the Redis ULM app. @@ -609,9 +509,13 @@ Use this dashboard to: Redis dashboards -## Redis Alerts +## Create monitors for Redis app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + -Sumo Logic has provided out-of-the-box alerts available via [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Redis database cluster is available and performing as expected. +### Redis alerts
Alert Name
From 6643ff60b0a644abbdec480ec2bac90febeed866 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Wed, 29 Jan 2025 21:11:44 +0530 Subject: [PATCH 02/38] Updating monitor part --- docs/integrations/databases/mariadb.md | 93 +----------- docs/integrations/databases/mysql.md | 93 +----------- docs/integrations/databases/oracle.md | 93 +----------- .../microsoft-azure/sql-server.md | 134 +----------------- 4 files changed, 22 insertions(+), 391 deletions(-) diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index 9abb1c08ff..02a5ffa48a 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -429,91 +429,6 @@ At this point, Telegraf should start collecting the MariaDB metrics and forward - -## Installing the MariaDB Monitors - -The next few sections provide instructions for installing the MariaDB Monitors 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 Collect Logs and Metrics for the MariaDB app page. - -#### Pre-Packaged Alerts - -Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you monitor your MariaDB clusters. These alerts are built based on metrics and logs datasets and include preset thresholds based on industry best practices and recommendations. See [Alerts](#mariadb-alerts) for more information. -* To install these alerts, you need to have the Manage Monitors role capability. -* Alerts can be installed by either importing a JSON file or a Terraform script. -* There are limits to how many alerts can be enabled - see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq) for details. - -### Method A: Importing a JSON file - -1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/MariaDB/MariaDB.json) that describes the monitors. -2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/MariaDB/MariaDB.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 MariaDB 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=mariadb` with ``. Custom filter examples: - * For alerts applicable only to a specific cluster, your custom filter would be `db_cluster=mariadb-prod.01`. - * For alerts applicable to all clusters that start with Kafka-prod, your custom filter would be `db_cluster=mariadb-prod*`. - * For alerts applicable to a specific cluster within a production environment, your custom filter would be `db_cluster=mariadb-1` and `environment=prod`. This assumes you have set the optional environment tag while configuring collection. -3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -4. Click **Add**. -5. Click Import and then copy-paste the above JSON to import monitors. -6. The monitors are disabled by default. Once you have installed the alerts using this method, navigate to the MariaDB folder under **Monitors** to configure them. See [this](/docs/alerts/monitors) document to enable monitors to send notifications to teams or connections. See the instructions detailed in [Add a Monitor](/docs/alerts/monitors/create-monitor). - -### Method B: Using a Terraform script - -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) -2. **[Download and install Terraform 0.13](https://www.terraform.io/downloads.html)** or later. -3. **Download the Sumo Logic Terraform package for MariaDB 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/MariaDB). You can either download it through the “git clone” command or as a zip file. -4. **Alert Configuration.** After the package has been extracted, navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/MariaDB/`. Edit the **MariaDB.auto.tfvars** file and add the Sumo Logic Access Key, Access Id, and Deployment from Step 1. - ```bash - access_id = "" - access_key = "" - environment = "" - ``` - 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 `mariadb_data_source`. Custom filter examples: - * For a specific cluster, your custom filter would be `db_cluster=mariadb.prod.01` - * For all clusters in an environment, your custom filter would be `environment=prod` - * For alerts applicable to all clusters that start with `mariadb-prod`, your custom filter would be `db_cluster=mariadb-prod*` - * For alerts applicable to a specific cluster within a production environment, your custom filter would be `db_cluster=mariadb-1` and `environment=prod`. This assumes you have set the optional environment tag while configuring collection. - - 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. - - By default, the monitors are configured in a monitor folder called “MariaDB”. If you would like to change the name of the folder, update the monitor folder name in “folder” key at `MariaDB.auto.tfvars` file. If you would like the alerts to send email or connection notifications, configure these in the file `MariaDB_notifications.auto.tfvars`. For configuration examples, refer to the next section. - -5. **Email and Connection Notification Configuration Examples**. Modify the file `MariaDB_notifications.auto.tfvars` and populate `connection_notifications` and `email_notifications` as per below examples. -```sql title="Pagerduty Connection Example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -Replace `` 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). - -For overriding payload for different connection types, refer to this [document](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```sql title="Email Notifications Example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -6. **Install the Alerts**. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/**MariaDB** and run `terraform init`. This will initialize Terraform and will download the required components. - 1. Run `terraform plan` to view the monitors which will be created/modified by Terraform. - 2. Run `terraform apply`. -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 users or services. This is detailed in Step 4 of [this document](/docs/alerts/monitors/create-monitor). - ## Installing the MariaDB app This section demonstrates how to install the MariaDB app. To install the app: @@ -646,11 +561,13 @@ Use this dashboard to: mariadb dashboards -## MariaDB Alerts +## Create monitors for MariaDB app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; -Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the MariaDB Database are available and performing as expected. These alerts are built based on logs and metrics datasets and have preset thresholds based on industry best practices and recommendations. + -Sumo Logic provides the following out-of-the-box alerts: +### MariaDB alerts | Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | |:---------------------------|:------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|:-----------------|:-------------------| diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index 9be203eb30..4da6b5c07b 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -558,91 +558,6 @@ At this point, MySQL slow query logs should start flowing into Sumo Logic. -## Installing MySQL Monitors - -The next few sections provide instructions for installing Sumo Logic Monitors for MySQL, the app and descriptions of each of the app dashboards. These instructions assume you have already set up collection as described in Collecting MySQL Logs and Metrics. - -Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if a MySQL 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 [MySQL Alerts](#mysql-alerts). - -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. - -### Method A: Install Monitors by importing a JSON file - -1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/mysql/mysql.json) that describes the monitors. -2. Replace `$$mysql_data_source` with a custom source filter. To configure alerts for a specific database cluster, use a filter like `db_system=mysql` or `db_cluster=dev-mysql`. To configure the alerts for all of your clusters, set `$$mysql_data_source` to blank (`""`). -3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -4. Click **Add**. -5. Click **Import.** -6. On the **Import Content popup**, enter "MySQL" in the Name field, paste in the JSON into the the popup, and click **Import**. -7. The monitors are created in a "MySQL" folder. The monitors are disabled by default. See the [Monitors](/docs/alerts/monitors) topic for information about enabling monitors and configuring notifications or connections. - - -### Method B: Using a Terraform script - -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). -2. Download [Terraform 0.13](https://www.terraform.io/downloads.html) or later, and install it. -3. Download the Sumo Logic Terraform package for MySQL 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/mysql). You can either download it using the `git clone` command or as a zip file. -4. Alert Configuration: After extracting the package, navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/mysql/` directory. - 1. Edit the `mysql.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). - ```sql - access_id = "" - access_key = "" - environment = "" - ``` - 2. 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 `mysql_data_source` variable. For example: - * To configure alerts for a specific cluster, set `mysql_data_source` to something like `db_cluster=mysql.prod.01` - * To configure alerts for all clusters in an environment Set mysql_data_source to something like `environment=prod` - * To configure alerts for...Multiple clusters using a wildcard, set `mysql_data_source` to something like `db_cluster=mysql-prod*` - * To configure alerts for a specific cluster within a specific environment, set `mysql_data_source` to something like `db_cluster=mysql-1` and `environment=prod`. This assumes you have configured and applied Fields as described in Step 1: Configure Fields of the Sumo Logic of the Collect Logs and Metrics for MySQL topic. - - 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 "MySQL" folder on the **Monitors** page. To change the name of the folder, update the monitor folder name in the `folder` variable in the `mysql.auto.tfvars` file. - -5. If you want the alerts to send email or connection notifications, edit the `mysql_notifications.auto.tfvars` file to populate the `connection_notifications` and `email_notifications` sections. Examples are provided below. - -In the variable definition below, replace `` 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). - -```sql title="Pagerduty connection example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -For information about overriding the payload for different connection types, see [Set Up Webhook Connections](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```sql title="Email notifications example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -6. Install Monitors. - 1. Navigate to the `terraform-sumologic-sumo-logic-monitor/monitor_packages/mysql/` directory and run `terraform init`. This will initialize Terraform and download the required components. - 2. Run `terraform plan` to view the monitors that Terraform will create or modify. - 3. Run `terraform apply`. - - ## Installing the MySQL app Now that you have set up collection for MySQL, install the Sumo Logic app for MySQL to use the preconfigured searches and dashboards that provide insight into your data. @@ -736,9 +651,13 @@ Use this dashboard to: MySQL dashboard -## MySQL Alerts +## Create monitors for MySQL app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + -This section describes the monitors provided with the MySQL app. These monitors are built based on logs and metrics datasets and have preset thresholds based on industry best practices and recommendations. +### MySQL alerts | Monitor name | Monitor description | Alert Condition | Recovery Condition | |:------------|:-----------------------------|:----------------|:-------------------| diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index ee930d0487..d2d2c1992c 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -445,9 +445,13 @@ At this point, Telegraf should start collecting the Oracle metrics and forward t -## Oracle Alerts +## Create monitors for Oracle app -Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Oracle databases are available and performing as expected. These alerts are built, based on logs and metrics datasets, have preset thresholds based on industry best practices and recommendations. +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + + +### Oracle alerts | Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | |:------------------|:-------------|:----------------|:-----------------|:-----------------|:-------------------| @@ -474,92 +478,7 @@ Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic moni | Metrics | Oracle - User Limit Critical | This alert fires when concurrent user sessions usage is over 90% | Critical | >=90 | < 90 | | Metrics | Oracle - User Limit Warning | This alert fires when concurrent user sessions usage is over 80% | Warning | >=80 | < 80 | -## Installing Oracle Monitors - -* To install these alerts, you need to have the **Manage Monitors** role capability. -* Alerts can be installed by either importing a JSON file or a Terraform script. - -There are limits to how many alerts can be enabled - see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq) for details. - -### Method A: Importing a JSON file - -1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Oracle/Oracle.json) that describes the monitors. -2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/Oracle/Oracle.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 Oracle 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=oracle` with ``. - -Custom filter examples: - -1. For alerts applicable only to a specific cluster, your custom filter would be `db_cluster=oracle-prod.01`. -2. For alerts applicable to all clusters that start with Kafka-prod, your custom filter would be,`db_cluster=oracle-prod*`. -3. For alerts applicable to a specific cluster within a production environment, your custom filter would be: `db_cluster=oracle-1` and `environment=prod` (This assumes you have set the optional environment tag while configuring collection). -4. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -5. Click **Add**. -6. Click Import and then copy-paste the above JSON to import monitors. - -The monitors are disabled by default. Once you have installed the alerts using this method, navigate to the Oracle folder under **Monitors** to configure them. See [this](/docs/alerts/monitors) document to enable monitors to send notifications to teams or connections. See the instructions detailed in Step 4 of this [document](/docs/alerts/monitors/create-monitor). - -### Method B: Using a Terraform script - -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). -2. **[Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later**. -3. **Download the Sumo Logic Terraform package for Oracle 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/Oracle). You can either download it through the “git clone” command or as a zip file. -4. **Alert Configuration**. After the package has been extracted, navigate to the package directory **terraform-sumologic-sumo-logic-monitor/monitor_packages/Oracle/**. Edit the **Oracle.auto.tfvars** file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1. - ```bash - access_id = "" - access_key = "" - environment = "" - ``` - 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 **’oracle_data_source’**. Custom filter examples: - 1. A specific cluster ‘`db_cluster=oracle.prod.01`’. - 2. All clusters in an environment ‘`environment=prod`’. - 3. For alerts applicable to all clusters that start with oracle-prod, your custom filter would be: ‘`db_cluster=qracle-prod*`’. - 4. For alerts applicable to a specific cluster within a production environment, your custom filter would be `db_cluster=oracle-1` and `environment=prod`. (This assumes you have set the optional environment tag while configuring collection). - - 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. - - By default, the monitors are configured in a monitor folder called **Oracle**, if you would like to change the name of the folder, update the monitor folder name in “folder” key at `Oracle.auto.tfvars` file. - - If you would like the alerts to send email or connection notifications, configure these in the file `Oracle_notifications.auto.tfvars`. For configuration examples, refer to the next section. -5. **Email and Connection Notification Configuration Examples**. Modify the file **Oracle_notifications.auto.tfvars** and populate `connection_notifications` and `email_notifications` as per below examples. -```bash title="Pagerduty Connection Example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - -Replace `` 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). - -For overriding payload for different connection types, refer to this [document](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```bash title="Email Notifications Example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` -6. **Install the Alerts**. - 1. Navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/Oracle/` and run `terraform init`. This will initialize Terraform and will download the required components. - 2. Run `terraform plan` to view the monitors which will be created/modified by Terraform. - 3. Run `terraform apply`. -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 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). ## Performance Metrics Script Setup diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 85c082de31..8752d194f4 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -412,133 +412,6 @@ At this point, Telegraf should start collecting the SQL Server metrics and forwa - -## Installing Microsoft SQL Server Monitors - -This section provides instructions for installing the Microsoft SQL Server App, as well as examples of each of the App dashboards. These instructions assume you have already set up collection as described in [Collecting Logs and Metrics for the Microsoft SQL Server](#collecting-logs-and-metrics-for-the-microsoft-sql-server-app). - - -### Pre-Packaged Alerts - -Sumo Logic has provided out-of-the-box alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you monitor your SQL Server clusters. 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, see [Alerts](#microsoft-sql-server-alerts). - -* To install these alerts, you need to have the Manage Monitors role capability. -* Alerts can be installed by either importing a JSON file or a Terraform script. -* Note: There are limits to how many alerts can be enabled - please see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md) for details. - - -### Method A: Importing a JSON file - -1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/SQLServer/SQLServer.json) that describes the monitors. -2. The [JSON](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/SQLServer/SQLServer.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 SQL Server 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=sqlserver` with ``. - -Custom filter examples: - -1. For alerts applicable only to a specific cluster, your custom filter would be: ‘`db_cluster=sqlserver-prod.01`‘ -2. For alerts applicable to all clusters that start with Kafka-prod, your custom filter would be: `db_cluster=sql-prod*` -3. For alerts applicable to a specific cluster within a production environment, your custom filter would be: `db_cluster=sql-1 `AND `environment=prod `(This assumes you have set the optional environment tag while configuring collection) -4. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**.
[**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**. -5. Click **Add**: -6. Click **Import**, then copy paste the above JSON to import monitors. - - -The monitors are disabled by default. Once you have installed the alerts using this method, navigate to the MySQL folder under **Monitors** to configure them. See [this](/docs/alerts/monitors) document to enable monitors to send notifications to teams or connections. Please see the instructions detailed in Step 4 of this [document](/docs/alerts/monitors/create-monitor). - - -### Method B: Using a Terraform script - -**Step 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). 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). - -**Step 2: [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later** - -**Step 3: Download the Sumo Logic Terraform package for SQL Server 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/SQLServer). You can either download it through the “git clone” command or as a zip file. - -**Step 4: Alert Configuration** - -After the package has been extracted, navigate to the package directory **terraform-sumologic-sumo-logic-monitor/monitor_packages/SQLServer/** - -Edit the **SQLServer.auto.tfvars** file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1 . - -```bash -access_id = "" -access_key = "" -environment = "" -``` - -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 `sqlserver_data_source`. Custom filter examples: - -1. A specific cluster `db_cluster=sqlserver.prod.01` -2. All clusters in an environment `environment=prod` -1. For alerts applicable to all clusters that start with sqlserver-prod, your custom filter would be: `db_cluster=sqlserver-prod*` -2. For alerts applicable to a specific cluster within a production environment, your custom filter would be: - -`db_cluster=sqlserver-1` and `environment=prod` (This assumes you have set the optional environment tag while configuring collection) - -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. - -By default, the monitors are configured in a monitor **folder** called “**SQLServer**”, if you would like to change the name of the folder, update the monitor folder name in “folder” key at `SQLServer.auto.tfvars` file. - -If you would like the alerts to send email or connection notifications, configure these in the file `SQLServer_notifications.auto.tfvars`. For configuration examples, refer to the next section. - -**Step 5: Email and Connection Notification Configuration Examples** - -Modify the file **SQLServer_notifications.auto.tfvars** and populate connection_notifications and email_notifications as per below examples. - -```sql title="Pagerduty Connection Example" -connection_notifications = [ - { - connection_type = "PagerDuty", - connection_id = "", - 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}}\"}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - }, - { - connection_type = "Webhook", - connection_id = "", - payload_override = "", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - - -Replace `` 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). - -For overriding payload for different connection types, refer to this [document](/docs/alerts/webhook-connections/set-up-webhook-connections). - -```sql title="Email Notifications Example" -email_notifications = [ - { - connection_type = "Email", - recipients = ["abc@example.com"], - subject = "Monitor Alert: {{TriggerType}} on {{Name}}", - time_zone = "PST", - message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}", - run_for_trigger_types = ["Critical", "ResolvedCritical"] - } - ] -``` - - -**Step 6: Install the Alerts** - -1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/**SQLServer**/ and run **terraform init.** This will initialize Terraform and will download the required components. -2. Run `terraform plan` to view the monitors which will be created/modified by Terraform. -3. Run `terraform apply`. - -**Step 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 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 - please see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md). - - ## Installing the Microsoft SQL Server App This section demonstrates how to install the SQL Server App. @@ -642,10 +515,13 @@ The **SQL Server - Backup Restore Mirroring** provides information about: Backup Restore Mirroring -## Microsoft SQL Server Alerts +## Create monitors for Microsoft SQL Server app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; -Sumo Logic provideds 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. + +### Microsoft SQL Server alerts
From a44f0eefc5064bffa9e13c92c5c126b810753f4e Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Wed, 29 Jan 2025 21:44:37 +0530 Subject: [PATCH 03/38] updating fields section --- docs/integrations/amazon-aws/dynamodb.md | 5 +---- docs/integrations/databases/cassandra.md | 4 ++-- docs/integrations/databases/couchbase.md | 4 ++-- docs/integrations/databases/mariadb.md | 4 ++-- docs/integrations/databases/memcached.md | 4 ++-- docs/integrations/databases/mongodb.md | 4 ++-- docs/integrations/databases/mysql.md | 4 ++-- docs/integrations/databases/oracle.md | 4 ++-- docs/integrations/databases/redis.md | 4 ++-- docs/integrations/microsoft-azure/sql-server.md | 4 ++-- docs/observability/application-components.md | 4 ++-- 11 files changed, 21 insertions(+), 24 deletions(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index d993d33efd..9e0ff27c65 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -109,10 +109,7 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**. ### Field in Field Schema -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**. -1. Search for the “**tablename**” field. -1. If not present, create it. Learn how to create and manage fields [here](/docs/manage/fields.md#manage-fields). - +The “**tablename**” field will be created. ### Field Extraction Rule(s) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index de7b54ea2e..a105b5a18e 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -41,7 +41,7 @@ Create the following Fields in Sumo Logic prior to configuring collection. This -If you're using Cassandra in a Kubernetes environment, create the fields: +If you're using Cassandra in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -53,7 +53,7 @@ If you're using Cassandra in a Kubernetes environment, create the fields: -If you're using Cassandra in a non-Kubernetes environment, create the fields: +If you're using Cassandra in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` * `db_system` diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index 99fa295c34..fbad306d1a 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -41,7 +41,7 @@ Create the following Fields in Sumo Logic prior to configuring the collection. T -If you're using Couchbase in a Kubernetes environment, create the fields: +If you're using Couchbase in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` @@ -51,7 +51,7 @@ If you're using Couchbase in a Kubernetes environment, create the fields: -If you're using Couchbase in a non-Kubernetes environment, create the fields: +If you're using Couchbase in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index 02a5ffa48a..13cd5e630c 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -36,7 +36,7 @@ Create the following fields in Sumo Logic before configuring the collection to e -If you're using MariaDB in a Kubernetes environment, create the fields: +If you're using MariaDB in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -48,7 +48,7 @@ If you're using MariaDB in a Kubernetes environment, create the fields: -If you're using MariaDB in a non-Kubernetes environment, create the fields: +If you're using MariaDB in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` * `db_system` diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index b04fdc895e..f75e9da763 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -67,7 +67,7 @@ Create the following Fields in Sumo Logic before configuring the collection. Thi -If you're using Memcached in a Kubernetes environment, create the fields: +If you're using Memcached in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -76,7 +76,7 @@ If you're using Memcached in a Kubernetes environment, create the fields: -If you're using Memcached in a non-Kubernetes environment, create the fields: +If you're using Memcached in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` * `db_system` diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 4d0d4273d1..241e7d1380 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -85,7 +85,7 @@ Create the following Fields in Sumo Logic prior to configuring collection. This -If you're using MongoDB in a Kubernetes environment, create the fields: +If you're using MongoDB in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` @@ -95,7 +95,7 @@ If you're using MongoDB in a Kubernetes environment, create the fields: -If you're using MongoDB in a non-Kubernetes environment, create the fields: +If you're using MongoDB in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index 4da6b5c07b..e76f7f9d95 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -154,7 +154,7 @@ Create the following Fields in Sumo Logic prior to configuring the collection. T -If you're using MySQL in a Kubernetes environment, create the fields: +If you're using MySQL in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` @@ -166,7 +166,7 @@ If you're using MySQL in a Kubernetes environment, create the fields: -If you're using MySQL in a non-Kubernetes environment, create the fields: +If you're using MySQL in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index d2d2c1992c..92b126ac25 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -44,7 +44,7 @@ This step is not needed if you are using the application components solution ter -If you're using Oracle in a Kubernetes environment, create the fields: +If you're using Oracle in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` @@ -57,7 +57,7 @@ If you're using Oracle in a Kubernetes environment, create the fields: -If you're using Oracle in a non-Kubernetes environment, create the fields: +If you're using Oracle in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index e58320c1e5..7a37d13408 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -89,7 +89,7 @@ This step is not needed if you are using the application components solution ter -If you're using Redis in a Kubernetes environment, create the fields: +If you're using Redis in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -101,7 +101,7 @@ If you're using Redis in a Kubernetes environment, create the fields: -If you're using Redis in a non-Kubernetes environment, create the fields: +If you're using Redis in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` * `db_system` diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 8752d194f4..55493388e7 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -35,7 +35,7 @@ Create the following Fields in Sumo Logic prior to configuring collection. This -If you're using SQL Server in a Kubernetes environment, create the fields: +If you're using SQL Server in a Kubernetes environment, then these fields will be created: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -46,7 +46,7 @@ If you're using SQL Server in a Kubernetes environment, create the fields: -If you're using SQL Server in a non-Kubernetes environment, create the fields: +If you're using SQL Server in a non-Kubernetes environment, then these fields will be created: * `component` * `environment` * `db_system` diff --git a/docs/observability/application-components.md b/docs/observability/application-components.md index 2874552d05..04f6824c83 100644 --- a/docs/observability/application-components.md +++ b/docs/observability/application-components.md @@ -223,9 +223,9 @@ Refer to the documentation for the app you're using. App Components Solution cur * [Oracle](/docs/integrations/databases/oracle) -### Configure Fields in Sumo Logic +### Fields in Sumo Logic -Create the following Fields in collection sources both for logs and metrics. This ensures that your logs and metrics are tagged with relevant metadata, which the app dashboards require. For information on setting up Fields, see the [Fields](/docs/manage/fields) topic. +The following Fields will be created in collection sources both for logs and metrics. This ensures that your logs and metrics are tagged with relevant metadata, which the app dashboards require. For information on setting up Fields, see the [Fields](/docs/manage/fields) topic. * `component` * `environment` From 4d9206f8edea05770f73694bdd7e300edeca2ba1 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Wed, 29 Jan 2025 22:11:45 +0530 Subject: [PATCH 04/38] updating FER section --- docs/integrations/amazon-aws/dynamodb.md | 15 +----------- docs/integrations/databases/cassandra.md | 21 +--------------- docs/integrations/databases/couchbase.md | 23 +----------------- docs/integrations/databases/mariadb.md | 22 +---------------- docs/integrations/databases/memcached.md | 22 +---------------- docs/integrations/databases/mongodb.md | 23 ++---------------- docs/integrations/databases/mysql.md | 24 +------------------ docs/integrations/databases/oracle.md | 22 +---------------- docs/integrations/databases/redis.md | 20 +--------------- .../microsoft-azure/sql-server.md | 23 +----------------- 10 files changed, 11 insertions(+), 204 deletions(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index 9e0ff27c65..5f3d5a1313 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -113,20 +113,7 @@ The “**tablename**” field will be created. ### Field Extraction Rule(s) -Create Field Extraction Rule for CloudTrail Logs. Learn how to create Field Extraction Rule [here](/docs/manage/field-extractions/create-field-extraction-rule). - -```sql -Rule Name: AwsObservabilityDynamoDBCloudTrailLogsFER -Applied at: Ingest Time -Scope (Specific Data): -account=* eventname eventsource "dynamodb.amazonaws.com" -Parse Expression: -| json "eventSource", "awsRegion", "requestParameters.tableName", "recipientAccountId" as eventSource, region, tablename, accountid nodrop -| where eventSource = "dynamodb.amazonaws.com" -| "aws/dynamodb" as namespace -| tolowercase(tablename) as tablename -| fields region, namespace, tablename, accountid -``` +Field Extraction Rule for CloudTrail Logs are automatically created for Database Application Components named as **AwsObservabilityDynamoDBCloudTrailLogsFER**. ### Centralized AWS CloudTrail Log Collection diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index a105b5a18e..2ddc20313b 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -263,26 +263,7 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -3. Add an 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 need to create a Field Extraction Rule if not already created for Proxy Application Components. This step is not needed if one is using application components solution terraform script. To do so: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the **+ Add** button on the top right of the table. - 3. The **Add Field Extraction Rule** form will appear: -4. Enter the following options: - * **Rule Name**. Enter the name as **App Observability - Database**. - * **Applied At.** Choose **Ingest Time** - * **Scope**. Select **Specific Data** - * **Scope**: Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database pod_labels_db_system=* pod_labels_db_cluster=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` -5. Click **Save** to create the rule. +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**. diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index fbad306d1a..06c90348be 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -199,28 +199,7 @@ This section explains the steps to collect Couchbase logs from a Kubernetes envi ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -3. **Add a FER to normalize the fields in Kubernetes environments**. This step is not needed if using application components solution terraform script. Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we need to create a Field Extraction Rule if not already created for Proxy Application Components. To do so: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the **+ Add Rule** button on the top right of the table. - 3. The **Add Field Extraction Rule** form will appear: - 4. Enter the following options: - * **Rule Name**. Enter the name as **App Observability - Proxy**. - * **Applied At.** Choose **Ingest Time** - * **Scope**. Select **Specific Data** - * **Scope**: Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database \ - pod_labels_db_cluster=* pod_labels_db_system=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | pod_labels_db_cluster as db_cluster - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` - 5. Click **Save** to create the rule. +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**. diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index 13cd5e630c..e243086fe8 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -200,27 +200,7 @@ This section explains the steps to collect MariaDB logs from a Kubernetes enviro ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -3. **Add an FER to normalize the fields in Kubernetes environments**. This step is not needed if using application components solution terraform script. Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we need to create a Field Extraction Rule if not already created for Proxy Application Components: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the **+ Add** button on the top right of the table. - 3. The **Add Field Extraction Rule** form will appear: - 4. Enter the following options: - * **Rule Name**. Enter the name as **App Observability - database**. - * **Applied At.** Choose **Ingest Time** - * **Scope**. Select **Specific Data** - * **Scope**. Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database - pod_labels_db_cluster=* pod_labels_db_system=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` - 5. Click **Save** to create the rule. +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**. diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index f75e9da763..02426f313a 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -217,27 +217,7 @@ This section explains the steps to collect Memcached logs from a Kubernetes envi kubectl describe pod ``` 4. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -3. **Add a FER to normalize the fields in Kubernetes environments**. This step is not needed if one is using application components solution terraform script. Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we need to create a Field Extraction Rule if not already created for Proxy Application Components. To do so: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the + Add button on the top right of the table. - 3. The **Add Field Extraction Rule** form will appear: - 4. Enter the following options: - * **Rule Name**. Enter the name as **App Observability - Database**. - * **Applied At**. Choose **Ingest Time** - * **Scope**. Select **Specific Data** - * **Scope**: Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database \ - pod_labels_db_system=* pod_labels_db_cluster=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` - 5. Click **Save** to create the rule. +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**. diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 241e7d1380..71772de7ba 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -234,27 +234,8 @@ Pivoting to Tracing data from Entity Inspector is possible only for “MongoDB a kubectl describe pod ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -3. **Add an FER to normalize the fields in Kubernetes environments**. This step is not needed if one is using application components solution terraform script. Labels created in Kubernetes environments automatically are prefixed with `pod_labels`. To normalize these for our app to work, we need to create a Field Extraction Rule if not already created for Database Application Components. To do so: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the + Add button on the top right of the table. - 3. The **Add Field Extraction Rule** form will appear: - 4. Enter the following options: - * **Rule Name**. Enter the name as **App Observability - Database**. - * **Applied At**. Choose **Ingest Time** - * **Scope**. Select **Specific Data** - * **Scope**: Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database \ - pod_labels_db_system=* pod_labels_db_cluster=* - ``` - * **Parse Expression**.Enter the following parse expression: - ```sql - | if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | pod_labels_db_cluster as db_cluster - ``` -4. Click **Save** to create the rule. + + 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**. diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index e76f7f9d95..3606ce2a49 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -345,29 +345,7 @@ Sumo Logic Kubernetes collection will automatically start collecting logs from t -2. **Add an FER to normalize the fields in Kubernetes environments**. This step is not needed if using application components solution terraform script. Labels created in Kubernetes environments are automatically prefixed with pod_labels. To normalize these for our app to work, we'll create a [Field Extraction Rule](/docs/manage/field-extractions/create-field-extraction-rule), Database Application Components, assuming it does not already exist: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the **+ Add**. - 3. The **Add Field Extraction** pane appears. - 4. **Rule Name.** Enter "App Observability - Database". - 5. **Applied At**. Choose "Ingest Time". - 6. **Scope**. Select "Specific Data". - * **Scope**. Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database pod_labels_db_system=* pod_labels_db_cluster=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - | if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` - 7. Click **Save** to create the rule. - 8. To verify that logs are flowing into Sumo Logic, run this query: - ```sql - component=database db_system=mysql db_cluster= - ``` +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 **AppObservabilityMySQLDatabaseFER**. diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index 92b126ac25..741851ed50 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -252,27 +252,7 @@ annotations: 2. The Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 3. Verify logs in Sumo Logic. -**Add an FER to normalize the fields in Kubernetes environments** - -This step is not needed if you're using application components solution terraform script. Labels created in Kubernetes environments automatically are prefixed with pod_labels. To normalize these for our app to work, we need to create a Field Extraction Rule if not already created for Proxy Application Components. To do so: -1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. -1. Click the **+Add** button on the top right of the table. -1. The **Add Field Extraction Rule** form will appear. Enter the following options: - 1. **Rule Name**. Enter the name as **App Observability - database**. - 2. **Applied At**. Choose **Ingest Time**. - 3. **Scope**. Select **Specific Data**. - 4. **Scope**: Enter the following keyword search expression. - ```sql - pod_labels_environment=* pod_labels_component=database pod_labels_db_cluster=* pod_labels_db_system=* - ``` - 5. **Parse Expression**. Enter the following parse expression. - ```sql - if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if(!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` -1. Click **Save** to create the rule. +**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 **AppObservabilityOracleDatabaseFER**. diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index 7a37d13408..8a64152795 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -244,25 +244,7 @@ This section explains the steps to collect Redis logs from a Kubernetes environm kubectl describe pod ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -3. **Add an FER to normalize the fields in Kubernetes environments**. This step is not needed if using application components solution terraform script. Labels created in Kubernetes environments automatically are prefixed with `pod_labels`. To normalize these for our app to work, we need to create a Field Extraction Rule. To do so: - * [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - * Click the + Add button on the top right of the table. - * The **Add Field Extraction Rule** form will appear: - * Enter the following options: - * **Rule Name**. Enter the name as **App Observability - Database**. - * **Applied At**. Choose **Ingest Time**. - * **Scope**. Select **Specific Data**. Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database pod_labels_db_system=* pod_labels_db_cluster=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - | if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` - * Click **Save** to create the rule. +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 **AppObservabilityRedisDatabaseFER**. diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 55493388e7..44a83f9721 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -226,28 +226,7 @@ kubectl describe pod ``` 2. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 3. Verify logs in Sumo Logic. -4. Add a 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 need to create a Field Extraction Rule if not already created for Proxy Application Components. To do so: - 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Field Extraction Rules**. You can also click the **Go To...** menu at the top of the screen and select **Field Extraction Rules**. - 2. Click the **+ Add Rule** button on the top right of the table. - 3. The **Add Field Extraction Rule** form will appear. - 4. Enter the following options: - * **Rule Name**. Enter the name as **App Observability - Proxy**. - * **Applied At**. Choose **Ingest Time** - * **Scope**. Select **Specific Data** - * **Scope**. Enter the following keyword search expression: - ```sql - pod_labels_environment=* pod_labels_component=database - pod_labels_db_system=* - pod_labels_db_cluster=* - ``` - * **Parse Expression**. Enter the following parse expression: - ```sql - if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment - | pod_labels_component as component - | pod_labels_db_system as db_system - | if (!isEmpty(pod_labels_db_cluster), pod_labels_db_cluster, null) as db_cluster - ``` -5. Click **Save** to create the rule. +4. **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 **AppObservabilitySQLServerDatabaseFER**. From 1e67c7caeace406800642afdc393e001bbb7379d Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Thu, 30 Jan 2025 16:05:07 +0530 Subject: [PATCH 05/38] Fixing Fields section --- docs/integrations/amazon-aws/dynamodb.md | 7 ++- docs/integrations/databases/cassandra.md | 37 +++++----------- docs/integrations/databases/couchbase.md | 35 ++++----------- docs/integrations/databases/mariadb.md | 37 +++++----------- docs/integrations/databases/memcached.md | 34 ++++----------- docs/integrations/databases/mongodb.md | 33 ++++---------- docs/integrations/databases/mysql.md | 38 +++++----------- docs/integrations/databases/oracle.md | 43 +++++-------------- docs/integrations/databases/redis.md | 38 +++++----------- .../microsoft-azure/sql-server.md | 36 +++++----------- 10 files changed, 90 insertions(+), 248 deletions(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index 5f3d5a1313..d478fca493 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -107,9 +107,12 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**. 2. Click **Save**. -### Field in Field Schema +### Fields in Sumo Logic -The “**tablename**” field will be created. +Following fields will always be created automatically as a part of app installation process: +* `tablename` + +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Field Extraction Rule(s) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index 2ddc20313b..54aa8167f4 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -27,33 +27,10 @@ The Sumo Logic app for Cassandra supports metrics generated by the [Jolokia2 plu This section provides instructions for configuring log and metric collection for the Sumo Logic app for Cassandra. -### Step 1: Configure Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +### Step 1: Fields in Sumo Logic - - - - -If you're using Cassandra in a Kubernetes environment, then these fields will be created: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - - - - - -If you're using Cassandra in a non-Kubernetes environment, then these fields will be created: +Following fields will always be created automatically as a part of app installation process: * `component` * `environment` * `db_system` @@ -62,9 +39,15 @@ If you're using Cassandra in a non-Kubernetes environment, then these fields wil * `db_cluster_address` * `db_cluster_port` - - +If you're using Cassandra in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for Cassandra diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index 06c90348be..a2f043031e 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -27,40 +27,23 @@ Telegraf 1.14 default of Kubernetes Collection will not work. This section provides instructions for configuring log and metric collection for the Sumo Logic app for Couchbase. -### Step 1: Configure Fields in Sumo Logic +### Step 1: Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring the collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - - - - - -If you're using Couchbase in a Kubernetes environment, then these fields will be created: +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `pod` +If you're using Couchbase in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` * `pod_labels_db_cluster` - - -If you're using Couchbase in a non-Kubernetes environment, then these fields will be created: - -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `pod` - - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for Couchbase diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index e243086fe8..f329ff999c 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -22,21 +22,17 @@ This app is tested with the following MariaDB versions: Configuring log and metric collection for the MariaDB app includes the following tasks. -### Step 1: Configure Fields in Sumo Logic +### Step 1: Fields in Sumo Logic -Create the following fields in Sumo Logic before configuring the collection to ensure that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - - - - +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` -If you're using MariaDB in a Kubernetes environment, then these fields will be created: +If you're using MariaDB in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -45,20 +41,7 @@ If you're using MariaDB in a Kubernetes environment, then these fields will be c * `pod_labels_db_cluster_port` - - - -If you're using MariaDB in a non-Kubernetes environment, then these fields will be created: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - - - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index 02426f313a..1dfaab4989 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -52,40 +52,22 @@ Jun 23 07:35:01 node03 memcached: \ Configuring log and metric collection for the Memcached app includes the following tasks. +### Step 1: Fields in Sumo Logic -### Step 1: Configure Fields in Sumo Logic - -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). - - - - - -If you're using Memcached in a Kubernetes environment, then these fields will be created: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` - - - - -If you're using Memcached in a non-Kubernetes environment, then these fields will be created: +Following fields will always be created automatically as a part of app installation process: * `component` * `environment` * `db_system` * `db_cluster` * `pod` - - +If you're using Memcached in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Logs and Metrics Collection for Memcached diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 71772de7ba..bc60cd8539 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -71,39 +71,22 @@ environment=* db_cluster=* db_system=mongodb | json "log" as _rawlog nodrop This section provides instructions for configuring log and metric collection for the Sumo Logic app for MongoDB. -### Step 1: Configure Fields in Sumo Logic +### Step 1: Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - - - - - -If you're using MongoDB in a Kubernetes environment, then these fields will be created: +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +If you're using MongoDB in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` * `pod_labels_db_cluster` - - - -If you're using MongoDB in a non-Kubernetes environment, then these fields will be created: - -* `component` -* `environment` -* `db_system` -* `db_cluster` - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for MongoDB diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index 3606ce2a49..53801966c2 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -140,22 +140,17 @@ db_system=mysql db_cluster={{db_cluster}} "User@Host" "Query_time" Configuring log and metric collection for the MySQL app includes the following tasks. -### Step 1: Configure Fields in Sumo Logic +### Step 1: Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring the collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - - - - - -If you're using MySQL in a Kubernetes environment, then these fields will be created: +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` +If you're using MySQL in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -163,20 +158,7 @@ If you're using MySQL in a Kubernetes environment, then these fields will be cre * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` - - - -If you're using MySQL in a non-Kubernetes environment, then these fields will be created: - -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure MySQL Logs and Metrics Collection diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index 741851ed50..0a02205b6c 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -26,26 +26,17 @@ This app is tested with the following Oracle versions: This section provides instructions for configuring logs and metrics collection for the Sumo Logic app for the Oracle. -### Step 1: Configure Fields in Sumo Logic +### Step 1: Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring the collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - -:::note -This step is not needed if you are using the application components solution terraform script. -::: - - - - - -If you're using Oracle in a Kubernetes environment, then these fields will be created: +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` +If you're using Oracle in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -53,21 +44,7 @@ If you're using Oracle in a Kubernetes environment, then these fields will be cr * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` - - - - -If you're using Oracle in a non-Kubernetes environment, then these fields will be created: - -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Oracle Logs and Metrics Collection diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index 8a64152795..83a12d62a7 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -71,25 +71,19 @@ This sample Query is from the the **Redis - Logs** dashboard > **Logs** panel. This section provides instructions for configuring log and metric collection for the Sumo Logic app for Redis. Configuring log and metric collection for the Redis ULM app includes the following tasks: -### Step 1: Configure Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +### Step 1: Fields in Sumo Logic -:::note -This step is not needed if you are using the application components solution terraform script. -::: - - +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` - -If you're using Redis in a Kubernetes environment, then these fields will be created: +If you're using Redis in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -98,20 +92,8 @@ If you're using Redis in a Kubernetes environment, then these fields will be cre * `pod_labels_db_cluster_port` - - - -If you're using Redis in a non-Kubernetes environment, then these fields will be created: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for Redis diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 44a83f9721..5bf18efd8a 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -21,21 +21,17 @@ This App has been tested with following SQL Server versions: This section provides instructions for configuring a local file source to collect SQL Server ERRORLOG data, and a script source to collect SQL Server performance metrics. A sample log message is also provided. -### Step 1: Configure Fields in Sumo Logic +### Step 1: Fields in Sumo Logic -Create the following Fields in Sumo Logic prior to configuring collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - - - - +Following fields will always be created automatically as a part of app installation process: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` -If you're using SQL Server in a Kubernetes environment, then these fields will be created: +If you're using SQL Server in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -43,19 +39,7 @@ If you're using SQL Server in a Kubernetes environment, then these fields will b * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` - - - -If you're using SQL Server in a non-Kubernetes environment, then these fields will be created: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - - - +For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Collect Logs and Metrics Sumo Logic supports collection of logs and metrics data from SQL Server in both Kubernetes and non-Kubernetes environments. Click on the appropriate tabs below based on the environment where your SQL Server clusters are hosted. From dde2b09c8cb2ce0a77e5f3bf22f1fe497feadc94 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Mon, 3 Feb 2025 10:15:45 +0530 Subject: [PATCH 06/38] Addressing review comments from PR #5017 --- docs/integrations/amazon-aws/dynamodb.md | 6 ++--- docs/integrations/databases/cassandra.md | 21 ++++++++++++----- docs/integrations/databases/couchbase.md | 23 +++++++++++++------ docs/integrations/databases/mariadb.md | 19 +++++++++++---- docs/integrations/databases/memcached.md | 18 +++++++++++---- docs/integrations/databases/mongodb.md | 18 +++++++++++---- docs/integrations/databases/mysql.md | 18 +++++++++++---- docs/integrations/databases/oracle.md | 18 +++++++++++---- docs/integrations/databases/redis.md | 18 +++++++++++---- .../microsoft-azure/sql-server.md | 20 ++++++++++++---- docs/observability/application-components.md | 6 +++-- 11 files changed, 132 insertions(+), 53 deletions(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index d478fca493..e0b3c5660f 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -107,12 +107,12 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**. 2. Click **Save**. -### Fields in Sumo Logic +### Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `tablename` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Field Extraction Rule(s) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index 54aa8167f4..d457f08d51 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -28,9 +28,9 @@ The Sumo Logic app for Cassandra supports metrics generated by the [Jolokia2 plu This section provides instructions for configuring log and metric collection for the Sumo Logic app for Cassandra. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` @@ -39,7 +39,7 @@ Following fields will always be created automatically as a part of app installat * `db_cluster_address` * `db_cluster_port` -If you're using Cassandra in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +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: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -47,7 +47,7 @@ If you're using Cassandra in a Kubernetes environment, these additional fields w * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for Cassandra @@ -246,7 +246,9 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -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**. + +
**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**. +
 @@ -621,13 +623,20 @@ Use this dashboard to: ## Create monitors for Cassandra app +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). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Cassandra Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + + ### Cassandra Alerts -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. | Alert Name | Alert Description | Alert Condition | Recover Condition | |:-----------|:--------------|:-----------|:------------| diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index a2f043031e..1797707c51 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -27,23 +27,23 @@ Telegraf 1.14 default of Kubernetes Collection will not work. This section provides instructions for configuring log and metric collection for the Sumo Logic app for Couchbase. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` * `db_cluster` * `pod` -If you're using Couchbase in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +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: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` * `pod_labels_db_cluster` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for Couchbase @@ -182,7 +182,9 @@ This section explains the steps to collect Couchbase logs from a Kubernetes envi ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -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**. + +
**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**. +
 @@ -456,7 +458,7 @@ The **Couchbase - Events** dashboard provides insights into events from couchba Use this dashboard to: * To audit the activities happening in the cluster. This helps to determine what activities have occurred in the system, helping to control system security. -Cassandra dashboards +Couchbase dashboards ### HTTP Access @@ -465,14 +467,21 @@ The **Couchbase - HTTP Access** dashboard provides insights into HTTP Rest API Use this dashboard to: * To understand user behavior accessing clusters and servers through Rest API. -Cassandra dashboards +Couchbase dashboards ## Create monitors for Couchbase app +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). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Couchbase Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### Couchbase alerts
diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index f329ff999c..f3ff064a4b 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -22,9 +22,9 @@ This app is tested with the following MariaDB versions: Configuring log and metric collection for the MariaDB app includes the following tasks. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` @@ -32,7 +32,7 @@ Following fields will always be created automatically as a part of app installat * `db_cluster_address` * `db_cluster_port` -If you're using MariaDB in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +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: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -41,7 +41,7 @@ If you're using MariaDB in a Kubernetes environment, these additional fields wil * `pod_labels_db_cluster_port` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection @@ -183,9 +183,11 @@ This section explains the steps to collect MariaDB logs from a Kubernetes enviro ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -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**. +
**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**. +
+ @@ -526,10 +528,17 @@ Use this dashboard to: ## Create monitors for MariaDB app +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). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the MariaDB Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### MariaDB alerts | Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index 1dfaab4989..5c4285f765 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -52,22 +52,22 @@ Jun 23 07:35:01 node03 memcached: \ Configuring log and metric collection for the Memcached app includes the following tasks. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` * `db_cluster` * `pod` -If you're using Memcached in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +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: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` * `pod_labels_db_cluster` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Logs and Metrics Collection for Memcached @@ -199,8 +199,9 @@ This section explains the steps to collect Memcached logs from a Kubernetes envi kubectl describe pod ``` 4. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -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**. +
**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**. +
 @@ -361,10 +362,17 @@ The **Memcached - Logs** dashboard helps you quickly analyze your Memcached erro ## Create monitors for Memcached app +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). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Memcached Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### Memcached alerts
diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index bc60cd8539..5205ca3fc2 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -71,22 +71,22 @@ environment=* db_cluster=* db_system=mongodb | json "log" as _rawlog nodrop This section provides instructions for configuring log and metric collection for the Sumo Logic app for MongoDB. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` * `db_cluster` -If you're using MongoDB in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +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: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` * `pod_labels_db_cluster` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for MongoDB @@ -218,7 +218,8 @@ Pivoting to Tracing data from Entity Inspector is possible only for “MongoDB a ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. - 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**. +
**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**. +
@@ -460,10 +461,17 @@ Use this dashboard to: ## Create monitors for MongoDB app +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). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Couchbase Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### MongoDB alerts | Name | Description | Trigger Type | Alert Conditions | Recover Conditions | diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index 53801966c2..cb306deb75 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -140,9 +140,9 @@ db_system=mysql db_cluster={{db_cluster}} "User@Host" "Query_time" Configuring log and metric collection for the MySQL app includes the following tasks. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` @@ -150,7 +150,7 @@ Following fields will always be created automatically as a part of app installat * `db_cluster_address` * `db_cluster_port` -If you're using MySQL in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +Additionally, if you are using MySQL in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -158,7 +158,7 @@ If you're using MySQL in a Kubernetes environment, these additional fields will * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure MySQL Logs and Metrics Collection @@ -327,7 +327,8 @@ Sumo Logic Kubernetes collection will automatically start collecting logs from t -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 **AppObservabilityMySQLDatabaseFER**. +
**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 **AppObservabilityMySQLDatabaseFER**. +
 @@ -613,10 +614,17 @@ Use this dashboard to: ## Create monitors for MySQL app +Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an MySQL 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 [MySQL Alerts](/docs/integrations/databases/mysql#mysql-alerts). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the MySQL Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### MySQL alerts | Monitor name | Monitor description | Alert Condition | Recovery Condition | diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index 0a02205b6c..33182f4075 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -26,9 +26,9 @@ This app is tested with the following Oracle versions: This section provides instructions for configuring logs and metrics collection for the Sumo Logic app for the Oracle. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` @@ -36,7 +36,7 @@ Following fields will always be created automatically as a part of app installat * `db_cluster_address` * `db_cluster_port` -If you're using Oracle in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +Additionally, if you are using Oracle in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -44,7 +44,7 @@ If you're using Oracle in a Kubernetes environment, these additional fields will * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Oracle Logs and Metrics Collection @@ -229,7 +229,8 @@ annotations: 2. The Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 3. Verify logs in Sumo Logic. -**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 **AppObservabilityOracleDatabaseFER**. +
**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 **AppObservabilityOracleDatabaseFER**. +
 @@ -404,10 +405,17 @@ At this point, Telegraf should start collecting the Oracle metrics and forward t ## Create monitors for Oracle app +Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Oracle 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 [Oracle Alerts](/docs/integrations/databases/oracle#oracle-alerts). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Oracle Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### Oracle alerts | Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index 83a12d62a7..bb9252c026 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -72,9 +72,9 @@ This sample Query is from the the **Redis - Logs** dashboard > **Logs** panel. This section provides instructions for configuring log and metric collection for the Sumo Logic app for Redis. Configuring log and metric collection for the Redis ULM app includes the following tasks: -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` @@ -83,7 +83,7 @@ Following fields will always be created automatically as a part of app installat * `db_cluster_port` -If you're using Redis in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +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: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -93,7 +93,7 @@ If you're using Redis in a Kubernetes environment, these additional fields will -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Configure Collection for Redis @@ -226,7 +226,9 @@ This section explains the steps to collect Redis logs from a Kubernetes environm kubectl describe pod ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -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 **AppObservabilityRedisDatabaseFER**. + +
**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 **AppObservabilityRedisDatabaseFER**. +
 @@ -475,10 +477,16 @@ Use this dashboard to: ## Create monitors for Redis app +Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Redis 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 [Redis Alerts](/docs/integrations/databases/redis#redis-alerts). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Redis Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: ### Redis alerts
diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 5bf18efd8a..d962f0ae69 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -21,9 +21,9 @@ This App has been tested with following SQL Server versions: This section provides instructions for configuring a local file source to collect SQL Server ERRORLOG data, and a script source to collect SQL Server performance metrics. A sample log message is also provided. -### Step 1: Fields in Sumo Logic +### Step 1: Configure fields in Sumo Logic -Following fields will always be created automatically as a part of app installation process: +As part of the app installation process, the following fields will created by default: * `component` * `environment` * `db_system` @@ -31,7 +31,8 @@ Following fields will always be created automatically as a part of app installat * `db_cluster_address` * `db_cluster_port` -If you're using SQL Server in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process: +Additionally, if you are using SQL Server in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process: + * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -39,7 +40,7 @@ If you're using SQL Server in a Kubernetes environment, these additional fields * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). ### Step 2: Collect Logs and Metrics Sumo Logic supports collection of logs and metrics data from SQL Server in both Kubernetes and non-Kubernetes environments. Click on the appropriate tabs below based on the environment where your SQL Server clusters are hosted. @@ -210,7 +211,9 @@ kubectl describe pod ``` 2. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 3. Verify logs in Sumo Logic. -4. **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 **AppObservabilitySQLServerDatabaseFER**. + +
**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 **AppObservabilitySQLServerDatabaseFER**. +
@@ -480,10 +483,17 @@ The **SQL Server - Backup Restore Mirroring** provides information about: ## Create monitors for Microsoft SQL Server app +Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an SQL Server 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 [SQL Server Alerts](/docs/integrations/microsoft-azure/sql-server#microsoft-sql-server-alerts). + import CreateMonitors from '../../reuse/apps/create-monitors.md'; +:::note +- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the SQL Server Alerts. +- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). +::: + ### Microsoft SQL Server alerts
diff --git a/docs/observability/application-components.md b/docs/observability/application-components.md index 04f6824c83..73bf3bd8b5 100644 --- a/docs/observability/application-components.md +++ b/docs/observability/application-components.md @@ -223,9 +223,9 @@ Refer to the documentation for the app you're using. App Components Solution cur * [Oracle](/docs/integrations/databases/oracle) -### Fields in Sumo Logic +### Configure fields in Sumo Logic -The following Fields will be created in collection sources both for logs and metrics. This ensures that your logs and metrics are tagged with relevant metadata, which the app dashboards require. For information on setting up Fields, see the [Fields](/docs/manage/fields) topic. +As part of the app installation process, the following fields will created by default: * `component` * `environment` @@ -234,6 +234,8 @@ The following Fields will be created in collection sources both for logs and met * `db_cluster_address` * `db_cluster_port` +To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). + ### Configuring or updating email notifications 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 by [adding a monitor](/docs/alerts/monitors/create-monitor). From 5e56bf69fd0d735cb9727fed623fbde659766f3a Mon Sep 17 00:00:00 2001 From: Amee Lepcha Date: Mon, 3 Feb 2025 16:04:31 +0530 Subject: [PATCH 07/38] Update sql-server.md --- docs/integrations/microsoft-azure/sql-server.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index d962f0ae69..9d2bce3f2b 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -213,7 +213,6 @@ kubectl describe pod 3. Verify logs in Sumo Logic.
**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 **AppObservabilitySQLServerDatabaseFER**. -
From 35947f8ee3b26f05c8f40acdd0a47ceb48f80149 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:55:53 +0530 Subject: [PATCH 08/38] Update docs/integrations/amazon-aws/dynamodb.md Co-authored-by: Amee Lepcha --- docs/integrations/amazon-aws/dynamodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index e0b3c5660f..a37a1c6565 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -109,7 +109,7 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**. ### Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `tablename` To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). From 11df94af3db42991f7ecf94bd050ccaf40771fd2 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:56:04 +0530 Subject: [PATCH 09/38] Update docs/integrations/amazon-aws/dynamodb.md Co-authored-by: Amee Lepcha --- docs/integrations/amazon-aws/dynamodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index a37a1c6565..01c3e1d1fe 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -112,7 +112,7 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**. As part of the app installation process, the following fields will be created by default: * `tablename` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Field Extraction Rule(s) From c025cb1114d3792b3d67558a81835b6ab74cf640 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:56:16 +0530 Subject: [PATCH 10/38] Update docs/integrations/amazon-aws/dynamodb.md Co-authored-by: Amee Lepcha --- docs/integrations/amazon-aws/dynamodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index 01c3e1d1fe..471a875639 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -116,7 +116,7 @@ For information on setting up fields, see [Fields](/docs/manage/fields). ### Field Extraction Rule(s) -Field Extraction Rule for CloudTrail Logs are automatically created for Database Application Components named as **AwsObservabilityDynamoDBCloudTrailLogsFER**. +A Field Extraction Rule for CloudTrail Logs is automatically created for Database Application Components, named **AwsObservabilityDynamoDBCloudTrailLogsFER**. ### Centralized AWS CloudTrail Log Collection From 21f2c0c08628c181ac120db8e5e383a58ff2deb4 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:56:24 +0530 Subject: [PATCH 11/38] Update docs/integrations/databases/cassandra.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/cassandra.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index d457f08d51..a771634c95 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -39,7 +39,7 @@ As part of the app installation process, the following fields will created by de * `db_cluster_address` * `db_cluster_port` -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: +Additionally, if you're using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` From d2b277949d95314e4ae0f23220b8271fe76b6c94 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:56:34 +0530 Subject: [PATCH 12/38] Update docs/integrations/databases/cassandra.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/cassandra.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index a771634c95..cc765991d2 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -47,7 +47,7 @@ Additionally, if you're using Redis in the Kubernetes environment, the following * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Collection for Cassandra From 87390a5d99bc2eb1b00a0bbb718b00b475a4dc44 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:56:55 +0530 Subject: [PATCH 13/38] Update docs/integrations/databases/cassandra.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/cassandra.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index cc765991d2..e50b2a208d 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -247,7 +247,7 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra 6. Verify logs in Sumo Logic. -
**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**. +
**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, a Field Extraction Rule named **AppObservabilityCassandraDatabaseFER** is automatically created for Database Application Components.
From 51d7c7eade1d8e3ee68139c9f2efc5d04ad716f7 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:57:12 +0530 Subject: [PATCH 14/38] Update docs/integrations/databases/couchbase.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/couchbase.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index 1797707c51..a7f2467ea4 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -36,7 +36,7 @@ As part of the app installation process, the following fields will created by de * `db_cluster` * `pod` -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: +Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` From 8332e5ecba90f56d25245956c88d35194d468d83 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:57:25 +0530 Subject: [PATCH 15/38] Update docs/integrations/databases/couchbase.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/couchbase.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index a7f2467ea4..23b87f0f5e 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -43,7 +43,7 @@ Additionally, if you are using Redis in the Kubernetes environment, the followin * `pod_labels_db_cluster` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Collection for Couchbase From c02a5140fa3f9757f042f0c3c728e740c0628532 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:57:39 +0530 Subject: [PATCH 16/38] Update docs/integrations/databases/couchbase.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/couchbase.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index 23b87f0f5e..27b38b9364 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -183,7 +183,7 @@ This section explains the steps to collect Couchbase logs from a Kubernetes envi 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 6. Verify logs in Sumo Logic. -
**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**. +
**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, a Field Extraction Rule named **AppObservabilityCouchbaseDatabaseFER** is automatically created for Database Application Components.
From 871dc6d7c9b1eeac0969c1dafcca27e01789a3f7 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:57:55 +0530 Subject: [PATCH 17/38] Update docs/integrations/databases/mariadb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mariadb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index f3ff064a4b..b5d9b1b770 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -32,7 +32,7 @@ As part of the app installation process, the following fields will created by de * `db_cluster_address` * `db_cluster_port` -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: +Additionally, if you are using MariaDB in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` From 3b6ae78208ce17f221222e1d82b92fd17eb6c444 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:58:06 +0530 Subject: [PATCH 18/38] Update docs/integrations/microsoft-azure/sql-server.md Co-authored-by: Amee Lepcha --- docs/integrations/microsoft-azure/sql-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 9d2bce3f2b..e21e8f5c68 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -23,7 +23,7 @@ This section provides instructions for configuring a local file source to collec ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` From 6d71bdddf0ad3d4abbd8bb173dea047bacdd434f Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:58:15 +0530 Subject: [PATCH 19/38] Update docs/observability/application-components.md Co-authored-by: Amee Lepcha --- docs/observability/application-components.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/observability/application-components.md b/docs/observability/application-components.md index 73bf3bd8b5..72181b0807 100644 --- a/docs/observability/application-components.md +++ b/docs/observability/application-components.md @@ -225,7 +225,7 @@ Refer to the documentation for the app you're using. App Components Solution cur ### Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` From 50fb40c199f8f00d1ad22af328312ec907b8426b Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:58:27 +0530 Subject: [PATCH 20/38] Update docs/integrations/databases/mysql.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mysql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index cb306deb75..99ef7e04eb 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -142,7 +142,7 @@ Configuring log and metric collection for the MySQL app includes the following t ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` From cf2dcbcb611032c3df2f7b7eb94dcacf86034534 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:58:35 +0530 Subject: [PATCH 21/38] Update docs/integrations/databases/redis.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/redis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index bb9252c026..6c7a1f97e1 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -74,7 +74,7 @@ This section provides instructions for configuring log and metric collection for ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` From 75aeeb872162ed0ec3ec6d060ac02e71c6c69da3 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:58:49 +0530 Subject: [PATCH 22/38] Update docs/integrations/databases/oracle.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/oracle.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index 33182f4075..96df51fef2 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -28,7 +28,7 @@ This section provides instructions for configuring logs and metrics collection f ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` From b10a1cfe0272b1d44b094eb7a4954d928980eefe Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:59:08 +0530 Subject: [PATCH 23/38] Update docs/integrations/databases/mariadb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mariadb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index b5d9b1b770..10e8d7e91b 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -41,7 +41,7 @@ Additionally, if you are using MariaDB in the Kubernetes environment, the follow * `pod_labels_db_cluster_port` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Collection From a5052b0fde7fabde1ae00a29b14db1f4119024be Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 09:59:23 +0530 Subject: [PATCH 24/38] Update docs/integrations/databases/mariadb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mariadb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index 10e8d7e91b..f8bcf84c39 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -185,7 +185,7 @@ This section explains the steps to collect MariaDB logs from a Kubernetes enviro 6. Verify logs in Sumo Logic. -
**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**. +
**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, a Field Extraction Rule named **AppObservabilityMariaDBDatabaseFER** is automatically created for Database Application Components.
From aec6c18ab9e4335aaea2a5d22a1b55b3734681d4 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:01:05 +0530 Subject: [PATCH 25/38] Update docs/integrations/databases/memcached.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/memcached.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index 5c4285f765..685c65f26f 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -61,7 +61,7 @@ As part of the app installation process, the following fields will created by de * `db_cluster` * `pod` -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: +Additionally, if you are using Memcached in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` From 593c49fcb3ec458591671053fd8588e21b21d890 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:01:22 +0530 Subject: [PATCH 26/38] Update docs/integrations/databases/memcached.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/memcached.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index 685c65f26f..d4249ed440 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -67,7 +67,7 @@ Additionally, if you are using Memcached in the Kubernetes environment, the foll * `pod_labels_db_system` * `pod_labels_db_cluster` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Logs and Metrics Collection for Memcached From 6d149e179019b47c08c77482b99290195728341c Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:01:44 +0530 Subject: [PATCH 27/38] Update docs/integrations/databases/memcached.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/memcached.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index d4249ed440..cf15213d60 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -54,7 +54,7 @@ Configuring log and metric collection for the Memcached app includes the followi ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` From ead43891d015c31adb7b132f55d13a0c8d299f8e Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:01:59 +0530 Subject: [PATCH 28/38] Update docs/integrations/databases/mongodb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mongodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 5205ca3fc2..f26ad9cf02 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -73,7 +73,7 @@ This section provides instructions for configuring log and metric collection for ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` From 534d2ac8174abe4abc29dea83a1fb51a99ff0d42 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:02:13 +0530 Subject: [PATCH 29/38] Update docs/integrations/databases/mongodb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mongodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index f26ad9cf02..4f9b45fc23 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -79,7 +79,7 @@ As part of the app installation process, the following fields will be created by * `db_system` * `db_cluster` -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: +Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` From fbccf2a5ac20b1f2c254d28bfcea178b7078f86c Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:02:26 +0530 Subject: [PATCH 30/38] Update docs/integrations/databases/mongodb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mongodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 4f9b45fc23..9ee777d8d5 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -86,7 +86,7 @@ Additionally, if you are using Redis in the Kubernetes environment, the followin * `pod_labels_db_cluster` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Collection for MongoDB From 59911bbab0f34ba3d39280e27de2bad83aa572f3 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:02:41 +0530 Subject: [PATCH 31/38] Update docs/integrations/databases/mongodb.md Co-authored-by: Amee Lepcha --- docs/integrations/databases/mongodb.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index 9ee777d8d5..cbb19c472d 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -218,7 +218,7 @@ Pivoting to Tracing data from Entity Inspector is possible only for “MongoDB a ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -
**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**. +
**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, a Field Extraction Rule named **AppObservabilityMongoDBDatabaseFER** is automatically created for Database Application Components.
From efc20dd2230ff0a7a33f269f8b732936fb5cb878 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:03:51 +0530 Subject: [PATCH 32/38] Apply suggestions from code review Co-authored-by: Amee Lepcha --- docs/integrations/databases/mysql.md | 6 +++--- docs/integrations/databases/oracle.md | 6 +++--- docs/integrations/databases/redis.md | 6 +++--- docs/integrations/microsoft-azure/sql-server.md | 6 +++--- docs/observability/application-components.md | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index 99ef7e04eb..ea542b0df2 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -150,7 +150,7 @@ As part of the app installation process, the following fields will be created by * `db_cluster_address` * `db_cluster_port` -Additionally, if you are using MySQL in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process: +Additionally, if you are using MySQL in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -158,7 +158,7 @@ Additionally, if you are using MySQL in the Kubernetes environment, these follow * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure MySQL Logs and Metrics Collection @@ -327,7 +327,7 @@ Sumo Logic Kubernetes collection will automatically start collecting logs from t -
**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 **AppObservabilityMySQLDatabaseFER**. +
**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, a Field Extraction Rule named **AppObservabilityMySQLDatabaseFER** is automatically created for Database Application Components.
diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index 96df51fef2..269a2be62c 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -36,7 +36,7 @@ As part of the app installation process, the following fields will be created by * `db_cluster_address` * `db_cluster_port` -Additionally, if you are using Oracle in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process: +Additionally, if you are using Oracle in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -44,7 +44,7 @@ Additionally, if you are using Oracle in the Kubernetes environment, these follo * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Oracle Logs and Metrics Collection @@ -229,7 +229,7 @@ annotations: 2. The Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 3. Verify logs in Sumo Logic. -
**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 **AppObservabilityOracleDatabaseFER**. +
**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, a Field Extraction Rule named **AppObservabilityOracleDatabaseFER** is automatically created for Database Application Components.
diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index 6c7a1f97e1..e716997814 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -83,7 +83,7 @@ As part of the app installation process, the following fields will be created by * `db_cluster_port` -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: +Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` * `pod_labels_db_system` @@ -93,7 +93,7 @@ Additionally, if you are using Redis in the Kubernetes environment, these follow -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Configure Collection for Redis @@ -227,7 +227,7 @@ This section explains the steps to collect Redis logs from a Kubernetes environm ``` 5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -
**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 **AppObservabilityRedisDatabaseFER**. +
**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, a Field Extraction Rule named **AppObservabilityRedisDatabaseFER** is automatically created for Database Application Components.
diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index e21e8f5c68..7f16ecf547 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -31,7 +31,7 @@ As part of the app installation process, the following fields will be created by * `db_cluster_address` * `db_cluster_port` -Additionally, if you are using SQL Server in the Kubernetes environment, these following additional fields will be created by default as a part of the app installation process: +Additionally, if you are using SQL Server in the Kubernetes environment, the following additional fields will be created by default during the app installation process: * `pod_labels_component` * `pod_labels_environment` @@ -40,7 +40,7 @@ Additionally, if you are using SQL Server in the Kubernetes environment, these f * `pod_labels_db_cluster_address` * `pod_labels_db_cluster_port` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Step 2: Collect Logs and Metrics Sumo Logic supports collection of logs and metrics data from SQL Server in both Kubernetes and non-Kubernetes environments. Click on the appropriate tabs below based on the environment where your SQL Server clusters are hosted. @@ -212,7 +212,7 @@ kubectl describe pod 2. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. 3. Verify logs in Sumo Logic. -
**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 **AppObservabilitySQLServerDatabaseFER**. +
**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, a Field Extraction Rule named **AppObservabilitySQLServerDatabaseFER** is automatically created for Database Application Components. diff --git a/docs/observability/application-components.md b/docs/observability/application-components.md index 72181b0807..966acec2e4 100644 --- a/docs/observability/application-components.md +++ b/docs/observability/application-components.md @@ -234,7 +234,7 @@ As part of the app installation process, the following fields will be created by * `db_cluster_address` * `db_cluster_port` -To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields). +For information on setting up fields, see [Fields](/docs/manage/fields). ### Configuring or updating email notifications From 0cb57e22eec7ad22369692bf811bc21933956623 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 10:05:57 +0530 Subject: [PATCH 33/38] Apply suggestions from code review Co-authored-by: Amee Lepcha --- docs/integrations/databases/cassandra.md | 2 +- docs/integrations/databases/couchbase.md | 2 +- docs/integrations/databases/mariadb.md | 2 +- docs/integrations/databases/memcached.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index e50b2a208d..148d663254 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -30,7 +30,7 @@ This section provides instructions for configuring log and metric collection for ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index 27b38b9364..f547f0853b 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -29,7 +29,7 @@ This section provides instructions for configuring log and metric collection for ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index f8bcf84c39..67aae2ed3c 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -24,7 +24,7 @@ Configuring log and metric collection for the MariaDB app includes the following ### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will created by default: +As part of the app installation process, the following fields will be created by default: * `component` * `environment` * `db_system` diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index cf15213d60..14a08a3bdd 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -200,7 +200,7 @@ This section explains the steps to collect Memcached logs from a Kubernetes envi ``` 4. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above. -
**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**. +
**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, a Field Extraction Rule named **AppObservabilityMemcachedDatabaseFER** is automatically created for Database Application Components.
From 0062af68a0cdc2322dbd35255433f7ea6fa3ef01 Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Tue, 4 Feb 2025 11:20:24 +0530 Subject: [PATCH 34/38] Reverting DynamoDB documentation --- docs/integrations/amazon-aws/dynamodb.md | 25 ++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/docs/integrations/amazon-aws/dynamodb.md b/docs/integrations/amazon-aws/dynamodb.md index 471a875639..aa0e3b542e 100644 --- a/docs/integrations/amazon-aws/dynamodb.md +++ b/docs/integrations/amazon-aws/dynamodb.md @@ -107,16 +107,29 @@ Namespace for **Amazon DynamoDB** Service is **AWS/DynamoDB**. 2. Click **Save**. -### Configure fields in Sumo Logic +### Field in Field Schema -As part of the app installation process, the following fields will be created by default: -* `tablename` +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**. +1. Search for the “**tablename**” field. +1. If not present, create it. Learn how to create and manage fields [here](/docs/manage/fields.md#manage-fields). -For information on setting up fields, see [Fields](/docs/manage/fields). ### Field Extraction Rule(s) -A Field Extraction Rule for CloudTrail Logs is automatically created for Database Application Components, named **AwsObservabilityDynamoDBCloudTrailLogsFER**. +Create Field Extraction Rule for CloudTrail Logs. Learn how to create Field Extraction Rule [here](/docs/manage/field-extractions/create-field-extraction-rule). + +```sql +Rule Name: AwsObservabilityDynamoDBCloudTrailLogsFER +Applied at: Ingest Time +Scope (Specific Data): +account=* eventname eventsource "dynamodb.amazonaws.com" +Parse Expression: +| json "eventSource", "awsRegion", "requestParameters.tableName", "recipientAccountId" as eventSource, region, tablename, accountid nodrop +| where eventSource = "dynamodb.amazonaws.com" +| "aws/dynamodb" as namespace +| tolowercase(tablename) as tablename +| fields region, namespace, tablename, accountid +``` ### Centralized AWS CloudTrail Log Collection @@ -209,4 +222,4 @@ Use this dashboard to: * Identify malicious IPs performing operations on DynamoDB tables using Sumo Logic Threat Intel. -Amazon DynamoDB +Amazon DynamoDB \ No newline at end of file From 4b32c89d8f8e3e8a40731a70f0203f761ec71eec Mon Sep 17 00:00:00 2001 From: Chetan Choudhary Date: Wed, 30 Apr 2025 15:21:09 +0530 Subject: [PATCH 35/38] Updating Cassandra Doc --- docs/integrations/databases/cassandra.md | 107 ++++++++++++----------- docs/reuse/apps/app-install-sc-k8s.md | 21 +++++ 2 files changed, 75 insertions(+), 53 deletions(-) create mode 100644 docs/reuse/apps/app-install-sc-k8s.md diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index 148d663254..22832ee229 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; The Cassandra app is a unified logs and metrics app that helps you monitor the availability, performance, health, and resource utilization of your Cassandra clusters. Preconfigured dashboards provide insight into cluster health, resource utilization, cache/Gossip/Memtable statistics, compaction, garbage collection, thread pools, and write paths. -## Log types +## Log types and Metrics The app supports Logs and Metrics from the open-source version of Cassandra. The app is tested on the 3.11.10 version of Cassandra. @@ -27,29 +27,7 @@ The Sumo Logic app for Cassandra supports metrics generated by the [Jolokia2 plu This section provides instructions for configuring log and metric collection for the Sumo Logic app for Cassandra. - -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `pod` -* `db_cluster_address` -* `db_cluster_port` - -Additionally, if you're using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Configure Collection for Cassandra +### Configure Collection for Cassandra -#### Configure Metrics Collection +### Configure Metrics Collection This section provides instructions for configuring metrics collection for the Sumo Logic app for Cassandra. @@ -390,7 +368,7 @@ Pivoting to Tracing data from Entity Inspector is possible only for “Cassandra Once you have finalized your telegraf.conf file, you can start or reload the telegraf service using instructions from the [doc](https://docs.influxdata.com/telegraf/v1.17/introduction/getting-started/#start-telegraf-service). At this point, Cassandra metrics should start flowing into Sumo Logic. -#### Configure Logs Collection +### Configure Logs Collection This section provides instructions for configuring log collection for Cassandra running on a non-Kubernetes environment. @@ -498,15 +476,38 @@ This step is not needed if you are using the [Application Components Solution](/ This section demonstrates how to install the Cassandra app. -import AppInstall from '../../reuse/apps/app-install.md'; +import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md'; - + + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `pod` +* `db_cluster_address` +* `db_cluster_port` + +Additionally, if you're using Cassandra in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` + +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Cassandra dashboards +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + + ### Overview -The **Cassandra - Overview** dashboard provides an at-a-glance view of Cassandra backend and frontend HTTP error codes percentage, visitor location, URLs, and clients causing errors. +The **Cassandra (Classic) - Overview** dashboard provides an at-a-glance view of Cassandra backend and frontend HTTP error codes percentage, visitor location, URLs, and clients causing errors. Use this dashboard to: * Identify Frontend and Backend Sessions percentage usage to understand active sessions. This can help you increase the session limit. @@ -518,7 +519,7 @@ Use this dashboard to: ### Cache Stats -The **Cassandra - Cache Stats** dashboard provides insight into the database cache status, schedule, and items. +The **Cassandra (Classic) - Cache Stats** dashboard provides insight into the database cache status, schedule, and items. Use this dashboard to: * Monitor Cache performance. @@ -528,7 +529,7 @@ Use this dashboard to: ### Errors and Warnings -The **Cassandra - Errors and Warnings** dashboard provides details of the database errors and warnings. +The **Cassandra (Classic) - Errors and Warnings** dashboard provides details of the database errors and warnings. Use this dashboard to: * Review errors and warnings generated by the server. @@ -538,7 +539,7 @@ Use this dashboard to: ### Gossip -The **Cassandra - Gossip** dashboard provides details about communication between various cassandra nodes. +The **Cassandra (Classic) - Gossip** dashboard provides details about communication between various cassandra nodes. Use this dashboard to: * Determine nodes with errors resulting in failures. @@ -548,7 +549,7 @@ Use this dashboard to: ### Memtable -The **Cassandra - Memtable** dashboard provides insights into memtable statistics. +The **Cassandra (Classic) - Memtable** dashboard provides insights into memtable statistics. Use this dashboard to: * Review flush activity and memtable status. @@ -557,7 +558,7 @@ Use this dashboard to: ### Resource Usage -The **Cassandra - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters. +The **Cassandra (Classic) - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters. Use this dashboard to: * Identify resource utilization. This can help you to determine whether are resources over- or under-allocated. @@ -566,7 +567,7 @@ Use this dashboard to: ### Compactions -The **Cassandra - Compactions** dashboard provides details of compactions. +The **Cassandra (Classic) - Compactions** dashboard provides details of compactions. Use this dashboard to: * Review pending/completed compactions and flushes. @@ -575,7 +576,7 @@ Use this dashboard to: ### Garbage Collection -The **Cassandra - Garbage Collection** dashboard shows key Garbage Collector statistics like the duration of the last GC run, objects collected, threads used, and memory cleared in the last GC run. +The **Cassandra (Classic) - Garbage Collection** dashboard shows key Garbage Collector statistics like the duration of the last GC run, objects collected, threads used, and memory cleared in the last GC run. Use this dashboard to: * Understand the garbage collection time. If the time keeps on increasing, you may have more CPU usage. @@ -585,7 +586,7 @@ Use this dashboard to: ### Read Path -The **Cassandra - Read Path** dashboard shows read operation statistics. +The **Cassandra (Classic) - Read Path** dashboard shows read operation statistics. Use this dashboard to: * Gather insights into read operations, cache statistics, Tombstone, and SSTTables summary. @@ -595,7 +596,7 @@ Use this dashboard to: ### Resource Usage -The **Cassandra - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters. +The **Cassandra (Classic) - Resource Usage** dashboard provides details of resource utilization across Cassandra clusters. Use this dashboard to: * Identify resource utilization. This can help you to determine resources over or under allocation. @@ -604,7 +605,7 @@ Use this dashboard to: ### Thread Pool -The **Cassandra - Thread Pool** dashboard shows thread pool statistics. +The **Cassandra (Classic) - Thread Pool** dashboard shows thread pool statistics. Use this dashboard to: * Review thread pool usage and statistics for different kinds of operations. @@ -613,7 +614,7 @@ Use this dashboard to: ### Write Path -The **Cassandra - Write Path** dashboard shows write operation statistics. +The **Cassandra (Classic) - Write Path** dashboard shows write operation statistics. Use this dashboard to: * Gather insights into write operations, cache statistics, Tombstone, and SSTTables summary. @@ -640,14 +641,14 @@ import CreateMonitors from '../../reuse/apps/create-monitors.md'; | Alert Name | Alert Description | Alert Condition | Recover Condition | |:-----------|:--------------|:-----------|:------------| -| Cassandra - Increase in Authentication Failures | This alert fires when there is an increase of Cassandra authentication failures. | >5 | `<=` 5 | -| Cassandra - Cache Hit Rate below 85 Percent | This alert fires when the cache key hit rate is below 85%. | `<`85 | `>=` 85 | -| Cassandra - High Commitlog Pending Tasks | This alert fires when there are more than 15 Commitlog tasks that are pending. | >15 | `<=` 15 | -| Cassandra - High Number of Compaction Executor Blocked Tasks | This alert fires when there are more than 15 compaction executor tasks blocked for more than 5 minutes. | >15 | `<=` 15 | -| Cassandra - Compaction Task Pending | This alert fires when there are many Cassandra compaction tasks that are pending. You might need to increase I/O capacity by adding nodes to the cluster. | >100 | `<=` 100 | -| Cassandra - High Number of Flush Writer Blocked Tasks | This alert fires when there is a high number of flush writer tasks which are blocked. | >15 | `<=` 15 | -| Cassandra - Many Compaction Tasks Are Pending | Many Cassandra compaction tasks are pending | >100 | `<=` 100 | -| Cassandra - Node Down | This alert fires when one or more Cassandra nodes are down | >0 | `<=` 0 | -| Cassandra - Blocked Repair Tasks | This alert fires when the repair tasks are blocked | >2 | `<=` 2 | -| Cassandra - Repair Tasks Pending | This alert fires when repair tasks are pending. | >2 | `<=` 2 | -| Cassandra - High Tombstone Scanning | This alert fires when tombstone scanning is very high (>1000 99th Percentile) in queries. | >1000 | `<=` 1000 | +| Cassandra (Classic) - Increase in Authentication Failures | This alert fires when there is an increase of Cassandra authentication failures. | >5 | `<=` 5 | +| Cassandra (Classic) - Cache Hit Rate below 85 Percent | This alert fires when the cache key hit rate is below 85%. | `<`85 | `>=` 85 | +| Cassandra (Classic) - High Commitlog Pending Tasks | This alert fires when there are more than 15 Commitlog tasks that are pending. | >15 | `<=` 15 | +| Cassandra (Classic) - High Number of Compaction Executor Blocked Tasks | This alert fires when there are more than 15 compaction executor tasks blocked for more than 5 minutes. | >15 | `<=` 15 | +| Cassandra (Classic) - Compaction Task Pending | This alert fires when there are many Cassandra compaction tasks that are pending. You might need to increase I/O capacity by adding nodes to the cluster. | >100 | `<=` 100 | +| Cassandra (Classic) - High Number of Flush Writer Blocked Tasks | This alert fires when there is a high number of flush writer tasks which are blocked. | >15 | `<=` 15 | +| Cassandra (Classic) - Many Compaction Tasks Are Pending | Many Cassandra compaction tasks are pending | >100 | `<=` 100 | +| Cassandra (Classic) - Node Down | This alert fires when one or more Cassandra nodes are down | >0 | `<=` 0 | +| Cassandra (Classic) - Blocked Repair Tasks | This alert fires when the repair tasks are blocked | >2 | `<=` 2 | +| Cassandra (Classic) - Repair Tasks Pending | This alert fires when repair tasks are pending. | >2 | `<=` 2 | +| Cassandra (Classic) - High Tombstone Scanning | This alert fires when tombstone scanning is very high (>1000 99th Percentile) in queries. | >1000 | `<=` 1000 | diff --git a/docs/reuse/apps/app-install-sc-k8s.md b/docs/reuse/apps/app-install-sc-k8s.md new file mode 100644 index 0000000000..0d84418556 --- /dev/null +++ b/docs/reuse/apps/app-install-sc-k8s.md @@ -0,0 +1,21 @@ +To install the app, do the following: +:::note + Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, Manage Collectors capability depending upon the different content types part of the app. +::: +1. Select **App Catalog**. +1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it. +1. Click **Install App**. + :::note + Sometimes this button says **Add Integration**. + ::: +1. Click **Next** in the **Setup Data** section. +1. In the **Configure** section of your respective app, complete the following fields. + 1. **Field Name**. If you already have collectors and sources setup, select the configured metadata field name (eg _sourcecategory) or specify other custom metadata (eg: _collector) along with its metadata **Field Value** . + 2. **Is K8S deployment involved**. Specify if resources being monitored are partially or fully deployed on Kubernetes (K8s) +1. Click **Next**. You will be redirected to the **Preview & Done** section. + +**Post-installation** + +Once your app is installed, it will appear in your **Installed Apps** folder, and dashboard panels will start to fill automatically. + +Each panel slowly fills with data matching the time range query and received since the panel was created. Results will not immediately be available, but will update with full graphs and charts over time. From e9b4d39382a400037efa4f6ef0b01e95c8175ff4 Mon Sep 17 00:00:00 2001 From: merge from main Date: Thu, 1 May 2025 08:48:55 +0530 Subject: [PATCH 36/38] Updating V2 Migrated Database apps docs to standard pattern --- docs/integrations/databases/cassandra.md | 12 +- docs/integrations/databases/couchbase.md | 70 ++++------ docs/integrations/databases/elasticsearch.md | 77 +++++------ docs/integrations/databases/mariadb.md | 71 ++++------ docs/integrations/databases/memcached.md | 55 ++++---- docs/integrations/databases/mongodb.md | 51 +++---- docs/integrations/databases/mysql.md | 57 ++++---- docs/integrations/databases/oracle.md | 126 ++++++++---------- docs/integrations/databases/postgresql.md | 89 ++++--------- docs/integrations/databases/redis.md | 78 ++++------- .../microsoft-azure/sql-server.md | 63 ++++----- docs/reuse/apps/app-install-only-k8s.md | 20 +++ 12 files changed, 310 insertions(+), 459 deletions(-) create mode 100644 docs/reuse/apps/app-install-only-k8s.md diff --git a/docs/integrations/databases/cassandra.md b/docs/integrations/databases/cassandra.md index 22832ee229..821b7556cc 100644 --- a/docs/integrations/databases/cassandra.md +++ b/docs/integrations/databases/cassandra.md @@ -474,9 +474,7 @@ At this point, Cassandra metrics and logs should start flowing into Sumo Logic. This step is not needed if you are using the [Application Components Solution](/docs/observability/application-components) Terraform script. ::: -This section demonstrates how to install the Cassandra app. - -import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md'; +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; @@ -624,18 +622,10 @@ Use this dashboard to: ## Create monitors for Cassandra app -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). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Cassandra Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - - ### Cassandra Alerts diff --git a/docs/integrations/databases/couchbase.md b/docs/integrations/databases/couchbase.md index f547f0853b..7984dd038e 100644 --- a/docs/integrations/databases/couchbase.md +++ b/docs/integrations/databases/couchbase.md @@ -27,25 +27,7 @@ Telegraf 1.14 default of Kubernetes Collection will not work. This section provides instructions for configuring log and metric collection for the Sumo Logic app for Couchbase. -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `pod` - -Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` - - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Configure Collection for Couchbase +### Configure Collection for Couchbase 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. @@ -346,32 +328,35 @@ At this point, Telegraf should start collecting the Couchbase metrics and forwar This section demonstrates how to install the Couchbase app. -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**. +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; + + -1. From the **App Catalog**, search and select the app. -2. Select the version of the service you're using and click **Add to Library**. - :::note - Version selection is not available for all apps. - ::: -3. To install the app, complete the following fields. - 1. **App Name.** You can retain the existing name, or enter a name of your choice for the app. - 2. **Data Source.** - * Choose **Enter a Custom Data Filter**, and enter a custom Couchbase cluster filter. Examples: - 1. For all Couchbase clusters `db_cluster=*` - 2. For a specific cluster: `db_cluster=couchbase.dev.01` - 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. - 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. -4. Click **Add to Library**. -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. +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `pod` +* `db_cluster_address` +* `db_cluster_port` + +Additionally, if you're using Couchbase in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` -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. +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Couchbase Dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -471,17 +456,10 @@ Use this dashboard to: ## Create monitors for Couchbase app -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). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Couchbase Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - ### Couchbase alerts
diff --git a/docs/integrations/databases/elasticsearch.md b/docs/integrations/databases/elasticsearch.md index 593dec59a2..c47256d0b9 100644 --- a/docs/integrations/databases/elasticsearch.md +++ b/docs/integrations/databases/elasticsearch.md @@ -62,42 +62,8 @@ The Elasticsearch app is a unified logs and metrics app that helps you monitor t Configuring log and metric collection for the Elasticsearch app includes the following tasks. -### Step 1: Configure Fields in Sumo Logic -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). - - - - - -If you're using Elasticsearch in a Kubernetes environment, create the fields: - -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` - - - - -If you're using Elasticsearch in a non-Kubernetes environment, create the fields: - -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `pod` - - - - -### Step 2: Configure Collection for Elasticsearch +### Configure Collection for Elasticsearch -## Installing Elasticsearch Monitors + ## Installing the Elasticsearch app -import AppInstall from '../../reuse/apps/app-install.md'; +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; - + + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `pod` +* `db_cluster_address` +* `db_cluster_port` + +Additionally, if you're using Elasticsearch in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` + +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Elasticsearch dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -533,9 +518,13 @@ The **ElasticSearch - Queries** dashboard shows Elasticsearch provides analytics elasticsearch dashboards -## Elasticsearch Alerts +## Create monitors for Elasticsearch app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + -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. +### Elasticsearch Alerts | Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | |---|---|---|---|---|---| diff --git a/docs/integrations/databases/mariadb.md b/docs/integrations/databases/mariadb.md index 67aae2ed3c..6882dea99f 100644 --- a/docs/integrations/databases/mariadb.md +++ b/docs/integrations/databases/mariadb.md @@ -22,28 +22,8 @@ This app is tested with the following MariaDB versions: Configuring log and metric collection for the MariaDB app includes the following tasks. -### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - -Additionally, if you are using MariaDB in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Configure Collection +### Configure Collection 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. @@ -398,32 +378,34 @@ At this point, Telegraf should start collecting the MariaDB metrics and forward This section demonstrates how to install the MariaDB app. To install the app: -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**. +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; -1. From the **App Catalog**, search for and select the app. -2. Select the version of the service you're using and click **Add to Library**. -:::note -Version selection is not available for all apps. -::: -3. To install the app, complete the following fields. - 1. **App Name.** You can retain the existing name, or enter a name of your choice for the app. - 2. **Data Source.** - * Choose **Enter a Custom Data Filter**, and enter a custom MariaDB cluster filter. Examples; - 1. For all MariaDB clusters, `db_cluster=*`. - 2. For a specific cluster, `db_cluster=mariadb.dev.01`. - 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. - 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. -4. Click **Add to Library**. + + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` -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. +Additionally, if you are using MariaDB in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` -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. + +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing MariaDB Dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -528,17 +510,10 @@ Use this dashboard to: ## Create monitors for MariaDB app -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). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the MariaDB Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - ### MariaDB alerts | Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | diff --git a/docs/integrations/databases/memcached.md b/docs/integrations/databases/memcached.md index 14a08a3bdd..a0010f0891 100644 --- a/docs/integrations/databases/memcached.md +++ b/docs/integrations/databases/memcached.md @@ -52,24 +52,8 @@ Jun 23 07:35:01 node03 memcached: \ Configuring log and metric collection for the Memcached app includes the following tasks. -### Step 1: Configure fields in Sumo Logic -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `pod` - -Additionally, if you are using Memcached in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Configure Logs and Metrics Collection for Memcached +### Configure Logs and Metrics Collection for Memcached + + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `pod` +* `db_cluster_address` +* `db_cluster_port` + +Additionally, if you're using Memcached in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` + + +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Memcached Dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -362,17 +366,10 @@ The **Memcached - Logs** dashboard helps you quickly analyze your Memcached erro ## Create monitors for Memcached app -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). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Memcached Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - ### Memcached alerts
diff --git a/docs/integrations/databases/mongodb.md b/docs/integrations/databases/mongodb.md index cbb19c472d..5c9b666951 100644 --- a/docs/integrations/databases/mongodb.md +++ b/docs/integrations/databases/mongodb.md @@ -71,25 +71,7 @@ environment=* db_cluster=* db_system=mongodb | json "log" as _rawlog nodrop This section provides instructions for configuring log and metric collection for the Sumo Logic app for MongoDB. -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` - -Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` - - -For information on setting up fields, see [Fields](/docs/manage/fields). - - -### Step 2: Configure Collection for MongoDB +### Configure Collection for MongoDB +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` + +Additionally, if you're using MongoDB in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` + +For information on setting up fields, see [Fields](/docs/manage/fields). + ## Viewing MongoDB Dashboards -If no events have occurred within the time range of the Panel, the Panel will be empty. +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -461,17 +461,10 @@ Use this dashboard to: ## Create monitors for MongoDB app -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). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Couchbase Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - ### MongoDB alerts | Name | Description | Trigger Type | Alert Conditions | Recover Conditions | diff --git a/docs/integrations/databases/mysql.md b/docs/integrations/databases/mysql.md index ea542b0df2..0ea22ccb45 100644 --- a/docs/integrations/databases/mysql.md +++ b/docs/integrations/databases/mysql.md @@ -140,27 +140,7 @@ db_system=mysql db_cluster={{db_cluster}} "User@Host" "Query_time" Configuring log and metric collection for the MySQL app includes the following tasks. -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - -Additionally, if you are using MySQL in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Configure MySQL Logs and Metrics Collection +### Configure MySQL Logs and Metrics Collection + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` - +Additionally, if you are using MySQL in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` + +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing MySQL dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -614,16 +611,10 @@ Use this dashboard to: ## Create monitors for MySQL app -Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an MySQL 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 [MySQL Alerts](/docs/integrations/databases/mysql#mysql-alerts). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the MySQL Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: ### MySQL alerts diff --git a/docs/integrations/databases/oracle.md b/docs/integrations/databases/oracle.md index 269a2be62c..c46193a429 100644 --- a/docs/integrations/databases/oracle.md +++ b/docs/integrations/databases/oracle.md @@ -26,28 +26,7 @@ This app is tested with the following Oracle versions: This section provides instructions for configuring logs and metrics collection for the Sumo Logic app for the Oracle. -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - -Additionally, if you are using Oracle in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - -For information on setting up fields, see [Fields](/docs/manage/fields). - - -### Step 2: Configure Oracle Logs and Metrics Collection +### Configure Oracle Logs and Metrics Collection Sumo Logic supports the collection of logs and metrics data from Oracle in both Kubernetes and non-Kubernetes environments. @@ -403,47 +382,6 @@ At this point, Telegraf should start collecting the Oracle metrics and forward t -## Create monitors for Oracle app - -Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Oracle 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 [Oracle Alerts](/docs/integrations/databases/oracle#oracle-alerts). - -import CreateMonitors from '../../reuse/apps/create-monitors.md'; - - - -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Oracle Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - -### Oracle alerts - -| Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | -|:------------------|:-------------|:----------------|:-----------------|:-----------------|:-------------------| -| Logs | Oracle - Admin Restricted Command Execution | This alert fires when the Listener is unable to resolve a command. | Warning | > 0 | `<=` 0 | -| Logs | Oracle - Archival Log Creation | This alert fires when there is an archive log creation error. | Warning | > 0 | `<=` 0 | -| Logs | Oracle - Block Corruption | This alert fires when we detect corrupted data blocks. | Warning | > 0 | `<=` 0 | -| Logs | Oracle - Database Crash | This alert fires when the database crashes. | Critical | >0 | `<=` 0 | -| Logs | Oracle - Deadlock | This alert fires when deadlocks are detected. | Warning | >5 | `<=` 0 | -| Logs | Oracle - Fatal NI Connect Error | This alert fires when we detect a "Fatal NI connect error". | Warning | >0 | `<=` 0 | -| Logs | Oracle - Internal Errors | This alert fires when internal errors are detected. | Warning | >0 | `<=` 0 | -| Logs | Oracle - Login Fail | This alert fires when we detect that a user cannot login. | Warning | >0 | `<=` 0 | -| Logs | Oracle - Possible Inappropriate Activity | This alert fires when we detect possible inappropriate activity. | Warning | >0 | `<=` 0 | -| Logs | Oracle - TNS Error | This alert fires when we detect TNS operations errors. | Critical | >0 | `<=` 0 | -| Logs | Oracle - Unable To Extend Tablespace | This alert fires when we detect that we are unable to extend tablespaces. | Warning | >0 | `<=` 0 | -| Logs | Oracle - Unauthorized Command Execution | This alert fires when we detect that a user is not authorized to execute a requested listener command in an Oracle instance. | Warning | >0 | `<=` 0 | -| Metrics | Oracle - Database Down | This alert fires when we detect that the Oracle database is down. | Critical | >0 | `<=` 0 | -| Metrics | Oracle - High CPU Usage | This alert fires when CPU usage on a node in an Oracle cluster is high. | Critical | >=80 | < 80 | -| Metrics | Oracle - Process Limit Critical | This alert fires when process CPU utilization is over 90% | Critical | >=90 | < 90 | -| Metrics | Oracle - Process Limit Warning | This alert fires when processes CPU utilization is over 80% | Warning | >=80 | < 80 | -| Metrics | Oracle - Session Critical | This alert fires when session usage is over 97% | Critical | >=97 | < 97 | -| Metrics | Oracle - Session Warning | This alert fires when session usage is over 90% | Warning | >=90 | < 90 | -| Metrics | Oracle - Tablespaces Out of Space | This alert fires when tablespace disk usage is over 90% | Critical | >=90 | < 90 | -| Metrics | Oracle - Tablespaces Space Low | This alert fires when tablespace disk usage is over 80% | Warning | >=80 | < 80 | -| Metrics | Oracle - User Limit Critical | This alert fires when concurrent user sessions usage is over 90% | Critical | >=90 | < 90 | -| Metrics | Oracle - User Limit Warning | This alert fires when concurrent user sessions usage is over 80% | Warning | >=80 | < 80 | - - ## Performance Metrics Script Setup @@ -776,18 +714,34 @@ oracle_script/sumooracle>python3 oracle-perf-monitor.py ## Installing the Oracle app -This section demonstrates how to install the Oracle app. +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; + + + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` -import AppInstall from '../../reuse/apps/app-install.md'; +Additionally, if you are using Oracle in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` - +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Oracle Dashboards -:::tip Filter with template variables +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + -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). -::: ### Overview @@ -1060,3 +1014,37 @@ The Oracle - Resource Utilization dashboard performance statistics such as Limit The **Oracle - Parallel Execution** dashboard performance statistics such as Sessions, DDL statements parallelized, PX downgraded, Background services Oracle dashboards + + +## Create monitors for Oracle app + +import CreateMonitors from '../../reuse/apps/create-monitors.md'; + + + +### Oracle alerts + +| Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition | +|:------------------|:-------------|:----------------|:-----------------|:-----------------|:-------------------| +| Logs | Oracle - Admin Restricted Command Execution | This alert fires when the Listener is unable to resolve a command. | Warning | > 0 | `<=` 0 | +| Logs | Oracle - Archival Log Creation | This alert fires when there is an archive log creation error. | Warning | > 0 | `<=` 0 | +| Logs | Oracle - Block Corruption | This alert fires when we detect corrupted data blocks. | Warning | > 0 | `<=` 0 | +| Logs | Oracle - Database Crash | This alert fires when the database crashes. | Critical | >0 | `<=` 0 | +| Logs | Oracle - Deadlock | This alert fires when deadlocks are detected. | Warning | >5 | `<=` 0 | +| Logs | Oracle - Fatal NI Connect Error | This alert fires when we detect a "Fatal NI connect error". | Warning | >0 | `<=` 0 | +| Logs | Oracle - Internal Errors | This alert fires when internal errors are detected. | Warning | >0 | `<=` 0 | +| Logs | Oracle - Login Fail | This alert fires when we detect that a user cannot login. | Warning | >0 | `<=` 0 | +| Logs | Oracle - Possible Inappropriate Activity | This alert fires when we detect possible inappropriate activity. | Warning | >0 | `<=` 0 | +| Logs | Oracle - TNS Error | This alert fires when we detect TNS operations errors. | Critical | >0 | `<=` 0 | +| Logs | Oracle - Unable To Extend Tablespace | This alert fires when we detect that we are unable to extend tablespaces. | Warning | >0 | `<=` 0 | +| Logs | Oracle - Unauthorized Command Execution | This alert fires when we detect that a user is not authorized to execute a requested listener command in an Oracle instance. | Warning | >0 | `<=` 0 | +| Metrics | Oracle - Database Down | This alert fires when we detect that the Oracle database is down. | Critical | >0 | `<=` 0 | +| Metrics | Oracle - High CPU Usage | This alert fires when CPU usage on a node in an Oracle cluster is high. | Critical | >=80 | < 80 | +| Metrics | Oracle - Process Limit Critical | This alert fires when process CPU utilization is over 90% | Critical | >=90 | < 90 | +| Metrics | Oracle - Process Limit Warning | This alert fires when processes CPU utilization is over 80% | Warning | >=80 | < 80 | +| Metrics | Oracle - Session Critical | This alert fires when session usage is over 97% | Critical | >=97 | < 97 | +| Metrics | Oracle - Session Warning | This alert fires when session usage is over 90% | Warning | >=90 | < 90 | +| Metrics | Oracle - Tablespaces Out of Space | This alert fires when tablespace disk usage is over 90% | Critical | >=90 | < 90 | +| Metrics | Oracle - Tablespaces Space Low | This alert fires when tablespace disk usage is over 80% | Warning | >=80 | < 80 | +| Metrics | Oracle - User Limit Critical | This alert fires when concurrent user sessions usage is over 90% | Critical | >=90 | < 90 | +| Metrics | Oracle - User Limit Warning | This alert fires when concurrent user sessions usage is over 80% | Warning | >=80 | < 80 | diff --git a/docs/integrations/databases/postgresql.md b/docs/integrations/databases/postgresql.md index b45514d6c0..69830ccf2d 100644 --- a/docs/integrations/databases/postgresql.md +++ b/docs/integrations/databases/postgresql.md @@ -68,41 +68,7 @@ On your PostgreSQL database cluster, create a user that has access to following * `pg_class` -### Step 2: Configure Fields in Sumo Logic - -Create the following Fields in Sumo Logic before configuring collection. This ensures that your logs and metrics are tagged with relevant metadata, which is required by the app dashboards. For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields). - - - - - -If you're using PostgreSQL in a Kubernetes environment, create the fields: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` - - - - -If you're using PostgreSQL in a non-Kubernetes environment, create the fields: - -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `pod` - - - - -### Step 3: Configure PostgreSQL Logs and Metrics Collection +### Step 2: Configure PostgreSQL Logs and Metrics Collection Sumo Logic supports collection of logs and metrics data from PostgreSQL in both Kubernetes and non-Kubernetes environments. Click on the appropriate tab below based on the environment where your PostgreSQL clusters are hosted. @@ -403,7 +369,7 @@ At this point, PostgreSQL logs should start flowing into Sumo Logic. -## Installing PostgreSQL Alerts + ## Installing the PostgreSQL app -Now that you have set up log and metric collection for PostgreSQL, you can install the Sumo Logic app for PostgreSQL to use the pre-configured Searches and dashboards. To install the app, do the following: +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; -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**. + -1. From the **App Catalog**, search for and select the app. -2. Select the version of the service you're using and click **Add to Library**. -:::note -Version selection is not available for all apps. -::: -3. To install the app, complete the following fields. - * **App Name.** You can retain the existing name, or enter a name of your choice for the app. - * **Data Source.** Choose **Enter a Custom Data Filter**, and enter a custom PostgreSQL cluster filter. Examples: - * For all PostgreSQL clusters: `db_cluster=**` - * For a specific cluster: `db_cluster=postgresql.dev.01`. - * Clusters within a specific environment: `db_cluster=postgresql-1 and environment=prod`. (This assumes you have set the optional environment tag while configuring collection) - * **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder. -4. Click **Add to Library.** +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `pod` +* `db_cluster_address` +* `db_cluster_port` -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. +Additionally, if you're using Cassandra in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` -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. +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing PostgreSQL dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -617,13 +584,13 @@ Use this dashboard to: -## PostgreSQL Alerts +## Create monitors for PostgreSQL app -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. +import CreateMonitors from '../../reuse/apps/create-monitors.md'; -**Sumo Logic provides the following out-of-the-box alerts for PostgreSQL:** + -The metrics queries are derived as per [Prometheus rules](https://awesome-prometheus-alerts.grep.to/rules.html). +### PostgreSQL Alerts | Alert Name | Alert Description and conditions | Alert Condition | Recover Condition | |:---------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------|:-----------------------------------| diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index e1057a148c..3b2b18c754 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -71,31 +71,7 @@ This sample Query is from the the **Redis - Logs** dashboard > **Logs** panel. This section provides instructions for configuring log and metric collection for the Sumo Logic app for Redis. Configuring log and metric collection for the Redis ULM app includes the following tasks: - -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - - -Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - - - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Configure Collection for Redis +### Configure Collection for Redis Sumo Logic supports collection of logs and metrics data from Redis in both Kubernetes and non-Kubernetes environments. Click on the appropriate tab below based on the environment where your Redis clusters are hosted. @@ -395,7 +371,7 @@ After determining the location of conf file, modify the **redis.conf** configura -## Installing Redis Monitors/Alerts + ## Installing the Redis app -This section demonstrates how to install the Redis ULM app. +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; + + + + +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` -1. From the **App Catalog**, search for and select the app. -2. Select the version of the service you're using and click **Add to Library**. -:::note -Version selection is not available for all apps. -::: -3. To install the app, complete the following fields. - 1. **App Name.** You can retain the existing name, or enter a name of your choice for the app. - 2. **Data Source.** Choose **Enter a Custom Data Filter** and enter a custom Redis cluster filter. Examples: - * For all Redis clusters: `db_cluster=*` - * For a specific cluster: `db_cluster=redis.dev.01` - * Clusters within a specific environment: `db_cluster=redis-1 and environment=prod`. (This assumes you have set the optional environment tag while configuring collection). - 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. -4. Click **Add to Library**. -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. +Additionally, if you are using Redis in the Kubernetes environment, the following additional fields will be created by default during the app installation process: +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` -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. +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Redis dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -577,16 +557,10 @@ Use this dashboard to: ## Create monitors for Redis app -Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Redis 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 [Redis Alerts](/docs/integrations/databases/redis#redis-alerts). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Redis Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: ### Redis alerts
diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index bc0fbd713c..52d8f8bf33 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -21,28 +21,7 @@ This App has been tested with following SQL Server versions: This section provides instructions for configuring a local file source to collect SQL Server ERRORLOG data, and a script source to collect SQL Server performance metrics. A sample log message is also provided. -### Step 1: Configure fields in Sumo Logic - -As part of the app installation process, the following fields will be created by default: -* `component` -* `environment` -* `db_system` -* `db_cluster` -* `db_cluster_address` -* `db_cluster_port` - -Additionally, if you are using SQL Server in the Kubernetes environment, the following additional fields will be created by default during the app installation process: - -* `pod_labels_component` -* `pod_labels_environment` -* `pod_labels_db_system` -* `pod_labels_db_cluster` -* `pod_labels_db_cluster_address` -* `pod_labels_db_cluster_port` - -For information on setting up fields, see [Fields](/docs/manage/fields). - -### Step 2: Collect Logs and Metrics +### Collect Logs and Metrics Sumo Logic supports collection of logs and metrics data from SQL Server in both Kubernetes and non-Kubernetes environments. Click on the appropriate tabs below based on the environment where your SQL Server clusters are hosted. -## Installing Microsoft SQL Server Monitors + ## Installing the Microsoft SQL Server app -This section demonstrates how to install the SQL Server App. +import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; -import AppInstall from '../../reuse/apps/app-install.md'; + - +As part of the app installation process, the following fields will be created by default: +* `component` +* `environment` +* `db_system` +* `db_cluster` +* `db_cluster_address` +* `db_cluster_port` + +Additionally, if you are using SQL Server in the Kubernetes environment, the following additional fields will be created by default during the app installation process: + +* `pod_labels_component` +* `pod_labels_environment` +* `pod_labels_db_system` +* `pod_labels_db_cluster` +* `pod_labels_db_cluster_address` +* `pod_labels_db_cluster_port` + +For information on setting up fields, see [Fields](/docs/manage/fields). ## Viewing Microsoft SQL Server dashboards -:::tip Filter with template variables -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). -::: +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview @@ -625,17 +621,10 @@ The **SQL Server - Backup Restore Mirroring** provides information about: ## Create monitors for Microsoft SQL Server app -Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an SQL Server 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 [SQL Server Alerts](/docs/integrations/microsoft-azure/sql-server#microsoft-sql-server-alerts). - import CreateMonitors from '../../reuse/apps/create-monitors.md'; -:::note -- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the SQL Server Alerts. -- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor). -::: - ### Microsoft SQL Server alerts
diff --git a/docs/reuse/apps/app-install-only-k8s.md b/docs/reuse/apps/app-install-only-k8s.md new file mode 100644 index 0000000000..ed4d9cf4cd --- /dev/null +++ b/docs/reuse/apps/app-install-only-k8s.md @@ -0,0 +1,20 @@ +To install the app, do the following: +:::note + Next-Gen App: To install or update the app, you must be an account administrator or a user with Manage Apps, Manage Monitors, Manage Fields, Manage Metric Rules, and Manage Collectors capabilities depending upon the different content types part of the app. +::: +1. Select **App Catalog**. +1. In the 🔎 **Search Apps** field, run a search for your desired app, then select it. +1. Click **Install App**. + :::note + Sometimes this button says **Add Integration**. + ::: +1. Click **Next** in the **Setup Data** section. +1. In the **Configure** section of your respective app, complete the following fields. + 1. **Is K8S deployment involved**. Specify if resources being monitored are partially or fully deployed on Kubernetes (K8s) +1. Click **Next**. You will be redirected to the **Preview & Done** section. + +**Post-installation** + +Once your app is installed, it will appear in your **Installed Apps** folder, and dashboard panels will start to fill automatically. + +Each panel slowly fills with data matching the time range query received since the panel was created. Results will not immediately be available but will be updated with full graphs and charts over time. From 379e85761bb1196847708b555e3be38aa86b92e4 Mon Sep 17 00:00:00 2001 From: merge from main Date: Fri, 2 May 2025 12:59:58 +0530 Subject: [PATCH 37/38] removing commented alert install section --- docs/integrations/databases/elasticsearch.md | 74 ----------- docs/integrations/databases/postgresql.md | 91 ------------- docs/integrations/databases/redis.md | 99 -------------- .../microsoft-azure/sql-server.md | 124 ------------------ 4 files changed, 388 deletions(-) diff --git a/docs/integrations/databases/elasticsearch.md b/docs/integrations/databases/elasticsearch.md index c47256d0b9..7feecb27c4 100644 --- a/docs/integrations/databases/elasticsearch.md +++ b/docs/integrations/databases/elasticsearch.md @@ -334,80 +334,6 @@ At this point, Elasticsearch logs should start flowing into Sumo Logic. - ## Installing the Elasticsearch app diff --git a/docs/integrations/databases/postgresql.md b/docs/integrations/databases/postgresql.md index 69830ccf2d..63beeff36f 100644 --- a/docs/integrations/databases/postgresql.md +++ b/docs/integrations/databases/postgresql.md @@ -369,97 +369,6 @@ At this point, PostgreSQL logs should start flowing into Sumo Logic. - - ## Installing the PostgreSQL app import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; diff --git a/docs/integrations/databases/redis.md b/docs/integrations/databases/redis.md index 3b2b18c754..88be8a06f9 100644 --- a/docs/integrations/databases/redis.md +++ b/docs/integrations/databases/redis.md @@ -371,105 +371,6 @@ After determining the location of conf file, modify the **redis.conf** configura - - ## Installing the Redis app diff --git a/docs/integrations/microsoft-azure/sql-server.md b/docs/integrations/microsoft-azure/sql-server.md index 52d8f8bf33..9923b94b11 100644 --- a/docs/integrations/microsoft-azure/sql-server.md +++ b/docs/integrations/microsoft-azure/sql-server.md @@ -376,130 +376,6 @@ At this point, Telegraf should start collecting the SQL Server metrics and forwa - - - ## Installing the Microsoft SQL Server app import AppInstall2 from '../../reuse/apps/app-install-only-k8s.md'; From 05f02c258cde5d019f353319e74e8f235811a30d Mon Sep 17 00:00:00 2001 From: merge from main Date: Fri, 2 May 2025 13:16:25 +0530 Subject: [PATCH 38/38] reverting application-components --- docs/observability/application-components.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/observability/application-components.md b/docs/observability/application-components.md index e245d0f4c9..e233fba420 100644 --- a/docs/observability/application-components.md +++ b/docs/observability/application-components.md @@ -223,9 +223,9 @@ Refer to the documentation for the app you're using. App Components Solution cur * [Oracle](/docs/integrations/databases/oracle) -### Configure fields in Sumo Logic +### Configure Fields in Sumo Logic -As part of the app installation process, the following fields will be created by default: +Create the following Fields in collection sources both for logs and metrics. This ensures that your logs and metrics are tagged with relevant metadata, which the app dashboards require. For information on setting up Fields, see the [Fields](/docs/manage/fields) topic. * `component` * `environment` @@ -234,8 +234,6 @@ As part of the app installation process, the following fields will be created by * `db_cluster_address` * `db_cluster_port` -For information on setting up fields, see [Fields](/docs/manage/fields). - ### Configuring or updating email notifications 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 by [adding a monitor](/docs/alerts/monitors/create-monitor). @@ -293,4 +291,4 @@ Existing customers have to perform the below steps: 1. Add `db_cluster_address` and `db_cluster` port in their telegraf configuration as mentioned in the respective component’s collection doc. This is for tagging metrics. 2. Add `db_cluster_address` and `db_cluster_port` in the Sumo Logic source for logs as mentioned in the respective component’s collection doc. 3. Import the existing fields using fields.sh script in Step 4 and follow Step 1, 2, 3, and 5 under [Installation](#installation) to deploy the solution. -4. The above step will deploy new dashboards and new monitors, so after migrating your custom content to these new dashboards, you can delete old FERs and dashboards. +4. The above step will deploy new dashboards and new monitors, so after migrating your custom content to these new dashboards, you can delete old FERs and dashboards. \ No newline at end of file