diff --git a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md index 5e2c7759bc..267088ce7e 100644 --- a/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md +++ b/docs/integrations/app-development/opentelemetry/jmx-opentelemetry.md @@ -102,6 +102,10 @@ Below is the input required: Click on the **Download YAML File** button to get the yaml file. +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; + + + 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..614b3f977f 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/activemq-opentelemetry.md @@ -136,6 +136,10 @@ Below is the input required: Click on the **Download YAML File** button to get the YAML file. +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; + + + YAML ### Step 3: Send logs and metrics to Sumo Logic @@ -355,4 +359,3 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md'; | `ActiveMQ - No Consumers on Queues Alert` | This alert gets triggered when a ActiveMQ queue has no consumers. | Count < 1 | Count >= 1 | | `ActiveMQ - Node Down Alert` | This alert gets triggered when a node in the ActiveMQ cluster is down. | Count >= 1 | Count < 1 | | `ActiveMQ - Too Many Connections Alert` | This alert gets triggered when there are too many connections to a node in a ActiveMQ cluster. | Count >= 1000 | Count < 1000 | - diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index ac87f0a4c9..11ea145483 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -108,7 +108,9 @@ The log file path configured to capture RabbitMQ logs must be given here. The fi You can add any custom fields which you want to tag along with the data ingested in sumo. Click on the **Download YAML File** button to get the yaml file. -For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + YAML diff --git a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md index eaa9c9f38d..1d602c70a4 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/vmware-opentelemetry.md @@ -61,7 +61,9 @@ In this step, we will configure the YAML file required for VMWare Collection. He You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click on the **Download YAML File** button to get the YAML file. -For the Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + YAML @@ -299,4 +301,3 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md'; | `VMware - Host Memory Utilization` | This alert is triggered when host memory utilization is consistently high. | Count `>=` 95 | Count `<` 95 | | `VMware - VM CPU Ready Time High` | This alert gets triggered when VMs are waiting too long for CPU resources, indicating CPU contention. | Count `>=` 10 | Count `<` 10 | | `VMware - VM Memory Balloon Pressure` | This alert gets triggered when VMs are experiencing significant memory ballooning. | Count `>=` 1024 | Count `<` 1024 | - diff --git a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md index 935ecbd51c..21167662dd 100644 --- a/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/cassandra-opentelemetry.md @@ -80,6 +80,10 @@ Below are the inputs required: You can add any custom fields which you want to be tagged with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file. +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; + + + 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..f72e4758ff 100644 --- a/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/elasticsearch-opentelemetry.md @@ -92,13 +92,16 @@ In this step, you will configure the yaml required for Elasticsearch Collection. Below are the inputs required: - **Endpoint**. Enter the url of the server you need to monitor. Example: `http://localhost:9200`. -- **User Name**. Enter the Elasticsearch Username. +- **User Name**. Specifies the username used to authenticate with Elasticsearch using basic auth. Must be specified if password is specified. +- **Password**. Specifies the password used to authenticate with Elasticsearch using basic auth. Must be specified if username is specified. - **Elasticsearch cluster log path**. By default, Elasticsearch logs are stored in `/var/log/elasticsearch/ELK-.log`. - **Tags**. `db.cluster.name`. You can add any custom fields which you want to tag along with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file. -For Linux platform, click on **Download Environment Variables File** button to get the file with the password which is supposed to be set as environment variable. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + YAML @@ -353,4 +356,4 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md'; | `Elasticsearch - Query Time Too Slow Alert` | This alert gets triggered when Slow Query Too High (10 ms). | Count > = 1 | Count < 1 | | `Elasticsearch - Relocating Shards Too Long Alert` | This alert gets triggered when shards relocation take more than 5 min. | Count > = 5 | Count < 5 | | `Elasticsearch - Too Many Slow Query Alert` | This alert gets triggered when too many slow queries are found in 5 minutes window. | Count > = 10 | Count < 10 | -| `Elasticsearch - Unassigned Shards Alert` | This alert gets triggered when Elasticsearch has unassigned shards. | Count > 5 | Count < = 5 | \ 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 c1f85d3c94..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. -Click on the **Download YAML File** button to get the YAML file. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; -For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + YAML diff --git a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md index d0bcb5afd2..5f7f313ea3 100644 --- a/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mysql-opentelemetry.md @@ -132,7 +132,9 @@ You can add any custom fields which you want to tag along with the data ingested Click on the **Download YAML File** button to get the yaml file. -For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + YAML @@ -345,4 +347,4 @@ import CreateMonitors from '../../../reuse/apps/create-monitors.md'; | `MySQL - Instance down Alert` | This alert gets triggered when we detect that a MySQL instance is down within last 5 minutes interval. | Count > = 1 | Count < 1 | | `MySQL - Large number of statement errors Alert` | This alert gets triggered when we detect that there are 5 or more statement errors within a 5 minute time interval. | Count > = 5 | Count < 5 | | `MySQL - Large number of statement warnings Alert` | This alert gets triggered when we detect that there are 20 or more statement warnings within a 5 minute time interval. | Count > = 20 | Count < 20 | -| `MySQL - No index used in the SQL statements Alert` | This alert gets triggered when we detect that there are 5 or more statements not using an index in the SQL query within a 5 minute time interval. | Count > = 5 | Count < 5 | \ 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 1be791d8d9..509a0d4e03 100644 --- a/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/oracle-opentelemetry.md @@ -91,7 +91,7 @@ If logging is not enabled, you can configure it by following the steps below. The location of these logs will be required when you set up the app through the app catalog. - **For Oracle version 21c and above**. Based on the [Unified audit policy](https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/AUDIT-Unified-Auditing.html) configured, audit logs exported will be directly ingested to Sumo Logic using syslog or windows event log. -For the Linux environment, instead of redirecting audit logs to a file, we need to redirect them to the local port. In the next step, the OTel collector can be configured to listen to this port and then send the log to Sumo Logic. This can be done using the below configuration in the `rsyslog.conf`. : +For the Linux environment, instead of redirecting audit logs to a file, we need to redirect them to the local port. In the next step, the OTel collector can be configured to listen to this port and then send the log to Sumo Logic. This can be done using the below configuration in the `rsyslog.conf`: ```local7.info @@127.0.0.1:10514``` This will redirect all the unified audit logs to localhost port 10514. @@ -197,7 +197,10 @@ Below are the inputs required: You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Once the details are filled, click on the **Download YAML File** button to get the yaml file. -For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. + +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + YAML @@ -557,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 254f3ea220..2b3913a721 100644 --- a/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/postgresql-opentelemetry.md @@ -119,7 +119,9 @@ Below is the required input: You can add any custom fields which you want to tag along with the data ingested in Sumo. Click on the **Download YAML File** button to get the yaml file. -For linux platform - Click on **Download Environment Variables File** button to get the file with the password which is supposed to be set as environment variable. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + YAML diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 64eac0af57..5691d1cb85 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -94,7 +94,9 @@ You can add any custom fields which you want to tag along with the data ingested Click on the **Download YAML File** button to get the YAML file. -For Linux platform, click **Download Environment Variables File** to get the file with the password which is supposed to be set as environment variable. +import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md'; + + 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..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,6 +101,10 @@ For metrics, you're required to provide the JMX endpoint (default is `localhost: You can add any custom fields which you want to tag along with the data ingested in Sumo Logic. Click the **Download YAML File** button to get the YAML file. +import EnvVarOpt from '../../../reuse/apps/opentelemetry/env-var-optional.md'; + + + YAML ### Step 3: Send logs and metrics to Sumo Logic 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/env-var-required.md b/docs/reuse/apps/opentelemetry/env-var-required.md new file mode 100644 index 0000000000..e001e1ef73 --- /dev/null +++ b/docs/reuse/apps/opentelemetry/env-var-required.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 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. +:::