Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
92f87ec
Adding a note for 12 opentelemetry app docs, after deprecation of env…
sumoanema Jun 4, 2025
856e93d
Change in note for apps where username and password (which uses env v…
sumoanema Jun 4, 2025
20b62c3
tring env varibale syntax due to jenkins job failure
sumoanema Jun 4, 2025
45e6e93
Changes in doc to point to env variable without breaking jenkins job …
sumoanema Jun 4, 2025
64e33d4
Add and implement /reuse file
kimsauce Jun 4, 2025
73748a7
Update docs/integrations/databases/opentelemetry/cassandra-openteleme…
kimsauce Jun 4, 2025
e3a77b4
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
3ef295d
Update docs/integrations/containers-orchestration/opentelemetry/rabbi…
kimsauce Jun 4, 2025
7f6f473
Update docs/integrations/databases/opentelemetry/cassandra-openteleme…
kimsauce Jun 4, 2025
243fe28
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
30b1e77
Update docs/integrations/databases/opentelemetry/redis-opentelemetry.md
kimsauce Jun 4, 2025
a98c706
Update docs/integrations/databases/opentelemetry/redis-opentelemetry.md
kimsauce Jun 4, 2025
70a379b
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
f269b4e
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
1aa4df2
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
914d94f
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
5819c51
Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md
kimsauce Jun 4, 2025
322ec25
Merge branch 'main' into otelenvvarsyntaxnote
kimsauce Jun 6, 2025
08f64a8
split env var note into required + optional versions
kimsauce Jun 6, 2025
f54faa9
Update docs/integrations/databases/opentelemetry/cassandra-openteleme…
kimsauce Jun 6, 2025
5ee4824
Update docs/integrations/databases/opentelemetry/cassandra-openteleme…
kimsauce Jun 6, 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
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,10 @@ Below is the input required:

Click on the **Download YAML File** button to get the yaml file.

import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';

<EnvVarOpt/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/JMX-OpenTelemetry/JMX-OTEL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

### Step 3: Send logs and metrics to Sumo Logic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,10 @@ Below is the input required:

Click on the **Download YAML File** button to get the YAML file.

import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';

<EnvVarOpt/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-OTEL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

### Step 3: Send logs and metrics to Sumo Logic
Expand Down Expand Up @@ -355,4 +359,3 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
| `ActiveMQ - No Consumers on Queues Alert` | This alert gets triggered when a ActiveMQ queue has no consumers. | Count < 1 | Count >= 1 |
| `ActiveMQ - Node Down Alert` | This alert gets triggered when a node in the ActiveMQ cluster is down. | Count >= 1 | Count < 1 |
| `ActiveMQ - Too Many Connections Alert` | This alert gets triggered when there are too many connections to a node in a ActiveMQ cluster. | Count >= 1000 | Count < 1000 |

Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ The log file path configured to capture RabbitMQ logs must be given here. The fi

You can add any custom fields which you want to tag along with the data ingested in sumo. Click on the **Download YAML File** button to get the yaml file.

For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/RabbitMq-OpenTelemetry/RabbitMQ-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ In this step, we will configure the YAML file required for VMWare Collection. He

You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click on the **Download YAML File** button to get the YAML file.

For the Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/VMWare-OpenTelemetry/VMWare-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down Expand Up @@ -299,4 +301,3 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
| `VMware - Host Memory Utilization` | This alert is triggered when host memory utilization is consistently high. | Count `>=` 95 | Count `<` 95 |
| `VMware - VM CPU Ready Time High` | This alert gets triggered when VMs are waiting too long for CPU resources, indicating CPU contention. | Count `>=` 10 | Count `<` 10 |
| `VMware - VM Memory Balloon Pressure` | This alert gets triggered when VMs are experiencing significant memory ballooning. | Count `>=` 1024 | Count `<` 1024 |

Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@ Below are the inputs required:

You can add any custom fields which you want to be tagged with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file.

import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';

<EnvVarOpt/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

### Step 3: Send logs to Sumo Logic
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,16 @@ In this step, you will configure the yaml required for Elasticsearch Collection.
Below are the inputs required:

- **Endpoint**. Enter the url of the server you need to monitor. Example: `http://localhost:9200`.
- **User Name**. Enter the Elasticsearch Username.
- **User Name**. Specifies the username used to authenticate with Elasticsearch using basic auth. Must be specified if password is specified.
- **Password**. Specifies the password used to authenticate with Elasticsearch using basic auth. Must be specified if username is specified.
- **Elasticsearch cluster log path**. By default, Elasticsearch logs are stored in `/var/log/elasticsearch/ELK-<Clustername>.log`.
- **Tags**. `db.cluster.name`.

You can add any custom fields which you want to tag along with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file.

For Linux platform, click on **Download Environment Variables File** button to get the file with the password which is supposed to be set as environment variable.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Elasticsearch-OpenTelemetry/ElasticSearch-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down Expand Up @@ -353,4 +356,4 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
| `Elasticsearch - Query Time Too Slow Alert` | This alert gets triggered when Slow Query Too High (10 ms). | Count > = 1 | Count < 1 |
| `Elasticsearch - Relocating Shards Too Long Alert` | This alert gets triggered when shards relocation take more than 5 min. | Count > = 5 | Count < 5 |
| `Elasticsearch - Too Many Slow Query Alert` | This alert gets triggered when too many slow queries are found in 5 minutes window. | Count > = 10 | Count < 10 |
| `Elasticsearch - Unassigned Shards Alert` | This alert gets triggered when Elasticsearch has unassigned shards. | Count > 5 | Count < = 5 |
| `Elasticsearch - Unassigned Shards Alert` | This alert gets triggered when Elasticsearch has unassigned shards. | Count > 5 | Count < = 5 |
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ Below are the inputs required:

You can add any custom fields which you want to tag along with the data ingested in Sumo. Click on the **Download YAML File** button to get the YAML file.

Click on the **Download YAML File** button to get the YAML file.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.
<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/MongoDB-OpenTelemetry/MongoDB-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,9 @@ You can add any custom fields which you want to tag along with the data ingested

Click on the **Download YAML File** button to get the yaml file.

For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/MySql-OpenTelemetry/MySQL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down Expand Up @@ -345,4 +347,4 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
| `MySQL - Instance down Alert` | This alert gets triggered when we detect that a MySQL instance is down within last 5 minutes interval. | Count > = 1 | Count < 1 |
| `MySQL - Large number of statement errors Alert` | This alert gets triggered when we detect that there are 5 or more statement errors within a 5 minute time interval. | Count > = 5 | Count < 5 |
| `MySQL - Large number of statement warnings Alert` | This alert gets triggered when we detect that there are 20 or more statement warnings within a 5 minute time interval. | Count > = 20 | Count < 20 |
| `MySQL - No index used in the SQL statements Alert` | This alert gets triggered when we detect that there are 5 or more statements not using an index in the SQL query within a 5 minute time interval. | Count > = 5 | Count < 5 |
| `MySQL - No index used in the SQL statements Alert` | This alert gets triggered when we detect that there are 5 or more statements not using an index in the SQL query within a 5 minute time interval. | Count > = 5 | Count < 5 |
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ If logging is not enabled, you can configure it by following the steps below.
The location of these logs will be required when you set up the app through the app catalog.

- **For Oracle version 21c and above**. Based on the [Unified audit policy](https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/AUDIT-Unified-Auditing.html) configured, audit logs exported will be directly ingested to Sumo Logic using syslog or windows event log.
For the Linux environment, instead of redirecting audit logs to a file, we need to redirect them to the local port. In the next step, the OTel collector can be configured to listen to this port and then send the log to Sumo Logic. This can be done using the below configuration in the `rsyslog.conf`. :
For the Linux environment, instead of redirecting audit logs to a file, we need to redirect them to the local port. In the next step, the OTel collector can be configured to listen to this port and then send the log to Sumo Logic. This can be done using the below configuration in the `rsyslog.conf`:
```local7.info @@127.0.0.1:10514```
This will redirect all the unified audit logs to localhost port 10514.

Expand Down Expand Up @@ -197,7 +197,10 @@ Below are the inputs required:
You can add any custom fields which you want to tag along with the data ingested in Sumo Logic.

Once the details are filled, click on the **Download YAML File** button to get the yaml file.
For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.

import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down Expand Up @@ -557,8 +560,8 @@ See information derived from the syslog audit trail, including successful and fa
### Performance Details

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-Performance-Details.png' alt="Monitor Performance by DB Script" />
The Oracle - Performance Details dashboard gives insight about - count of rollback, commits, transaction, process, session.
In addition to this it helps monitoring physical and logical reads, PGA allocated. This dashboard is based on the [metrics collected by Oracle DB opentelemetry receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/oracledbreceiver/documentation.md).
The Oracle - Performance Details dashboard gives insight about - count of rollback, commits, transaction, process, session.
In addition to this, it helps monitoring physical and logical reads, PGA allocated. This dashboard is based on the [metrics collected by Oracle DB opentelemetry receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/oracledbreceiver/documentation.md).

## Create monitors for Oracle app

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ Below is the required input:

You can add any custom fields which you want to tag along with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file.

For linux platform - Click on **Download Environment Variables File** button to get the file with the password which is supposed to be set as environment variable.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Postgresql-OpenTelemetry/PostgreSQL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ You can add any custom fields which you want to tag along with the data ingested

Click on the **Download YAML File** button to get the YAML file.

For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';

<EnvVar/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Redis-OpenTelemetry/Redis-YAML.png' style={{border:'1px solid gray'}} alt="Configuration" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';

The [Apache Tomcat](https://tomcat.apache.org/tomcat-8.5-doc/index.html) app is a unified logs and metrics app that helps you monitor the availability, performance, health, and resource utilization of your Apache Tomcat servers. Preconfigured dashboards provide insight into visitor locations, traffic patterns, errors, resource utilization, garbage collection, web server operations, and access from known malicious sources.

Tomcat logs are sent to Sumo Logic through the OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) and metrics are sent through the [JMX](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) receiver with the `target_system` set as [`tomcat`](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/tomcat.md).
Tomcat logs are sent to Sumo Logic through the OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) and metrics are sent through the [JMX](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jmxreceiver) receiver with the `target_system` set as [`tomcat`](https://github.com/open-telemetry/opentelemetry-java-contrib/blob/main/jmx-metrics/docs/target-systems/tomcat.md).

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Tomcat-OpenTelemetry/Apache-Tomcat-Schematics.png' alt="Schematics" />

Expand Down Expand Up @@ -101,6 +101,10 @@ For metrics, you're required to provide the JMX endpoint (default is `localhost:

You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click the **Download YAML File** button to get the YAML file.

import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';

<EnvVarOpt/>

<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Tomcat-OpenTelemetry/Apache-Tomcat-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />

### Step 3: Send logs and metrics to Sumo Logic
Expand Down
5 changes: 5 additions & 0 deletions docs/reuse/apps/opentelemetry/env-var-optional.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::note
For OpenTelemetry Collector version ≥ 0.104, we recommend using the downloaded config with an environment variable, for example: `${environment_variable}`.

On Linux, click **Download Environment Variables File** to get a file that includes the password, which should be set as an environment variable (if you're using one).
:::
5 changes: 5 additions & 0 deletions docs/reuse/apps/opentelemetry/env-var-required.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::note
If you're using a username and password with OpenTelemetry Collector version ≥ 0.104, we recommend using the downloaded config with an environment variable, for example: `${environment_variable}`.

On Linux, click **Download Environment Variables File** to get a file that includes the password, which should be set as an environment variable.
:::