From 92f87ec976fd52baaf0fa0860f7066fdf29e6489 Mon Sep 17 00:00:00 2001 From: sumoanema Date: Wed, 4 Jun 2025 13:43:39 +0530 Subject: [PATCH 01/20] Adding a note for 12 opentelemetry app docs, after deprecation of env variable syntax in opentelemetry collector syntax --- .../app-development/opentelemetry/jmx-opentelemetry.md | 5 +++++ .../opentelemetry/activemq-opentelemetry.md | 5 +++++ .../opentelemetry/rabbitmq-opentelemetry.md | 5 +++++ .../opentelemetry/vmware-opentelemetry.md | 5 +++++ .../databases/opentelemetry/cassandra-opentelemetry.md | 5 +++++ .../databases/opentelemetry/elasticsearch-opentelemetry.md | 5 +++++ .../databases/opentelemetry/mongodb-opentelemetry.md | 5 ++++- .../databases/opentelemetry/mysql-opentelemetry.md | 5 +++++ .../databases/opentelemetry/oracle-opentelemetry.md | 6 ++++++ .../databases/opentelemetry/postgresql-opentelemetry.md | 5 +++++ .../databases/opentelemetry/redis-opentelemetry.md | 5 +++++ .../opentelemetry/apache-tomcat-opentelemetry.md | 5 +++++ 12 files changed, 60 insertions(+), 1 deletion(-) diff --git a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md index 5e2c7759bc..81b67f49e1 100644 --- a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md +++ b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md @@ -102,6 +102,11 @@ Below is the input required: Click on the **Download YAML File** button to get the yaml file. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + YAML ### Step 3: Send logs and metrics to Sumo Logic diff --git a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md index 07f1ae261c..8b88c04c8a 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md @@ -136,6 +136,11 @@ Below is the input required: Click on the **Download YAML File** button to get the YAML file. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + YAML ### Step 3: Send logs and metrics to Sumo Logic diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index ac87f0a4c9..ad5e850493 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -108,6 +108,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. YAML diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index eaa9c9f38d..9d298c5318 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -61,6 +61,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + 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. YAML diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 935ecbd51c..a08a650ac0 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -80,6 +80,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + YAML ### Step 3: Send logs to Sumo Logic diff --git a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md index 0c5903a785..f7487c9931 100644 --- a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md @@ -100,6 +100,11 @@ You can add any custom fields which you want to tag along with the data ingested 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + YAML ### Step 3: Send logs and metrics to Sumo Logic diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index c1f85d3c94..aa8db47843 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -110,7 +110,10 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md index d0bcb5afd2..a7a977eb7b 100644 --- a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md @@ -132,6 +132,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. YAML diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 1be791d8d9..7adcb633a7 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -197,6 +197,12 @@ 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. + +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. YAML diff --git a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md index 254f3ea220..5699f35af8 100644 --- a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md @@ -119,6 +119,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + 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. YAML diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 64eac0af57..d9eaf8043c 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -94,6 +94,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. Configuration diff --git a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md index d207108ed2..2aae0ea653 100644 --- a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md @@ -101,6 +101,11 @@ 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. +::: note +For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +${environment_variable} +::: + YAML ### Step 3: Send logs and metrics to Sumo Logic From 856e93d05db39ba2b58266c0facf9e5dd4f69f83 Mon Sep 17 00:00:00 2001 From: sumoanema Date: Wed, 4 Jun 2025 13:59:05 +0530 Subject: [PATCH 02/20] Change in note for apps where username and password (which uses env variable in case of linux env) is optional --- .../app-development/opentelemetry/jmx-opentelemetry.md | 4 +++- .../opentelemetry/activemq-opentelemetry.md | 4 +++- .../databases/opentelemetry/cassandra-opentelemetry.md | 4 +++- .../databases/opentelemetry/elasticsearch-opentelemetry.md | 7 ++++--- .../opentelemetry/apache-tomcat-opentelemetry.md | 4 +++- 5 files changed, 16 insertions(+), 7 deletions(-) diff --git a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md index 81b67f49e1..52c897ec93 100644 --- a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md +++ b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md @@ -103,10 +103,12 @@ Below is the input required: Click on the **Download YAML File** button to get the yaml file. ::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : ${environment_variable} ::: +For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML ### Step 3: Send logs and metrics to Sumo Logic diff --git a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md index 8b88c04c8a..7c138fbfd7 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md @@ -137,10 +137,12 @@ Below is the input required: Click on the **Download YAML File** button to get the YAML file. ::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : ${environment_variable} ::: +For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML ### Step 3: Send logs and metrics to Sumo Logic diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index a08a650ac0..bf2cf76da4 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -81,10 +81,12 @@ 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. ::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : ${environment_variable} ::: +For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML ### Step 3: Send logs to Sumo Logic diff --git a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md index f7487c9931..017dc22dda 100644 --- a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md @@ -92,19 +92,20 @@ 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-.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. - ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : ${environment_variable} ::: +For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML ### Step 3: Send logs and metrics to Sumo Logic diff --git a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md index 2aae0ea653..061e4a7e05 100644 --- a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md @@ -102,10 +102,12 @@ 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. ::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : +If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : ${environment_variable} ::: +For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML ### Step 3: Send logs and metrics to Sumo Logic From 20b62c36afca7deedee5be80bcfb87d65e13c026 Mon Sep 17 00:00:00 2001 From: sumoanema Date: Wed, 4 Jun 2025 14:28:06 +0530 Subject: [PATCH 03/20] tring env varibale syntax due to jenkins job failure --- .../app-development/opentelemetry/jmx-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md index 52c897ec93..ce042aa06d 100644 --- a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md +++ b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md @@ -104,7 +104,7 @@ Click on the **Download YAML File** button to get the yaml file. ::: note If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. From 45e6e9302953fc6b93d7e524ee3e73237079a80f Mon Sep 17 00:00:00 2001 From: sumoanema Date: Wed, 4 Jun 2025 14:41:49 +0530 Subject: [PATCH 04/20] Changes in doc to point to env variable without breaking jenkins job for PR --- .../opentelemetry/activemq-opentelemetry.md | 2 +- .../opentelemetry/rabbitmq-opentelemetry.md | 2 +- .../opentelemetry/vmware-opentelemetry.md | 2 +- .../databases/opentelemetry/cassandra-opentelemetry.md | 2 +- .../databases/opentelemetry/elasticsearch-opentelemetry.md | 2 +- .../databases/opentelemetry/mongodb-opentelemetry.md | 2 +- .../integrations/databases/opentelemetry/mysql-opentelemetry.md | 2 +- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- .../databases/opentelemetry/postgresql-opentelemetry.md | 2 +- .../integrations/databases/opentelemetry/redis-opentelemetry.md | 2 +- .../web-servers/opentelemetry/apache-tomcat-opentelemetry.md | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md index 7c138fbfd7..466c296e14 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md @@ -138,7 +138,7 @@ Click on the **Download YAML File** button to get the YAML file. ::: note If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index ad5e850493..d6fa509b7a 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -110,7 +110,7 @@ You can add any custom fields which you want to tag along with the data ingested ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index 9d298c5318..852a400111 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -63,7 +63,7 @@ You can add any custom fields which you want to tag along with the data ingested ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: 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. diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index bf2cf76da4..5c99033541 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -82,7 +82,7 @@ You can add any custom fields which you want to be tagged with the data ingested ::: note If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md index 017dc22dda..df43091543 100644 --- a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md @@ -101,7 +101,7 @@ You can add any custom fields which you want to tag along with the data ingested ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index aa8db47843..9c5643e400 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -112,7 +112,7 @@ You can add any custom fields which you want to tag along with the data ingested ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md index a7a977eb7b..86e80322f3 100644 --- a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md @@ -134,7 +134,7 @@ Click on the **Download YAML File** button to get the yaml file. ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 7adcb633a7..afe4230f54 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -200,7 +200,7 @@ Once the details are filled, click on the **Download YAML File** button to get t ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md index 5699f35af8..6ac3514b27 100644 --- a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md @@ -121,7 +121,7 @@ You can add any custom fields which you want to tag along with the data ingested ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: 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. diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index d9eaf8043c..764e9c2f63 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -96,7 +96,7 @@ Click on the **Download YAML File** button to get the YAML file. ::: note For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. diff --git a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md index 061e4a7e05..61f9f9671a 100644 --- a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md @@ -103,7 +103,7 @@ You can add any custom fields which you want to tag along with the data ingested ::: note If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -${environment_variable} +`${environment_variable}` ::: For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. From 64e33d474f2c09e26496651abef6032fa7e5114e Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Wed, 4 Jun 2025 14:22:33 -0400 Subject: [PATCH 05/20] Add and implement /reuse file --- .../opentelemetry/jmx-opentelemetry.md | 7 ++---- .../opentelemetry/activemq-opentelemetry.md | 8 ++---- .../opentelemetry/rabbitmq-opentelemetry.md | 9 +++---- .../opentelemetry/vmware-opentelemetry.md | 8 ++---- .../opentelemetry/cassandra-opentelemetry.md | 11 +++----- .../elasticsearch-opentelemetry.md | 9 +++---- .../opentelemetry/mongodb-opentelemetry.md | 7 ++---- .../opentelemetry/mysql-opentelemetry.md | 9 +++---- .../opentelemetry/oracle-opentelemetry.md | 25 ++++++++----------- .../opentelemetry/postgresql-opentelemetry.md | 7 ++---- .../opentelemetry/redis-opentelemetry.md | 13 ++++------ .../apache-tomcat-opentelemetry.md | 7 ++---- docs/reuse/apps/opentelemetry/config-linux.md | 5 ++++ 13 files changed, 46 insertions(+), 79 deletions(-) create mode 100644 docs/reuse/apps/opentelemetry/config-linux.md diff --git a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md index ce042aa06d..1e1ca49fe6 100644 --- a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md +++ b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md @@ -102,12 +102,9 @@ Below is the input required: Click on the **Download YAML File** button to get the yaml file. -::: note -If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML diff --git a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md index 466c296e14..f07294d167 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md @@ -136,12 +136,9 @@ Below is the input required: Click on the **Download YAML File** button to get the YAML file. -::: note -If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML @@ -362,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 | - diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index d6fa509b7a..1288662ad5 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -108,12 +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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.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. + YAML @@ -221,7 +218,7 @@ This sample Query is from the **RabbitMQ - Logs dashboard** > **Events** by Seve This sample query is from the **Average Number of Consumers** panel in **RabbitMQ - Metrics** dashboard. ```sql sumo.datasource=rabbitmq metric=rabbitmq.consumer.count deployment.environment=* messaging.cluster.name=* messaging.node.name=* rabbitmq.queue.name=* rabbitmq.vhost.name=* -| avg by messaging.cluster.name +| avg by messaging.cluster.name | sum ``` diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index 852a400111..8de9f1bb16 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -61,12 +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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -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. + YAML @@ -304,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 | - diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 5c99033541..22aaf467b8 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -80,12 +80,9 @@ 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. -::: note -If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML @@ -192,7 +189,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Nodes Up panel: ```sql -%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop +%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop | if (isEmpty(_rawlog), _raw, _rawlog) as _raw | parse regex field=_raw "(?[A-Z]*) *\[(?[^\]]*?)[:_-]?(?[0-9]*)\] (?.{10} .{12}) *(?[^:]*):(?[0-9]*) - (?.*)" | if (message matches "InetAddress * is now UP",1,0) as UP @@ -206,7 +203,7 @@ Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel: ```sql -sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum +sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum ``` ## Viewing Cassandra dashboards diff --git a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md index df43091543..06b47b27a1 100644 --- a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md @@ -99,12 +99,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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML @@ -359,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 | \ No newline at end of file +| `Elasticsearch - Unassigned Shards Alert` | This alert gets triggered when Elasticsearch has unassigned shards. | Count > 5 | Count < = 5 | diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 9c5643e400..9142d98d4e 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -110,12 +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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.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. + YAML diff --git a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md index 86e80322f3..c8976fea0e 100644 --- a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md @@ -132,12 +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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.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. + YAML @@ -350,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 | \ No newline at end of file +| `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 | diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index afe4230f54..e5218e2824 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -79,7 +79,7 @@ If logging is not enabled, you can configure it by following the steps below. ``` [oracle@sumolab alert]$ lsnrctl status ``` -- **Oracle Audit Logs**. +- **Oracle Audit Logs**. - **For Oracle version 19c and below**. By default, Oracle logs are stored in ``` $ORACLE_BASE/app/oracle/admin/orcl/adump @@ -90,8 +90,8 @@ 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 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`. : ```local7.info @@127.0.0.1:10514``` This will redirect all the unified audit logs to localhost port 10514. @@ -107,7 +107,7 @@ To set up the performance metrics script on Linux and Windows for the Oracle app defaultValue="Linux" values={[ {label: 'Linux', value: 'Linux'}, - {label: 'Windows', value: 'Windows'} + {label: 'Windows', value: 'Windows'} ]}> @@ -184,11 +184,11 @@ Below are the inputs required: - **`Alert Logs`**. Path of the log file configured to capture oracle alert logs. - **`Listener Logs`**. Path of the log file configured to capture oracle listener logs . -- **`Audit Logs`**. +- **`Audit Logs`**. - For **Traditional Audit Logs**, path of the log file is configured to capture oracle audit logs. - For **Unified Audit Logs**, you need to select the OS where the Oracle is setup - Windows or Linux. For Oracle on Windows machine, no parameter is required. Only respective event IDs will be ingested. For the Linux environment, you need to provide the **port** (configured in pre-requisite steps for the Linux environment) which the syslog receiver should listen to for sending the logs to Sumo Logic. - **`Performance metric script-based logs`**. Path of the log file configured to capture log generated through script can be configured in other logs. -- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`. +- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`. - **`username`**. Username for the OracleDB connection. - **`password`**. Password for the OracleDB connection. Special characters are allowed. - **`service`**. OracleDB Service that the receiver should connect to. @@ -198,12 +198,9 @@ You can add any custom fields which you want to tag along with the data ingested Once the details are filled, click on the **Download YAML File** button to get the yaml file. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.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. + YAML @@ -324,7 +321,7 @@ This sample query is from the **Oracle - Overview** dashboard > **DB Connection* This sample query is from the **Oracle - Overview** dashboard > **Session Count** panel. ```sql title="Session Count" -sumo.datasource=oracle metric=oracledb.sessions.usage deployment.environment=* db.cluster.name=* db.node.name=* | sum +sumo.datasource=oracle metric=oracledb.sessions.usage deployment.environment=* db.cluster.name=* db.node.name=* | sum ``` ## Viewing Oracle dashboards @@ -563,8 +560,8 @@ See information derived from the syslog audit trail, including successful and fa ### Performance Details 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 diff --git a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md index 6ac3514b27..5fc7177183 100644 --- a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md @@ -119,12 +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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -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. + YAML diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 764e9c2f63..03decf89c8 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -94,12 +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. -::: note -For OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.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. + Configuration @@ -200,10 +197,10 @@ db.cluster.name=* sumo.datasource="redis" This sample query is from the **Redis - Cluster Operations** dashboard Metrics panel. -```sql sumo.datasource=redis metric=redis.cmd.calls -(cmd=set* or cmd=get* or cmd=incr* or cmd=decr* or cmd=mget or cmd=mset* or cmd=strlen or cmd=psetex or cmd=append) +```sql sumo.datasource=redis metric=redis.cmd.calls +(cmd=set* or cmd=get* or cmd=incr* or cmd=decr* or cmd=mget or cmd=mset* or cmd=strlen or cmd=psetex or cmd=append) deployment.environment=* db.cluster.name=* db.node.name=* -| delta +| delta | sum ``` diff --git a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md index 61f9f9671a..44a3e39375 100644 --- a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md @@ -101,12 +101,9 @@ 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. -::: note -If using username and password with OpenTelemetry collector version >= 0.104 we recommend to use the downloaded config with environment variable as : -`${environment_variable}` -::: +import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; -For Linux platform if using username and password, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML diff --git a/docs/reuse/apps/opentelemetry/config-linux.md b/docs/reuse/apps/opentelemetry/config-linux.md new file mode 100644 index 0000000000..ba7488af9a --- /dev/null +++ b/docs/reuse/apps/opentelemetry/config-linux.md @@ -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 file 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. From 73748a7bbea46b29b20d17f73d0ccdf0dbe970d3 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:22:55 -0700 Subject: [PATCH 06/20] Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md --- .../databases/opentelemetry/cassandra-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 22aaf467b8..5fa58608dd 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -189,7 +189,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Nodes Up panel: ```sql -%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop +%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop | if (isEmpty(_rawlog), _raw, _rawlog) as _raw | parse regex field=_raw "(?[A-Z]*) *\[(?[^\]]*?)[:_-]?(?[0-9]*)\] (?.{10} .{12}) *(?[^:]*):(?[0-9]*) - (?.*)" | if (message matches "InetAddress * is now UP",1,0) as UP From e3a77b496cc6c4aacb57b1f562556c8ecafb9e99 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:23:41 -0700 Subject: [PATCH 07/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index e5218e2824..00b62ead60 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -79,7 +79,7 @@ If logging is not enabled, you can configure it by following the steps below. ``` [oracle@sumolab alert]$ lsnrctl status ``` -- **Oracle Audit Logs**. +- **Oracle Audit Logs**. - **For Oracle version 19c and below**. By default, Oracle logs are stored in ``` $ORACLE_BASE/app/oracle/admin/orcl/adump From 3ef295d1f996059798c1d26a9f5548f24c8fe04e Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:23:53 -0700 Subject: [PATCH 08/20] Update docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md --- .../opentelemetry/rabbitmq-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index 1288662ad5..e695b805bc 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -218,7 +218,7 @@ This sample Query is from the **RabbitMQ - Logs dashboard** > **Events** by Seve This sample query is from the **Average Number of Consumers** panel in **RabbitMQ - Metrics** dashboard. ```sql sumo.datasource=rabbitmq metric=rabbitmq.consumer.count deployment.environment=* messaging.cluster.name=* messaging.node.name=* rabbitmq.queue.name=* rabbitmq.vhost.name=* -| avg by messaging.cluster.name +| avg by messaging.cluster.name | sum ``` From 7f6f47309ffeb1895cbd4d514b47611f34005c5b Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:24:01 -0700 Subject: [PATCH 09/20] Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md --- .../databases/opentelemetry/cassandra-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 5fa58608dd..e08197bd2a 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -203,7 +203,7 @@ Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel: ```sql -sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum +sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum ``` ## Viewing Cassandra dashboards From 243fe28443f10e2330898d4b05cf07f51af42f8e Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:25:18 -0700 Subject: [PATCH 10/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 00b62ead60..8358723d79 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -321,7 +321,7 @@ This sample query is from the **Oracle - Overview** dashboard > **DB Connection* This sample query is from the **Oracle - Overview** dashboard > **Session Count** panel. ```sql title="Session Count" -sumo.datasource=oracle metric=oracledb.sessions.usage deployment.environment=* db.cluster.name=* db.node.name=* | sum +sumo.datasource=oracle metric=oracledb.sessions.usage deployment.environment=* db.cluster.name=* db.node.name=* | sum ``` ## Viewing Oracle dashboards From 30b1e7753c0a8121f3999bc26b933dd587916b83 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:25:30 -0700 Subject: [PATCH 11/20] Update docs/integrations/databases/opentelemetry/redis-opentelemetry.md --- .../integrations/databases/opentelemetry/redis-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 03decf89c8..213b59fa6e 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -200,7 +200,7 @@ This sample query is from the **Redis - Cluster Operations** dashboard Metrics p ```sql sumo.datasource=redis metric=redis.cmd.calls (cmd=set* or cmd=get* or cmd=incr* or cmd=decr* or cmd=mget or cmd=mset* or cmd=strlen or cmd=psetex or cmd=append) deployment.environment=* db.cluster.name=* db.node.name=* -| delta +| delta | sum ``` From a98c706fe037a8b68017db3681e3b1aad320e898 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:25:45 -0700 Subject: [PATCH 12/20] Update docs/integrations/databases/opentelemetry/redis-opentelemetry.md --- .../databases/opentelemetry/redis-opentelemetry.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 213b59fa6e..f53d42227a 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -197,8 +197,8 @@ db.cluster.name=* sumo.datasource="redis" This sample query is from the **Redis - Cluster Operations** dashboard Metrics panel. -```sql sumo.datasource=redis metric=redis.cmd.calls -(cmd=set* or cmd=get* or cmd=incr* or cmd=decr* or cmd=mget or cmd=mset* or cmd=strlen or cmd=psetex or cmd=append) +```sql sumo.datasource=redis metric=redis.cmd.calls +(cmd=set* or cmd=get* or cmd=incr* or cmd=decr* or cmd=mget or cmd=mset* or cmd=strlen or cmd=psetex or cmd=append) deployment.environment=* db.cluster.name=* db.node.name=* | delta | sum From 70a379b6dc56e2f18f1ee8c8c91f6e1babfc3e27 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:26:12 -0700 Subject: [PATCH 13/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 8358723d79..493987fd47 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -188,7 +188,7 @@ Below are the inputs required: - For **Traditional Audit Logs**, path of the log file is configured to capture oracle audit logs. - For **Unified Audit Logs**, you need to select the OS where the Oracle is setup - Windows or Linux. For Oracle on Windows machine, no parameter is required. Only respective event IDs will be ingested. For the Linux environment, you need to provide the **port** (configured in pre-requisite steps for the Linux environment) which the syslog receiver should listen to for sending the logs to Sumo Logic. - **`Performance metric script-based logs`**. Path of the log file configured to capture log generated through script can be configured in other logs. -- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`. +- **`Endpoint (no default)`**. Endpoint used to connect to the OracleDB server. Must be in the format of `host:port`. - **`username`**. Username for the OracleDB connection. - **`password`**. Password for the OracleDB connection. Special characters are allowed. - **`service`**. OracleDB Service that the receiver should connect to. From f269b4e4a97f4274e888c8183f743cba3d3b198d Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:26:21 -0700 Subject: [PATCH 14/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 493987fd47..167f9d20e5 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -107,7 +107,7 @@ To set up the performance metrics script on Linux and Windows for the Oracle app defaultValue="Linux" values={[ {label: 'Linux', value: 'Linux'}, - {label: 'Windows', value: 'Windows'} + {label: 'Windows', value: 'Windows'} ]}> From 1aa4df275217bed96ea851fb8a37bb788b88d194 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:26:34 -0700 Subject: [PATCH 15/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 167f9d20e5..eb72d0a6ad 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -184,7 +184,7 @@ Below are the inputs required: - **`Alert Logs`**. Path of the log file configured to capture oracle alert logs. - **`Listener Logs`**. Path of the log file configured to capture oracle listener logs . -- **`Audit Logs`**. +- **`Audit Logs`**. - For **Traditional Audit Logs**, path of the log file is configured to capture oracle audit logs. - For **Unified Audit Logs**, you need to select the OS where the Oracle is setup - Windows or Linux. For Oracle on Windows machine, no parameter is required. Only respective event IDs will be ingested. For the Linux environment, you need to provide the **port** (configured in pre-requisite steps for the Linux environment) which the syslog receiver should listen to for sending the logs to Sumo Logic. - **`Performance metric script-based logs`**. Path of the log file configured to capture log generated through script can be configured in other logs. From 914d94f4240233104eea6ec6c0145a796f2e2744 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:27:42 -0700 Subject: [PATCH 16/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index eb72d0a6ad..0a9dd7290c 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -90,8 +90,8 @@ 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 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`: ```local7.info @@127.0.0.1:10514``` This will redirect all the unified audit logs to localhost port 10514. From 5819c51b89e4d5bb096ddf687566dd387e686def Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:28:30 -0700 Subject: [PATCH 17/20] Update docs/integrations/databases/opentelemetry/oracle-opentelemetry.md --- .../databases/opentelemetry/oracle-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 0a9dd7290c..2d5e0171c5 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -561,7 +561,7 @@ See information derived from the syslog audit trail, including successful and fa 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). +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 From 08f64a8868eb12225cbf24c4a08d615287d19fe5 Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Thu, 5 Jun 2025 21:31:22 -0400 Subject: [PATCH 18/20] split env var note into required + optional versions --- .../app-development/opentelemetry/jmx-opentelemetry.md | 4 ++-- .../opentelemetry/activemq-opentelemetry.md | 4 ++-- .../opentelemetry/rabbitmq-opentelemetry.md | 4 ++-- .../opentelemetry/vmware-opentelemetry.md | 4 ++-- .../databases/opentelemetry/cassandra-opentelemetry.md | 8 ++++---- .../opentelemetry/elasticsearch-opentelemetry.md | 4 ++-- .../databases/opentelemetry/mongodb-opentelemetry.md | 4 ++-- .../databases/opentelemetry/mysql-opentelemetry.md | 4 ++-- .../databases/opentelemetry/oracle-opentelemetry.md | 4 ++-- .../databases/opentelemetry/postgresql-opentelemetry.md | 4 ++-- .../databases/opentelemetry/redis-opentelemetry.md | 4 ++-- .../opentelemetry/apache-tomcat-opentelemetry.md | 6 +++--- docs/reuse/apps/opentelemetry/env-var-optional.md | 5 +++++ .../{config-linux.md => env-var-required.md} | 4 ++-- 14 files changed, 34 insertions(+), 29 deletions(-) create mode 100644 docs/reuse/apps/opentelemetry/env-var-optional.md rename docs/reuse/apps/opentelemetry/{config-linux.md => env-var-required.md} (79%) diff --git a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md index 1e1ca49fe6..267088ce7e 100644 --- a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md +++ b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md @@ -102,9 +102,9 @@ Below is the input required: Click on the **Download YAML File** button to get the yaml file. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; - + YAML diff --git a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md index f07294d167..614b3f977f 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md @@ -136,9 +136,9 @@ Below is the input required: Click on the **Download YAML File** button to get the YAML file. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; - + YAML diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index e695b805bc..11ea145483 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -108,9 +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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index 8de9f1bb16..1d602c70a4 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -61,9 +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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index e08197bd2a..67869a5187 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -80,9 +80,9 @@ 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 ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; - + YAML @@ -189,7 +189,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Nodes Up panel: ```sql -%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop +%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop | if (isEmpty(_rawlog), _raw, _rawlog) as _raw | parse regex field=_raw "(?[A-Z]*) *\[(?[^\]]*?)[:_-]?(?[0-9]*)\] (?.{10} .{12}) *(?[^:]*):(?[0-9]*) - (?.*)" | if (message matches "InetAddress * is now UP",1,0) as UP @@ -203,7 +203,7 @@ Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel: ```sql -sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum +sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum ``` ## Viewing Cassandra dashboards diff --git a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md index 06b47b27a1..f72e4758ff 100644 --- a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md @@ -99,9 +99,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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 9142d98d4e..67228666a9 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md index c8976fea0e..5f7f313ea3 100644 --- a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md @@ -132,9 +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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md index 2d5e0171c5..509a0d4e03 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -198,9 +198,9 @@ You can add any custom fields which you want to tag along with the data ingested Once the details are filled, click on the **Download YAML File** button to get the yaml file. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md index 5fc7177183..2b3913a721 100644 --- a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md @@ -119,9 +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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + YAML diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index f53d42227a..5691d1cb85 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -94,9 +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. -import ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; - + Configuration diff --git a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md index 44a3e39375..bc8c709466 100644 --- a/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/apache-tomcat-opentelemetry.md @@ -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). Schematics @@ -101,9 +101,9 @@ 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 ConfigLinux from '../../../reuse/apps/opentelemetry/config-linux.md'; +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; - + YAML diff --git a/docs/reuse/apps/opentelemetry/env-var-optional.md b/docs/reuse/apps/opentelemetry/env-var-optional.md new file mode 100644 index 0000000000..942cb2d5d3 --- /dev/null +++ b/docs/reuse/apps/opentelemetry/env-var-optional.md @@ -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). +::: diff --git a/docs/reuse/apps/opentelemetry/config-linux.md b/docs/reuse/apps/opentelemetry/env-var-required.md similarity index 79% rename from docs/reuse/apps/opentelemetry/config-linux.md rename to docs/reuse/apps/opentelemetry/env-var-required.md index ba7488af9a..e001e1ef73 100644 --- a/docs/reuse/apps/opentelemetry/config-linux.md +++ b/docs/reuse/apps/opentelemetry/env-var-required.md @@ -1,5 +1,5 @@ :::note -If you're using a username and password with OpenTelemetry Collector version ≥ 0.104, we recommend using the downloaded config file with an environment variable, for example: `${environment_variable}`. -::: +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. +::: From f54faa9b85487bf42a532ecff6369526b7e52e57 Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Thu, 5 Jun 2025 18:33:46 -0700 Subject: [PATCH 19/20] Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md --- .../databases/opentelemetry/cassandra-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 67869a5187..483f54aad1 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -203,7 +203,7 @@ Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Following is the query from Cassandra App's overview Dashboard's Number of Requests Panel: ```sql -sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum +sumo.datasource=cassandra deployment.environment=* db.cluster.name=* db.node.name=* metric=cassandra.client.request.count | sum ``` ## Viewing Cassandra dashboards From 5ee48246b39a763206c6d63378aa7e558a0b635b Mon Sep 17 00:00:00 2001 From: "Kim (Sumo Logic)" <56411016+kimsauce@users.noreply.github.com> Date: Thu, 5 Jun 2025 18:34:28 -0700 Subject: [PATCH 20/20] Update docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md --- .../databases/opentelemetry/cassandra-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 483f54aad1..21167662dd 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -189,7 +189,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; Following is a query from the Cassandra app's **Cassandra - Overview** dashboard Nodes Up panel: ```sql -%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop +%"sumo.datasource"=cassandra %"deployment.environment"=* %"db.cluster.name"=* "INFO" | json "log" as _rawlog nodrop | if (isEmpty(_rawlog), _raw, _rawlog) as _raw | parse regex field=_raw "(?[A-Z]*) *\[(?[^\]]*?)[:_-]?(?[0-9]*)\] (?.{10} .{12}) *(?[^:]*):(?[0-9]*) - (?.*)" | if (message matches "InetAddress * is now UP",1,0) as UP