Skip to content

doc enhancements for migrated v2 apps #5209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
75f2f10
doc enhancements for migrated v2 apps
sachin-sumologic Mar 26, 2025
9230b32
Merge branch 'main' into docks-enhancements-v1-v2-migration
sachin-sumologic Mar 26, 2025
def71ae
doc enhancements for migrated v2 apps
sachin-sumologic Mar 26, 2025
cc4b1fc
added reuse files and updated apache documentation
sachin-sumologic Mar 28, 2025
91e4b49
Merge branch 'main' into docks-enhancements-v1-v2-migration
kimsauce Apr 3, 2025
e2828da
template fiels moved
sachin-sumologic Apr 8, 2025
9842808
Merge branch 'main' into docks-enhancements-v1-v2-migration
sachin-sumologic Apr 8, 2025
adbae20
Merge branch 'docks-enhancements-v1-v2-migration' of https://github.c…
sachin-sumologic Apr 8, 2025
9c104ba
Update apache-tomcat.md
amee-sumo Apr 12, 2025
1904e01
Update apache.md
amee-sumo Apr 12, 2025
7bac390
Update haproxy.md
amee-sumo Apr 12, 2025
756519e
Update iis-10.md
amee-sumo Apr 12, 2025
c64d71c
Update nginx-ingress.md
amee-sumo Apr 12, 2025
9d19419
Update nginx-plus-ingress.md
amee-sumo Apr 12, 2025
5e73557
Update nginx-plus.md
amee-sumo Apr 12, 2025
ca67507
Update nginx.md
amee-sumo Apr 12, 2025
099cf29
Update app-collection-option-1.md
amee-sumo Apr 12, 2025
717196e
Update app-collection-option-2.md
amee-sumo Apr 12, 2025
d83d8cd
Update app-collection-option-3.md
amee-sumo Apr 12, 2025
9856d2e
Update app-install-only-k8s.md
amee-sumo Apr 12, 2025
44bd698
Update app-install-sc-k8s.md
amee-sumo Apr 12, 2025
50a66c2
Update app-install-v2.md
amee-sumo Apr 12, 2025
9f3970b
Update app-update.md
amee-sumo Apr 12, 2025
1dbf276
Merge branch 'main' into docks-enhancements-v1-v2-migration
amee-sumo Apr 29, 2025
c6828bd
doc enhancements
sachin-sumologic Apr 30, 2025
8377581
Docs Enhancements
sachin-sumologic Apr 30, 2025
a510210
Docs Enhancements
sachin-sumologic Apr 30, 2025
07146a4
Merge branch 'main' into docks-enhancements-v1-v2-migration
sachin-sumologic Apr 30, 2025
54e5912
Docs Enhancements
sachin-sumologic Apr 30, 2025
859cbf7
Docs Enhancements
sachin-sumologic Apr 30, 2025
b4ba094
Update docs/integrations/web-servers/nginx-ingress.md
kimsauce Apr 30, 2025
91ae5d0
Update docs/integrations/web-servers/nginx-ingress.md
kimsauce Apr 30, 2025
2757834
Update docs/integrations/web-servers/nginx.md
kimsauce Apr 30, 2025
999595d
Update docs/integrations/web-servers/nginx-ingress.md
kimsauce Apr 30, 2025
0d418d5
Update docs/integrations/web-servers/nginx-plus-ingress.md
kimsauce Apr 30, 2025
45b5d9b
Update docs/integrations/web-servers/nginx.md
kimsauce Apr 30, 2025
fbc60fb
Update docs/integrations/web-servers/nginx-plus.md
kimsauce Apr 30, 2025
f1b7b5d
Update docs/integrations/web-servers/nginx-plus.md
kimsauce Apr 30, 2025
e0404a5
Merge branch 'main' into docks-enhancements-v1-v2-migration
kimsauce Apr 30, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 27 additions & 51 deletions docs/integrations/web-servers/apache-tomcat.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,6 @@ Before installing the Sumo Logic app, Apache Tomcat must be set up and configure

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.

### Step 1: Configure fields in Sumo Logic

As part of the app installation process, the following fields will be created by default:
* `component`
* `environment`
* `webserver_system`
* `webserver_farm`
* `pod`

