Skip to content

Commit 4d48e8a

Browse files
sumoanemakimsauce
andauthored
Add env var syntax deprecation note to 12 OpenTelemetry app docs (#5448)
* Adding a note for 12 opentelemetry app docs, after deprecation of env variable syntax in opentelemetry collector syntax * Change in note for apps where username and password (which uses env variable in case of linux env) is optional * tring env varibale syntax due to jenkins job failure * Changes in doc to point to env variable without breaking jenkins job for PR * Add and implement /reuse file * Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * Update docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md * Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * Update docs/integrations/databases/opentelemetry/redis-opentelemetry.md * Update docs/integrations/databases/opentelemetry/redis-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md * split env var note into required + optional versions * Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md * Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md --------- Co-authored-by: Kim Pohas <[email protected]> Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent 14418c2 commit 4d48e8a

File tree

14 files changed

+58
-18
lines changed

14 files changed

+58
-18
lines changed

docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,10 @@ Below is the input required:
102102

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

105+
import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';
106+
107+
<EnvVarOpt/>
108+
105109
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/JMX-OpenTelemetry/JMX-OTEL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
106110

107111
### Step 3: Send logs and metrics to Sumo Logic

docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ Below is the input required:
136136

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

139+
import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';
140+
141+
<EnvVarOpt/>
142+
139143
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/ActiveMQ-OpenTelemetry/ActiveMQ-OTEL-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
140144

141145
### Step 3: Send logs and metrics to Sumo Logic
@@ -355,4 +359,3 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
355359
| `ActiveMQ - No Consumers on Queues Alert` | This alert gets triggered when a ActiveMQ queue has no consumers. | Count < 1 | Count >= 1 |
356360
| `ActiveMQ - Node Down Alert` | This alert gets triggered when a node in the ActiveMQ cluster is down. | Count >= 1 | Count < 1 |
357361
| `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 |
358-

docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ The log file path configured to capture RabbitMQ logs must be given here. The fi
108108

109109
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.
110110

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

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

docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ In this step, we will configure the YAML file required for VMWare Collection. He
6161

6262
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.
6363

64-
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.
64+
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';
65+
66+
<EnvVar/>
6567

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

@@ -299,4 +301,3 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
299301
| `VMware - Host Memory Utilization` | This alert is triggered when host memory utilization is consistently high. | Count `>=` 95 | Count `<` 95 |
300302
| `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 |
301303
| `VMware - VM Memory Balloon Pressure` | This alert gets triggered when VMs are experiencing significant memory ballooning. | Count `>=` 1024 | Count `<` 1024 |
302-

docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ Below are the inputs required:
8080

8181
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.
8282

83+
import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md';
84+
85+
<EnvVarOpt/>
86+
8387
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Cassandra-OpenTelemetry/Cassandra-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
8488

8589
### Step 3: Send logs to Sumo Logic

docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,16 @@ In this step, you will configure the yaml required for Elasticsearch Collection.
9292
Below are the inputs required:
9393

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

99100
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.
100101

101-
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.
102+
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';
103+
104+
<EnvVar/>
102105

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

@@ -353,4 +356,4 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
353356
| `Elasticsearch - Query Time Too Slow Alert` | This alert gets triggered when Slow Query Too High (10 ms). | Count > = 1 | Count < 1 |
354357
| `Elasticsearch - Relocating Shards Too Long Alert` | This alert gets triggered when shards relocation take more than 5 min. | Count > = 5 | Count < 5 |
355358
| `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 |
356-
| `Elasticsearch - Unassigned Shards Alert` | This alert gets triggered when Elasticsearch has unassigned shards. | Count > 5 | Count < = 5 |
359+
| `Elasticsearch - Unassigned Shards Alert` | This alert gets triggered when Elasticsearch has unassigned shards. | Count > 5 | Count < = 5 |

docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ Below are the inputs required:
110110

111111
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.
112112

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

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

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

docs/integrations/databases/opentelemetry/mysql-opentelemetry.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,9 @@ You can add any custom fields which you want to tag along with the data ingested
132132

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

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

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

@@ -345,4 +347,4 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md';
345347
| `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 |
346348
| `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 |
347349
| `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 |
348-
| `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 |
350+
| `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 |

docs/integrations/databases/opentelemetry/oracle-opentelemetry.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ If logging is not enabled, you can configure it by following the steps below.
9191
The location of these logs will be required when you set up the app through the app catalog.
9292
9393
- **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.
94-
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`. :
94+
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`:
9595
```local7.info @@127.0.0.1:10514```
9696
This will redirect all the unified audit logs to localhost port 10514.
9797
@@ -197,7 +197,10 @@ Below are the inputs required:
197197
You can add any custom fields which you want to tag along with the data ingested in Sumo Logic.
198198
199199
Once the details are filled, click on the **Download YAML File** button to get the yaml file.
200-
For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable.
200+
201+
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';
202+
203+
<EnvVar/>
201204
202205
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-YAML.png' style={{border:'1px solid gray'}} alt="YAML" />
203206
@@ -557,8 +560,8 @@ See information derived from the syslog audit trail, including successful and fa
557560
### Performance Details
558561

559562
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/Oracle-OpenTelemetry/Oracle-Performance-Details.png' alt="Monitor Performance by DB Script" />
560-
The Oracle - Performance Details dashboard gives insight about - count of rollback, commits, transaction, process, session.
561-
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).
563+
The Oracle - Performance Details dashboard gives insight about - count of rollback, commits, transaction, process, session.
564+
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).
562565

563566
## Create monitors for Oracle app
564567

docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,9 @@ Below is the required input:
119119

120120
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.
121121

122-
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.
122+
import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';
123+
124+
<EnvVar/>
123125

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

0 commit comments

Comments
 (0)