Skip to content

Commit 60b7b12

Browse files
sachin-sumologicsachin-sumologic
committed
updated docs for Nginx, Nginx Ingress, Nginx Plus and Nginx Plus Ingress
1 parent 0ad4a01 commit 60b7b12

File tree

4 files changed

+67
-398
lines changed

4 files changed

+67
-398
lines changed

‎docs/integrations/web-servers/nginx-ingress.md‎

Lines changed: 17 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,15 @@ In a Kubernetes environment, we use our Sumo Logic Kubernetes collection. You ca
3535

3636
Configuring log and metric collection for the Nginx Ingress app includes the following tasks:
3737

38-
### Step 1: Configure Fields in Sumo Logic
38+
### Step 1: Fields in Sumo Logic
3939

40-
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).
41-
42-
If you're using Nginx Ingress in a Kubernetes environment, create the fields:
40+
If you're using Nginx Ingress in a Kubernetes environment, Following fields will be created automatically as a part of app installation process:
4341

4442
* `pod_labels_component`
4543
* `pod_labels_environment`
4644
* `pod_labels_webserver_system`
4745
* `pod_labels_webserver_farm`
4846

49-
5047
### Step 2: Configure Nginx Ingress Logs and Metrics Collection
5148

5249
Sumo Logic supports the collection of logs and metrics data from Nginx Ingress in Kubernetes environments.
@@ -71,112 +68,7 @@ It’s assumed that you are using the latest helm chart version if not please up
7168
**Do not modify** the following values set by this configuration as it will cause the Sumo Logic app to not function correctly.
7269
* `component: “webserver”`. This value is used by Sumo Logic apps to identify application components.
7370
* `webserver_system: “nginx_ingress”`. This value identifies the database system.
74-
4. **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. To do so:
75-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Field Extraction Rules**. <br/>[**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**.
76-
2. Click the **+ Add** button on the top right of the table.
77-
3. The **Add Field Extraction Rule** form will appear. Enter the following options:
78-
* **Rule Name**. Enter the name as **App Observability - Webserver**.
79-
* **Applied At.** Choose **Ingest Time.**
80-
* **Scope**. Select **Specific Data.**
81-
* **Scope**: Enter the following keyword search expression.
82-
```sql
83-
pod_labels_environment=* pod_labels_component=webserver pod_labels_webserver_farm=* pod_labels_webserver_system=*
84-
```
85-
* **Parse Expression**. Enter the following parse expression.
86-
```sql
87-
if (!isEmpty(pod_labels_environment), pod_labels_environment, "") as environment
88-
| pod_labels_component as component
89-
| pod_labels_webserver_system as webserver_system
90-
| pod_labels_webserver_farm as webserver_farm
91-
```
92-
93-
## Installing Nginx Ingress Monitors
94-
95-
After [setting up collection](/docs/integrations/web-servers/nginx), you can proceed to installing the Nginx Ingress monitors, app, and view examples of each of dashboard.
96-
* To install these alerts, you need to have the Manage Monitors role capability.
97-
* Alerts can be installed by either importing a JSON file or a Terraform script.
98-
99-
There are limits to how many alerts can be enabled - for details, see the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md).
100-
101-
102-
### Method A: Import a JSON file
103-
104-
1. Download the [JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/nginx-ingress/nginxingress.json) that describes the monitors.
105-
2. The JSON file contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Nginx Ingress farms, 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 farms or environments, update the JSON file by replacing the text `webserver_system=nginx_ingress` with `<Your Custom Filter>`. Custom filter examples:
106-
* For alerts applicable only to a specific farm, your custom filter would be: `webserver_farm=nginx-ingress.01`
107-
* For alerts applicable to all farms that start with `nginx-ingress`, your custom filter would be: `webserver_system=nginx-ingress*`
108-
* For alerts applicable to a specific farm within a production environment, your custom filter would be: `webserver_farm=nginx-ingress-1` AND `environment=dev` (This assumes you have set the optional environment tag while configuring collection)
109-
3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
110-
4. Click **Add**.
111-
5. Click Import and then copy-paste the above JSON to import monitors.
112-
113-
The monitors are disabled by default. Once you have installed the alerts using this method, navigate to the Nginx 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).
114-
115-
116-
### Method B: Using a Terraform script
117-
118-
1. Generate a Sumo Logic access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using these[ instructions](/docs/manage/security/access-keys#from-the-preferences-page). Identify which deployment your Sumo Logic account is in, using this [link](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
119-
2. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later.
120-
3. Download the Sumo Logic Terraform package for Nginx Ingress 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/Nginx%20Ingress). You can either download it through the “git clone” command or as a zip file.
121-
4. Alert Configuration: After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/Nginx Ingress.
122-
1. Edit the **nginx_ingress.auto.tfvars** file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1.
123-
```sql
124-
access_id = "<SUMOLOGIC ACCESS ID>"
125-
access_key = "<SUMOLOGIC ACCESS KEY>"
126-
environment = "<SUMOLOGIC DEPLOYMENT>"
127-
```
128-
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 `nginx_ingress_data_source`. Custom filter examples:
129-
* A specific farm `webserver_farm=nginx.ingress.01`.
130-
* All farms in an environment `environment=dev`.
131-
* For alerts applicable to all farms that start with nginx ingress, your custom filter would be: `webserver_farm=nginx-ingress*`
132-
* For alerts applicable to a specific farm within a production environment, your custom filter would be: `webserver_system=nginx_ingress-1` and `environment=dev` (This assumes you have set the optional environment tag while configuring collection)
133-
134-
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.
135-
136-
By default, the monitors are configured in a monitor **folder** called “**Nginx Ingress**”, if you would like to change the name of the folder, update the monitor folder name in “folder” key at nginx_ingress.auto.tfvars file.
137-
138-
5. If you would like the alerts to send email or connection notifications, modify the file nginx_ingress_notifications.auto.tfvars and populate `connection_notifications` and `email_notifications` as per below examples.
139-
140-
```bash title="Pagerduty Connection Example"
141-
connection_notifications = [
142-
{
143-
connection_type = "PagerDuty",
144-
connection_id = "<CONNECTION_ID>",
145-
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}}\"}",
146-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
147-
},
148-
{
149-
connection_type = "Webhook",
150-
connection_id = "<CONNECTION_ID>",
151-
payload_override = "",
152-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
153-
}
154-
]
155-
```
156-
157-
Replace `<CONNECTION_ID>` with the connection id of the webhook connection. The webhook connection id can be retrieved by calling the [Monitors API](https://api.sumologic.com/docs/#operation/listConnections).
158-
159-
For overriding payload for different connection types, refer to this [document](/docs/alerts/webhook-connections/set-up-webhook-connections).
160-
161-
```bash title="Email Notifications Example"
162-
email_notifications = [
163-
{
164-
connection_type = "Email",
165-
recipients = ["[email protected]"],
166-
subject = "Monitor Alert: {{TriggerType}} on {{Name}}",
167-
time_zone = "PST",
168-
message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
169-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
170-
}
171-
]
172-
```
173-
174-
6. **Install the Alerts**.
175-
1. Navigate to the package directory `terraform-sumologic-sumo-logic-monitor/monitor_packages/**Nginx Ingress**/` and run `terraform init`. This will initialize Terraform and will download the required components.
176-
2. Run `terraform plan` to view the monitors which will be created/modified by Terraform.
177-
3. Run `terraform apply`.
178-
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).
179-
71+
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 a Field Extraction Rule automatically created for Nginx Application Components named as **AppObservabilityNginxIngressWebserverFER**
18072