Additionally, if you are using Apache Tomcat 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_webserver_system`
* `pod_labels_webserver_farm`

For information on setting up fields, see [Fields](/docs/manage/fields).

### Step 2: Configure Collection for Apache Tomcat

<Tabs
Expand Down Expand Up @@ -72,7 +55,7 @@ Follow the below instructions to set up metrics collection:
It’s assumed that you are using the latest helm chart version. If not, upgrade using the instructions [here](/docs/send-data/kubernetes).


#### Step 1: Configure Metrics Collection
### Step 1: Configure Metrics Collection

This section explains the steps to collect Apache Tomcat metrics from a Kubernetes environment.

Expand Down Expand Up @@ -213,7 +196,7 @@ In Kubernetes environments, we use the Telegraf Operator, which is packaged with
1. Sumo Logic Kubernetes collection will automatically start collecting metrics from the pods having the labels and annotations defined in the previous step.
1. Verify metrics in Sumo Logic.

#### Step 2: Configure Logs Collection
### Step 2: Configure Logs Collection

This section explains the steps to collect Apache Tomcat logs from a Kubernetes environment.

Expand Down Expand Up @@ -280,7 +263,7 @@ This section provides instructions for configuring metrics collection for the Su
1. Configure logging in Apache Tomcat
2. Configure Sumo Logic Installed Collector

#### Step 1: Configure Metrics Collection
### Step 1: Configure Metrics Collection

1. **Configure a Hosted Collector**. To create a new Sumo Logic hosted collector, perform the steps in the [Create a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector) section of the Sumo Logic documentation.
1. **Configure an HTTP Logs and Metrics Source**. Create a new HTTP Logs and Metrics Source in the hosted collector created above by following[ these instructions. ](/docs/send-data/hosted-collectors/http-source/logs-metrics)Make a note of the **HTTP Source URL**.
Expand Down Expand Up @@ -501,7 +484,7 @@ Once you have finalized your telegraf.conf file, you can start or reload the tel

At this point, Tomcat metrics should start flowing into Sumo Logic.

#### Step 2 Configure Logs Collection
### Step 2 Configure Logs Collection

This section provides instructions for configuring log collection for Apache Tomcat running on a non-kubernetes environment for the Sumo Logic App for Apache Tomcat.

Expand Down Expand Up @@ -556,34 +539,30 @@ At this point, Tomcat logs should start flowing into Sumo Logic.

## Installing the Apache Tomcat app

The Sumo Logic app for Apache Tomcat provides pre-configured Dashboards for Access, Catalina.out, and Garbage Collection logs.
import AppInstall2 from '../../reuse/apps/app-install-sc-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**.
<AppInstall2/>

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 filter for Apache Tomcat webserver farm. Examples:
* For all Apache Tomcat webserver farms webserver_farm=*
* For a specific webserver farms: webserver_farm=tomcat.dev.01.
* Clusters within a specific environment: `webserver_farm=tomcat-1 and environment=prod`. (This assumes you have set the optional environment tag while configuring collection)
4. **Advanced**. Select the **Location in Library** (the default is the Personal folder in the library), or click **New Folder** to add a new folder.
5. Click **Add to Library**.
As part of the app installation process, the following fields will be created by default:
* `component`
* `environment`
* `webserver_system`
* `webserver_farm`
* `pod`

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 Apache Tomcat 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_webserver_system`
* `pod_labels_webserver_farm`

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 Apache Tomcat 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';

<ViewDashboards/>

### Overview

Expand All @@ -599,7 +578,7 @@ Use this dashboard to:
<img src={useBaseUrl('img/integrations/web-servers/Apache-Tomcat-Overview.png')} alt="test" />


#### Visitor Locations
### Visitor Locations

The **Apache Tomcat - Visitor Locations** dashboard provides a high-level view of Tomcat visitor geographic locations both worldwide and in the United States. Dashboard panels also show graphic trends for visits by country over time and visits by US region over time.

Expand Down Expand Up @@ -720,19 +699,15 @@ The **Apache Tomcat - MemoryPool** dashboard provides a memory of your JMX Apac

To help determine if the Apache Tomcat server is available and performing well, the [Sumo Logic monitors](/docs/alerts/monitors) are provided with out-of-box alerts.

## Installing Apache Tomcat monitors

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).
## Create monitors for Apache Tomcat

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 Apache Tomcat alerts.
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
:::
<CreateMonitors/>

## Apache Tomcat Alerts

<details>
<summary>Here are the alerts available for Apache Tomcat (click to expand).</summary>
<table>
<tr>
<td>Alert Name </td>
Expand Down Expand Up @@ -771,3 +746,4 @@ import CreateMonitors from '../../reuse/apps/create-monitors.md';
<td> 0 </td>
</tr>
</table>
</details>
58 changes: 28 additions & 30 deletions docs/integrations/web-servers/haproxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,21 +77,6 @@ This section provides instructions for configuring logs and metrics collection f

Configuring log and metric collection for the HAProxy 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`
* `proxy_system`
* `proxy_cluster`
* `pod`

Additionally, if you're using HAProxy 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_proxy_system`
* `pod_labels_proxy_cluster`

