Skip to content

Commit 70664b8

Browse files
resolved feedback comments
1 parent 67cb17a commit 70664b8

File tree

8 files changed

+57
-79
lines changed

8 files changed

+57
-79
lines changed

docs/integrations/web-servers/apache-tomcat.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,22 @@ Before installing the Sumo Logic app, Apache Tomcat must be set up and configure
1919

2020
This section provides instructions for configuring log and metric collection for the Sumo Logic app for Apache Tomcat. Configuring log and metric collection for the Apache Tomcat app includes the following tasks.
2121

22-
### Step 1: Fields in Sumo Logic
22+
### Step 1: Configure fields in Sumo Logic
2323

24-
Following fields will always be created automatically as a part of app installation process:
24+
As part of the app installation process, the following fields will created by default:
2525
* `component`
2626
* `environment`
2727
* `webserver_system`
2828
* `webserver_farm`
2929
* `pod`
3030

31-
If you're using Apache Tomcat in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
31+
Additionally, if you are using Apache Tomcat in the Kubernetes environment, these following additional fields will be created by default as a part of app installation process:
3232
* `pod_labels_component`
3333
* `pod_labels_environment`
3434
* `pod_labels_webserver_system`
3535
* `pod_labels_webserver_farm`
3636

37-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
37+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
3838

3939
### Step 2: Configure Collection for Apache Tomcat
4040