18173
## Installing the Nginx Ingress app
18274

@@ -327,6 +219,20 @@ Use this dashboard to:
327219

328220
<img src={useBaseUrl('img/integrations/web-servers/Nginx-Ingress-Controller-Metrics.png')} alt="Nginx-Ingress-Controller-Metrics" />
329221

222+
## Installing Nginx Ingress Monitors
223+
224+
After [setting up collection](/docs/integrations/web-servers/nginx), you can proceed to installing the Nginx Ingress monitors, app, and view examples of each of dashboard.
225+
226+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
227+
228+
:::note permissions required
229+
To install these alerts, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
230+
:::
231+
232+
:::note
233+
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/overview/#rules) for details.
234+
:::
235+
330236
## Nginx Ingress Alerts
331237

332238
Sumo Logic has provided out-of-the-box alerts available via [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Nginx server is 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. They are as follows:

‎docs/integrations/web-servers/nginx-plus-ingress.md‎

Lines changed: 14 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -118,80 +118,6 @@ Use the following Parse Expression:
118118

119119
To install these alerts, you need to have the[ Manage Monitors](/docs/manage/users-roles/roles/role-capabilities) role capability.
120120

121-
Alerts can be installed by either importing them via a JSON or via a Terraform script.
122-
123-
### Method A: Importing a JSON file
124-
125-
1. Download [this JSON file](https://github.com/SumoLogic/terraform-sumologic-sumo-logic-monitor/blob/main/monitor_packages/nginx-plus-ingress/nginxplusingress.json) describing all the monitors.
126-
2. Replace **$$logs_data_source** with logs data source.
127-
* For example, `_sourceCategory=Labs/NginxIngress/Logs`
128-
3. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Monitoring > Monitors**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the main Sumo Logic menu, select **Alerts > Monitors**. You can also click the **Go To...** menu at the top of the screen and select **Monitors**.
129-
4. Click **Add**.
130-
1. Click **Import** to import monitors from the JSON above.
131-
132-
The monitors are disabled by default. Once you have installed the alerts via this method, navigate to the **Nginx** **Ingress** folder under **Monitors** to configure them. See [Add a Monitor](/docs/alerts/monitors/create-monitor) to enable monitors, to configure each monitor, to send notifications to teams or connections.
133-
134-
### Method B: Using a Terraform script
135-
136-
1. Generate a Sumo Logic [access key](/docs/manage/security/access-keys#from-the-preferences-page) and access ID for a user that has the[ Manage Monitors](/docs/manage/users-roles/roles/role-capabilities) role capability in Sumo Logic using these instructions. Please identify your Sumo Logic[ deployment](/docs/api/getting-started#sumo-logic-endpoints-by-deployment-and-firewall-security).
137-
2. [Download and install Terraform 0.13](https://www.terraform.io/downloads.html) or later.
138-
3. Download the Sumo Logic Terraform package for Nginx Ingress 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/nginx-plus-ingress). You can either download it via the `git clone` command or as a zip file.
139-
4. Alert Configuration: After the package has been extracted, navigate to the package directory **terraform-sumologic-sumo-logic-monitor/monitor_packages/nginx-plus-ingress/**. Edit the **nginxplusingress.auto.tfvars** file as per below instructions:
140-
1. Add the Sumo Logic Access Key, Access Id, Deployment from Step 1.
141-
```sh
142-
access_id = "<YOUR SUMO ACCESS ID>"
143-
access_key = "<YOUR SUMO ACCESS KEY>"
144-
environment = "<DEPLOYMENT>"
145-
```
146-
2. Add `Logs_data_source` as the Sumo Logic data source for logs.
147-
3. All monitors are disabled by default on installation, if you would like to enable all the monitors, set the parameter **monitors_disabled** to **false**.
148-
4. All monitors are configured in a monitor folder called “**Nginx Plus Ingress**”, if you would like to change the name of the folder, update the parameter **folder**.
149-
5. Email and Connection Notification Configuration Examples: Modify the file **nginxplusingress.auto.tfvars** and populate `connection_notifications` and `email_notifications` as per below examples.
150-
151-
```bash title="Pagerduty Connection Example"
152-
connection_notifications = [
153-
{
154-
connection_type = "PagerDuty",
155-
connection_id = "<CONNECTION_ID>",
156-
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}}\"}",
157-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
158-
},
159-
{
160-
connection_type = "Webhook",
161-
connection_id = "<CONNECTION_ID>",
162-
payload_override = "",
163-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
164-
}
165-
]
166-
```
167-
168-
Replace `<CONNECTION_ID>` 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).
169-
170-
For overriding payload for different connection types, refer to [this document](/docs/alerts/webhook-connections/set-up-webhook-connections).
171-
172-
```bash title="Email Notifications Example:"
173-
email_notifications = [
174-
{
175-
connection_type = "Email",
176-
recipients = ["[email protected]"],
177-
subject = "Monitor Alert: {{TriggerType}} on {{Name}}",
178-
time_zone = "PST",
179-
message_body = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
180-
run_for_trigger_types = ["Critical", "ResolvedCritical"]
181-
}
182-
]
183-
}
184-
```
185-
186-
6. Install the Alerts:
187-
1. Navigate to the package directory **terraform-sumologic-sumo-logic-monitor/monitor_packages/nginx-plus-ingress/** and run `terraform init`. This will initialize Terraform and will download the required components.
188-
2. Run `terraform plan` to view the monitors resources which will be created/modified by Terraform.
189-
3. Run `terraform apply`.
190-
7. Post Installation steps: 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 [Step 4](/docs/alerts/monitors/create-monitor).
191-
192-
There are limits to how many alerts can be enabled. See the [Alerts FAQ](/docs/alerts/monitors/monitor-faq.md).
193-
194-
195121
## Installing the Nginx Plus Ingress app
196122

197123
import AppInstall from '../../reuse/apps/app-install.md';
@@ -375,6 +301,20 @@ Use this dashboard to:
375301

376302
<img src={useBaseUrl('img/integrations/web-servers/Nginx-Plus-Ingress-TCP-UDP-Zones.png')} alt="Nginx Plus Ingress" />
377303

304+
## Installing Nginx Plus Monitors
305+
306+
To install these alerts, you need to have the [Manage Monitors](/docs/manage/users-roles/roles/role-capabilities) role capability.
307+
308+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
309+
310+
:::note permissions required
311+
To install these alerts, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
312+
:::
313+
314+
:::note
315+
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/overview/#rules) for details.
316+
:::
317+
378318
## Nginx Plus Ingress Alerts
379319

380320
Sumo Logic has provided out-of-the-box alerts available via [Sumo Logic monitors](/docs/alerts/monitors) to help you quickly determine if the Nginx server is 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.

0 commit comments

Comments
 (0)