### Step 2: Configure Collection for HAProxy

Sumo Logic supports collection of logs and metrics data from HAProxy in both Kubernetes and non-Kubernetes environments.
Expand Down Expand Up @@ -120,7 +105,7 @@ In the logs pipeline, Sumo Logic Distribution for OpenTelemetry Collector collec
It’s assumed that you are using the latest helm chart version. If not, upgrade using the instructions [here](/docs/send-data/kubernetes).
:::

#### Configure Metrics Collection
### Configure Metrics Collection

This section explains the steps to collect HAProxy metrics from a Kubernetes environment. In Kubernetes environments, we use the Telegraf Operator, which is packaged with our Kubernetes collection. You can learn more on this [here](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf/telegraf-collection-architecture). Follow the steps listed below to collect metrics from a Kubernetes environment.

Expand Down Expand Up @@ -162,7 +147,7 @@ annotations:
4. Verify metrics in Sumo Logic.


#### Configure Logs Collection
### Configure Logs Collection

This section explains the steps to collect HAProxy logs from a Kubernetes environment.

Expand Down Expand Up @@ -215,7 +200,7 @@ We use the Telegraf operator for HAProxy metric collection and Sumo Logic Instal

This section provides instructions for configuring metrics collection for the Sumo Logic app for HAProxy.

#### Configure Metrics Collection
### Configure Metrics Collection

1. Configure a Hosted Collector: To create a new Sumo Logic hosted collector, perform the steps in the[Create a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector) section of the Sumo Logic documentation.
2. Configure an HTTP Logs and Metrics Source: Create a new HTTP Logs and Metrics Source in the hosted collector created above by following[ these instructions](/docs/send-data/hosted-collectors/http-source/logs-metrics). Make a note of the **HTTP Source URL**.
Expand Down Expand Up @@ -260,7 +245,7 @@ Once you have finalized your telegraf.conf file, you can start or reload the tel

At this point, HAProxy metrics should start flowing into Sumo Logic.

#### Configure Logs Collection
### Configure Logs Collection

This section provides instructions for configuring log collection for HAProxy running on a non-Kubernetes environment for the Sumo Logic app for HAProxy.

Expand Down Expand Up @@ -394,12 +379,29 @@ component="proxy" proxy_cluster="<Your-HAProxy-Server>" proxy_system="haproxy"

Now that you have set up collection for HAProxy, you can install the HAProxy app to use the pre-configured searches and dashboard that provide insight into your data.

import AppInstall from '../../reuse/apps/app-install.md';
import AppInstall2 from '../../reuse/apps/app-install-sc-k8s.md';

<AppInstall/>
<AppInstall2/>

As part of the app installation process, the following fields will be created by default:
* `component`
* `environment`
* `proxy_system`
* `proxy_cluster`
* `pod`

Additionally, if you're using HAProxy 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_proxy_system`
* `pod_labels_proxy_cluster`

## Viewing HAProxy Dashboards

import ViewDashboards from '../../reuse/apps/view-dashboards.md';

<ViewDashboards/>

### Overview

The **HAProxy - Overview** dashboard provides an at-a-glance view of HAProxy Backend and Frontend HTTP error codes percentage, visitor location, URLs and Clients causing errors.
Expand Down Expand Up @@ -505,20 +507,15 @@ Use this dashboard to:

<img src={useBaseUrl('img/integrations/web-servers/HAProxy-WebServerOperations.png')} alt="test" />

## Installing the HAProxy monitors

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).
## Create monitors for HAProxy app

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 HAProxy alerts.
- You can only enable the set number of alerts. For more information, refer to [Monitors](/docs/alerts/monitors/create-monitor).
:::

<CreateMonitors/>

## HAProxy Alerts

<details>
<summary>Here are the alerts available for Haproxy (click to expand).</summary>
| Alert Type (Metrics/Logs) | Alert Name | Alert Description | Trigger Type (Critical / Warning) | Alert Condition | Recover Condition |
|:---|:---|:---|:---|:---|:---|
| Logs | HAProxy - Access from Highly Malicious Sources | This alert fires when an HAProxy is accessed from highly malicious IP addresses. | Critical | > 0 | < = 0 |
Expand All @@ -534,3 +531,4 @@ import CreateMonitors from '../../reuse/apps/create-monitors.md';
| Metrics | HAProxy - Retry High | there is a high retry rate | Warning | >0 | < = 0 |
| Metrics | HAProxy - High Server Connection Errors | there are too many connection errors to backend servers. | Warning | >100 | < = 100 |
| Metrics | HAProxy - Server Healthcheck Failure | server healthchecks are failing. | Warning | >0 | < = 0 |
</details>
Loading
Loading