@@ -48,7 +48,7 @@ For information on setting up fields, see [Sumo Logic Fields](/docs/manage/field
4848

4949
<TabItem value="k8s">
5050

51-
In Kubernetes environments, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more about it [here](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf/telegraf-collection-architecture). The diagram below illustrates how data is collected from Apache Tomcat in a Kubernetes environment. Four services in the architecture shown below make up the metric collection pipeline: Telegraf, Telegraf Operator, Prometheus, and [Sumo Logic Distribution for OpenTelemetry Collector](https://github.com/SumoLogic/sumologic-otel-collector).
51+
In Kubernetes environments, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more about it [here](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf/telegraf-collection-architecture). The diagram below illustrates how data is collected from Apache Tomcat in the Kubernetes environment. Four services in the architecture shown below make up the metric collection pipeline: Telegraf, Telegraf Operator, Prometheus, and [Sumo Logic Distribution for OpenTelemetry Collector](https://github.com/SumoLogic/sumologic-otel-collector).
5252

5353
<img src={useBaseUrl('img/integrations/web-servers/apachetomcat-k8s.png')} alt="apache-k8s" />
5454

@@ -256,7 +256,8 @@ This section explains the steps to collect Apache Tomcat logs from a Kubernetes
256256
1. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
257257
1. Verify logs in Sumo Logic.
258258

259-
1. **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 Apache Tomcat Web Server Application Components named as **AppObservabilityApacheTomcatWebserverFER**
259+
<br />**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 Apache Tomcat Web Server Application Components named as **AppObservabilityApacheTomcatWebserverFER**
260+
<br />
260261

261262
</TabItem>
262263
<TabItem value="non-k8s">
@@ -721,24 +722,17 @@ To help determine if the Apache Tomcat server is available and performing well,
721722
722723
## Installing Apache Tomcat Monitors
723724
724-
import CreateMonitors from '../../reuse/apps/create-monitors.md';
725-
726-
Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Apache Tomcat webserver farm 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 [Apache Tomcat Alerts](/docs/integrations/web-servers/apache-tomcat#apache-tomcat-alerts).
725+
Sumo Logic provides pre-configured alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if an Apache Tomcat webserver farm 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 [Apache Tomcat Alerts](/docs/integrations/web-servers/apache-tomcat#apache-tomcat-alerts).
727726
728-
:::note permissions required
729-
To install these alerts, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
730-
:::
727+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
731728
732729
:::note
733-
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/create-monitor) for details.
730+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Apache Tomcat Alerts.
731+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
734732
:::
735733
736-
737734
## Apache Tomcat Alerts
738735
739-
The alerts are built based on metrics datasets and have preset thresholds.
740-
741-
742736
<table>
743737
<tr>
744738
<td>Alert Name </td>

docs/integrations/web-servers/apache.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -114,21 +114,21 @@ The predefined searches in the Apache app are based on the Apache Access logs an
114114

115115
This section provides instructions for configuring log and metrics collection for the Sumo Logic app for Apache.
116116

117-
### Step 1: Fields in Sumo Logic
117+
### Step 1: Configure fields in Sumo Logic
118118

119-
Following fields will always be created automatically as a part of app installation process:
119+
As part of the app installation process, the following fields will created by default:
120120
* `component`
121121
* `environment`
122122
* `webserver_system`
123123
* `webserver_farm`
124124

125-
If you're using Apache in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
125+
Additionally, if you are using Apache in the Kubernetes environment, these following additional fields will be created by default as a part of app installation process:
126126
* `pod_labels_component`
127127
* `pod_labels_environment`
128128
* `pod_labels_webserver_system`
129129
* `pod_labels_webserver_farm`
130130

131-
For information on setting up fields, see [Sumo Logic Fields](/docs/manage/fields).
131+
To learn more about setting up fields, refer to [Sumo Logic Fields](/docs/manage/fields).
132132

133133
### Step 2: Configure Your Environment for Apache Logs and Metrics Collection
134134

@@ -246,7 +246,10 @@ This section explains the steps to collect Apache logs from a Kubernetes environ
246246
kubectl describe pod <apache_pod_name>
247247
```
248248
The Sumo Logic Kubernetes Collection process will automatically capture the logs from `stdout`/`stderr` and will send the logs to Sumo Logic. For more information on deploying the Sumo Logic-Kubernetes-Collection, please see [this page](/docs/integrations/containers-orchestration/kubernetes#collecting-metrics-and-logs-for-the-kubernetes-app).
249-
2. **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 Apache Web Server Application Components named as **AppObservabilityApacheWebserverFER**
249+
<br />
250+
**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 Apache Web Server Application Components named as **AppObservabilityApacheWebserverFER**
251+
<br />
252+
250253
</TabItem>
251254
<TabItem value="non-k8s">
252255

@@ -558,20 +561,17 @@ Use this dashboard to:
558561

559562
## Installing Apache Monitors
560563

561-
import CreateMonitors from '../../reuse/apps/create-monitors.md';
562-
563564
This section provides instructions for installing the Sumo Logic Monitors for Apache. These instructions assume you have already set up collection as described in the [Collecting Logs and Metrics for Apache](#collecting-logs-and-metrics-for-apache) page.
564565

565566
Sumo Logic has provided a predefined set of alerts, which can be imported and available through [Sumo Logic monitors](/docs/alerts/monitors), to help you proactively monitor your Apache Web servers and farms. These monitors are built based on metrics and logs datasets and include pre-set thresholds based on industry best practices and recommendations.
566567

567568
For details about individual alerts, see [Apache Alerts](#apache-alerts).
568569

569-
:::note permissions required
570-
To install these alerts, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
571-
:::
570+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
572571

573572
:::note
574-
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/create-monitor) for details.
573+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Apache Tomcat Alerts.
574+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
575575
:::
576576

577577
## Apache Alerts

docs/integrations/web-servers/haproxy.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,16 @@ This section provides instructions for configuring logs and metrics collection f
7777
7878
Configuring log and metric collection for the HAProxy app includes the following tasks:
7979
80-
### Step 1: Fields in Sumo Logic
80+
### Step 1: Configure fields in Sumo Logic
8181
82-
Following fields will always be created automatically as a part of app installation process:
82+
As part of the app installation process, the following fields will created by default:
8383
* `component`
8484
* `environment`
8585
* `proxy_system`
8686
* `proxy_cluster`
8787
* `pod`
8888
89-
If you're using Haproxy in a Kubernetes environment, these additional fields will get created automatically as a part of app installation process:
89+
Additionally, if you are using Haproxy in the Kubernetes environment, these following additional fields will be created by default as a part of app installation process:
9090
* `pod_labels_component`
9191
* `pod_labels_environment`
9292
* `pod_labels_proxy_system`
@@ -203,7 +203,9 @@ This section explains the steps to collect HAProxy logs from a Kubernetes enviro
203203
kubectl describe pod <haproxy_pod_name>
204204
```
205205
5. Sumo Logic Kubernetes collection will automatically start collecting logs from the pods having the annotations defined above.
206-
1. **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 Proxy Application Components named as **AppObservabilityHaproxyFER**
206+
<br />
207+
**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 Proxy Application Components named as **AppObservabilityHaproxyFER**
208+
<br />
207209
</TabItem>
208210
<TabItem value="non-k8s">
209211
@@ -505,18 +507,16 @@ Use this dashboard to:
505507
506508
## Installing the HAProxy Monitors
507509
508-
import CreateMonitors from '../../reuse/apps/create-monitors.md';
509-
510510
Sumo Logic has provided pre-packaged alerts available through [Sumo Logic monitors](/docs/alerts/monitors) to help you proactively determine if a HAProxy 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 [HAProxy Alerts](#haproxy-alerts).
511511
512-
:::note permissions required
513-
To install these alerts, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
514-
:::
512+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
515513
516514
:::note
517-
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/overview/#rules) for details.
515+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Apache Tomcat Alerts.
516+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
518517
:::
519518
519+
520520
## HAProxy Alerts
521521
522522
| Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition |

docs/integrations/web-servers/iis-10.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Sumo Logic supports the collection of logs and metrics data from IIS server in s
4242

4343
Sumo Logic uses the Telegraf operator for IIS metric collection and the [Installed Collector](/docs/send-data/installed-collectors) for collecting IIS logs. The diagram below illustrates the components of the IIS collection in a standalone environment. Telegraf uses the [Windows Performance Counters Input Plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sqlserver) to obtain IIS metrics and the Sumo Logic output plugin to send the metrics to Sumo Logic. Logs from IIS Server are collected by a [Local File Source](/docs/send-data/installed-collectors/sources/local-file-source).
4444

45-
### Fields in Sumo Logic
45+
### Configure fields in Sumo Logic
4646

4747
Following fields will be created automatically as a part of app installation process:
4848
* `component`
@@ -608,12 +608,9 @@ Use this dashboard to monitor the following key metrics:
608608

609609
import CreateMonitors from '../../reuse/apps/create-monitors.md';
610610

611-
:::note permissions required
612-
To install these alerts, you need to have the [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting).
613-
:::
614-
615611
:::note
616-
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/overview/#rules) for details.
612+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Apache Tomcat Alerts.
613+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
617614
:::
618615

619616
## Using IIS Alerts

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

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ For more details on Nginx Ingress Metrics, see [Prometheus](https://docs.nginx.c
3131

3232
This section provides instructions for configuring log and metric collection for the Sumo Logic app for Nginx Ingress.
3333

34-
In a Kubernetes environment, we use our Sumo Logic Kubernetes collection. You can learn more about this [here](/docs/observability/kubernetes/collection-setup).
34+
In the Kubernetes environment, we use our Sumo Logic Kubernetes collection. You can learn more about this [here](/docs/observability/kubernetes/collection-setup).
3535

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

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

40-
If you're using Nginx Ingress in a Kubernetes environment, Following fields will be created automatically as a part of app installation process:
40+
Additionally, if you are using Nginx Ingress in the Kubernetes environment, Following fields will be created automatically as a part of app installation process:
4141

4242
* `pod_labels_component`
4343
* `pod_labels_environment`
@@ -68,8 +68,9 @@ It’s assumed that you are using the latest helm chart version if not please up
6868
**Do not modify** the following values set by this configuration as it will cause the Sumo Logic app to not function correctly.
6969
* `component: “webserver”`. This value is used by Sumo Logic apps to identify application components.
7070
* `webserver_system: “nginx_ingress”`. This value identifies the database system.
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**
72-
71+
<br />
72+
**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**
73+
<br />
7374
## Installing the Nginx Ingress app
7475

7576
This section demonstrates how to install the Nginx Ingress app. These instructions assume you have already set up the collection as described above.
@@ -221,16 +222,13 @@ Use this dashboard to:
221222

222223
## Installing Nginx Ingress Monitors
223224

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

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-
:::
227+
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.
231228

232229
:::note
233-
There are limits to how many alerts can be enabled. For more information, see [Monitors](/docs/alerts/monitors/overview/#rules) for details.
230+
- Ensure that you have [Manage Monitors role capability](/docs/manage/users-roles/roles/role-capabilities/#alerting) permissions to install the Apache Tomcat Alerts.
231+
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
234232
:::
235233

236234
## Nginx Ingress Alerts

0 commit comments

Comments
 (0)