From 9d3583108806dc0396f030ad7ae6cfdbe4c14fa3 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Tue, 10 Sep 2024 17:27:30 +0530 Subject: [PATCH 01/18] Added metrics collection and metrics-based dashboards info to MongoDB --- .../opentelemetry/mongodb-opentelemetry.md | 76 +++++++++++++++---- 1 file changed, 63 insertions(+), 13 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 8929e418ca..83f53f9282 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -11,15 +11,17 @@ import TabItem from '@theme/TabItem'; Thumbnail iconThumbnail icon -[MongoDB](https://www.mongodb.com/why-use-mongodb#:~:text=MongoDB%20is%20a%20document%20database,development%20teams%20using%20agile%20methodologies.) is a source-available cross-platform document-oriented database program. The Sumo Logic app for MongoDB supports logs and metrics from the open source version of MongoDB. The App is tested on the 4.4.4 version of MongoDB. +[MongoDB](https://www.mongodb.com/why-use-mongodb#:~:text=MongoDB%20is%20a%20document%20database,development%20teams%20using%20agile%20methodologies.) is a source-available cross-platform document-oriented database program. The Sumo Logic app for MongoDB supports logs and metrics from the open source version of MongoDB. -MongoDB logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). +MongoDB logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). The OpenTelemetry collector runs on the same host as MongoDB and uses the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/mongodbreceiver) and the [Sumo Logic OpenTelemetry Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter) to send the metrics to Sumo Logic. Schematics -## Log types +## Log and metrics types -The MongoDB logs are generated in files as configured in the configuration file `/var/log/mongodb/mongodb.log`. For more details on MongoDB logs, see [this](https://docs.mongodb.com/manual/reference/log-messages/) link. +This app supports metrics and logs for MongoDB instance. The MongoDB logs are generated in files as configured in the configuration file `/var/log/mongodb/mongodb.log`. For more details on MongoDB logs, see [this](https://docs.mongodb.com/manual/reference/log-messages/) link. + +The app supports metrics generated by the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/MongoDBreceiver/documentation.md). ## Fields creation in Sumo Logic for MongoDB @@ -29,9 +31,16 @@ Following are the [Fields](/docs/manage/fields/) which will be created as part o - **`db.system`**. Has fixed value of **mongodb**. - **`deployment.environment`**. User configured. This is the deployment environment where the Mongodb cluster resides. For example: dev, prod or qa. - **`sumo.datasource`**. has a fixed value of **mongodb**. +* **`db.node.name`**. Has the value of host name of the machine which is being monitored. ## Prerequisites +### For metrics collection + +The MongoDB receiver fetches stats from a MongoDB instance using the [golang mongo driver](https://github.com/mongodb/mongo-go-driver). Stats are collected via MongoDB's `dbStats` and `serverStatus` commands. The MongoDB receiver extracts values from the result and converts them to OpenTelemetry metrics. + +### For logs collection + By default, MongoDB logs are stored in a log file. 1. Configure logging verbosity in MongoDB : MongoDB logs have six levels of verbosity. All logging settings are located in [MongoDB.conf](https://docs.mongodb.com/manual/reference/method/db.setLogLevel/). To select a level, set loglevel to one of: @@ -79,7 +88,18 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; ### Step 2: Configure integration -In this step the user needs to provide the path to the mongo db log file configured as part of above steps. Typically the logs are located at the location: `/var/log/mongodb/mongodb.log`. +OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collector/configuration/) yaml file with all the details concerning the data that needs to be collected. For example, it specifies the location of a log file that is read and sent to the Sumo Logic platform. + +In this step, you will configure the yaml file required for MongoDB collection. + +Below are the inputs required: + +- **`Endpoint (no default)`**. The hostname and port of the MognoDB instance, separated by a colon. (For example: `localhost:27017`.) +- **Logs Path**. Enter the path to the log file for your MognoDB instance. +- **username**. Enter the MognoDB username. +- **password**. Enter the MognoDB password. + +User needs to provide the path to the mongo db log file configured as part of above steps. Typically the logs are located at the location: `/var/log/mongodb/mongodb.log`. 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. @@ -257,24 +277,54 @@ Use this dashboard to: Query Logs +### Sharding + +The **MongoDB - Sharding** dashboard shows sharding related errors, events, failures and number of chunks moving between shards. + +Use this dashboard to: + +- Identify Sharding errors and warnings. +- Gain insights into Chunk operations. + +Sharding + ### Replication Logs -The **MongoDB - Replication Logs** dashboard shows replica deletes/updates/inserts trend and replica state. +The **MongoDB - Replication Logs** dashboard shows replication events, errors, warnings, and nodes. Use this dashboard to: -- Monitor replication state and replication events like inserts/updates/commands per second. -- Track Replication Oplog window to identify replication delay. +- Identify Replication errors and warnings. +- Gain insights into Replication operations. Replication Logs -### Sharding +### Resource -The **MongoDB - Sharding** dashboard dashboard shows sharding related errors, events, failures and number of chunks moving between shards. +The **MongoDB - Resource** dashboard shows resource utilization by the MongoDB component. Use this dashboard to: +* Determine Memory and Disk Usage. +* Identify potential resource constraints and issues. -- Identify Sharding errors and warnings. -- Gain insights into Chunk operations. +Resource -Sharding +### Operations + +The **MongoDB - Operations** dashboard shows MongoDB queries analytics using metrics. + +Use this dashboard to: +* Get to know different kind of operation count like Query,Insert & Delete etc. +* Determine Operation time taken by different queries. + +Operations + +### Replication + +The **MongoDB - Replication** dashboard shows replication events, errors, warnings, and nodes. + +Use this dashboard to: +* Get to know different kind of operation count getting executed on Replicas. +* Operation count like Query,Insert & Delete etc. + +Replication From 8874e2e1d4f5a8dfaa4e71049c1c1e2e483ae77e Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Wed, 11 Sep 2024 11:29:32 +0530 Subject: [PATCH 02/18] fixed it. --- .../databases/opentelemetry/mongodb-opentelemetry.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 83f53f9282..58a410fa84 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; Thumbnail iconThumbnail icon -[MongoDB](https://www.mongodb.com/why-use-mongodb#:~:text=MongoDB%20is%20a%20document%20database,development%20teams%20using%20agile%20methodologies.) is a source-available cross-platform document-oriented database program. The Sumo Logic app for MongoDB supports logs and metrics from the open source version of MongoDB. +[MongoDB](https://www.mongodb.com/why-use-mongodb#:~:text=MongoDB%20is%20a%20document%20database,development%20teams%20using%20agile%20methodologies.) is a source-available cross-platform document-oriented database program. The Sumo Logic app for MongoDB supports logs and metrics from the open source version of MongoDB.The App is tested on the 7.0.14 version of MongoDB. MongoDB logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). The OpenTelemetry collector runs on the same host as MongoDB and uses the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/mongodbreceiver) and the [Sumo Logic OpenTelemetry Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter) to send the metrics to Sumo Logic. @@ -95,9 +95,9 @@ In this step, you will configure the yaml file required for MongoDB collection. Below are the inputs required: - **`Endpoint (no default)`**. The hostname and port of the MognoDB instance, separated by a colon. (For example: `localhost:27017`.) -- **Logs Path**. Enter the path to the log file for your MognoDB instance. -- **username**. Enter the MognoDB username. -- **password**. Enter the MognoDB password. +- **`Logs Path`**. Enter the path to the log file for your MognoDB instance. +- **`username (optional)`**. Enter the MognoDB username. +- **`password (optional)`**. Enter the MognoDB password. User needs to provide the path to the mongo db log file configured as part of above steps. Typically the logs are located at the location: `/var/log/mongodb/mongodb.log`. @@ -290,7 +290,7 @@ Use this dashboard to: ### Replication Logs -The **MongoDB - Replication Logs** dashboard shows replication events, errors, warnings, and nodes. +The **MongoDB - Replication Logs** dashboard shows replica deletes/updates/inserts trend and replica state. Use this dashboard to: From 0c6e978967783f1d51f3c55c8447f524f50c6a37 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Wed, 11 Sep 2024 11:39:35 +0530 Subject: [PATCH 03/18] Update mongodb-opentelemetry.md --- .../databases/opentelemetry/mongodb-opentelemetry.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 58a410fa84..1b393203b4 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -46,7 +46,9 @@ By default, MongoDB logs are stored in a log file. 1. Configure logging verbosity in MongoDB : MongoDB logs have six levels of verbosity. All logging settings are located in [MongoDB.conf](https://docs.mongodb.com/manual/reference/method/db.setLogLevel/). To select a level, set loglevel to one of: - 0 is the MongoDB's default log verbosity level, to include [Informational](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-severity-levels) messages. - 1 to 5 increases the verbosity level to include[ Debug](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-severity-levels) messages. -2. Configure MongoDB to log to a Local file: Configuring MongoDB logs to go to log files. By default, MongoDB logs are stored in `/var/log/mongodb/mongodb.log`. The default directory for log files is listed in the MongoDB.conf file. To configure the log output destination to a log file, use one of the following settings, either in the [configuration file](https://docs.mongodb.com/manual/reference/configuration-options/) or command-line: +2. You need to set the [profiling_level](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/) to a value of 1. But default its set to 0. You can also configure value of [slowms](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/#std-label-set-profiling-level-options-slowms) to a value greater then or equal to 100. Thus can be done using the below command in mongosh: +`db.setProfilingLevel(1,100)` +3. Configure MongoDB to log to a Local file: Configuring MongoDB logs to go to log files. By default, MongoDB logs are stored in `/var/log/mongodb/mongodb.log`. The default directory for log files is listed in the MongoDB.conf file. To configure the log output destination to a log file, use one of the following settings, either in the [configuration file](https://docs.mongodb.com/manual/reference/configuration-options/) or command-line: - Configuration file: The [systemLog.destination](https://docs.mongodb.com/manual/reference/configuration-options/#mongodb-setting-systemLog.destination) option for file. - Command-line: - The [--logpath](https://docs.mongodb.com/manual/reference/program/mongod/#std-option-mongod.--logpath) option for [mongod](https://docs.mongodb.com/manual/reference/program/mongod/#mongodb-binary-bin.mongod) for file. From 455e133a31174bdea6a238519299ef0cf6404cc8 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Wed, 11 Sep 2024 12:15:05 +0530 Subject: [PATCH 04/18] fixed PR review comments --- .../databases/opentelemetry/mongodb-opentelemetry.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 1b393203b4..21473ef07c 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -97,14 +97,18 @@ In this step, you will configure the yaml file required for MongoDB collection. Below are the inputs required: - **`Endpoint (no default)`**. The hostname and port of the MognoDB instance, separated by a colon. (For example: `localhost:27017`.) -- **`Logs Path`**. Enter the path to the log file for your MognoDB instance. -- **`username (optional)`**. Enter the MognoDB username. -- **`password (optional)`**. Enter the MognoDB password. +- **`Logs Path`**. Provide the path to the mongo db log file configured as part of above steps. Typically the logs are located at the location: `/var/log/mongodb/mongodb.log`. +- **`username (optional)`**. If authentication is required, the user can with clusterMonitor permissions can be provided here. +- **`password (optional)`**. If authentication is required, the password can be provided here. User needs to provide the path to the mongo db log file configured as part of above steps. Typically the logs are located at the location: `/var/log/mongodb/mongodb.log`. 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. + +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 ### Step 3: Send logs to Sumo Logic From 0eda1b0d4cdf6dea139e5199073ad3a0b0a4e796 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Thu, 12 Sep 2024 11:33:14 +0530 Subject: [PATCH 05/18] Added Linux env download description --- .../opentelemetry/rabbitmq-opentelemetry.md | 6 +++++- .../databases/opentelemetry/mongodb-opentelemetry.md | 8 +++++--- .../databases/opentelemetry/redis-opentelemetry.md | 6 +++++- .../web-servers/opentelemetry/haproxy-opentelemetry.md | 6 +++++- 4 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md index 9e5152b4b1..3e9b590e12 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -129,7 +129,11 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the RabbitMQ instance which needs to be monitored. -2. Restart the collector using: +2. Place Env file in the following directory: + ```sh + /etc/otelcol-sumo/env/ + ``` +3. Restart the collector using: ```sh   sudo systemctl restart otelcol-sumo ``` diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 21473ef07c..bff8f7bba5 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -101,8 +101,6 @@ Below are the inputs required: - **`username (optional)`**. If authentication is required, the user can with clusterMonitor permissions can be provided here. - **`password (optional)`**. If authentication is required, the password can be provided here. -User needs to provide the path to the mongo db log file configured as part of above steps. Typically the logs are located at the location: `/var/log/mongodb/mongodb.log`. - 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. @@ -132,7 +130,11 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the Mongodb instance which needs to be monitored. -2. restart the collector using: +2. Place Env file in the following directory: + ```sh + /etc/otelcol-sumo/env/ + ``` +3. restart the collector using: ```sh  sudo systemctl restart otelcol-sumo ``` diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 7874cfefdc..487c62b50b 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -114,7 +114,11 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml at `/etc/otelcol-sumo/conf.d/` folder in the Redis instance that needs to be monitored. -2. Restart the otelcol-sumo process using: +2. Place Env file in the following directory: + ```sh + /etc/otelcol-sumo/env/ + ``` +3. Restart the otelcol-sumo process using: ```sh sudo systemctl restart otelcol-sumo ``` diff --git a/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md index 24c5df3504..56cda180fe 100644 --- a/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md @@ -134,7 +134,11 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the Haproxy instance which needs to be monitored. -2. Restart the collector using: +2. Place Env file in the following directory: + ```sh + /etc/otelcol-sumo/env/ + ``` +3. Restart the collector using: ```sh sudo systemctl restart otelcol-sumo ``` From 5fb3142e52818e524046b02ac6d33db80d1edbe8 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Thu, 12 Sep 2024 11:38:48 +0530 Subject: [PATCH 06/18] Update haproxy-opentelemetry.md --- .../web-servers/opentelemetry/haproxy-opentelemetry.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md b/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md index 56cda180fe..24c5df3504 100644 --- a/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md +++ b/docs/integrations/web-servers/opentelemetry/haproxy-opentelemetry.md @@ -134,11 +134,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the Haproxy instance which needs to be monitored. -2. Place Env file in the following directory: - ```sh - /etc/otelcol-sumo/env/ - ``` -3. Restart the collector using: +2. Restart the collector using: ```sh sudo systemctl restart otelcol-sumo ``` From 44c2bb33355c68c9080a58f566cdac465af0bcca Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Thu, 12 Sep 2024 11:42:59 +0530 Subject: [PATCH 07/18] Update redis-opentelemetry.md --- .../databases/opentelemetry/redis-opentelemetry.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 487c62b50b..6bb1583169 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -88,6 +88,10 @@ The log file path configured to capture redis logs must be given here. The files 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. + +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 :::note From 1907795fdcea8d8c106b4e1c8f2a1b7720ff729c Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 12 Sep 2024 14:35:41 +0530 Subject: [PATCH 08/18] Update 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 3e9b590e12..0ed4870aa5 100644 --- a/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md +++ b/docs/integrations/containers-orchestration/opentelemetry/rabbitmq-opentelemetry.md @@ -129,7 +129,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the RabbitMQ instance which needs to be monitored. -2. Place Env file in the following directory: +2. Move the `env` file to the following directory: ```sh /etc/otelcol-sumo/env/ ``` From 14f4ba10efbb20ca708e3136a45bdb68111caf70 Mon Sep 17 00:00:00 2001 From: YasarArafat Nasir Rogangar <163980163+yasar-sumologic@users.noreply.github.com> Date: Thu, 12 Sep 2024 15:59:05 +0530 Subject: [PATCH 09/18] Apply suggestions from code review Co-authored-by: Jagadisha V <129049263+JV0812@users.noreply.github.com> --- .../databases/opentelemetry/mongodb-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index bff8f7bba5..c55928ae23 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem'; Thumbnail iconThumbnail icon -[MongoDB](https://www.mongodb.com/why-use-mongodb#:~:text=MongoDB%20is%20a%20document%20database,development%20teams%20using%20agile%20methodologies.) is a source-available cross-platform document-oriented database program. The Sumo Logic app for MongoDB supports logs and metrics from the open source version of MongoDB.The App is tested on the 7.0.14 version of MongoDB. +[MongoDB](https://www.mongodb.com/why-use-mongodb#:~:text=MongoDB%20is%20a%20document%20database,development%20teams%20using%20agile%20methodologies.) is a source-available cross-platform document-oriented database program. The Sumo Logic app for MongoDB supports logs and metrics from the open source version of MongoDB. The app is tested on the 7.0.14 version of MongoDB. MongoDB logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). The OpenTelemetry collector runs on the same host as MongoDB and uses the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/mongodbreceiver) and the [Sumo Logic OpenTelemetry Exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/sumologicexporter) to send the metrics to Sumo Logic. From a05b2f5fbd2f5aee4e17c27b07bfaa562cd1bc01 Mon Sep 17 00:00:00 2001 From: YasarArafat Nasir Rogangar <163980163+yasar-sumologic@users.noreply.github.com> Date: Thu, 12 Sep 2024 17:03:54 +0530 Subject: [PATCH 10/18] Apply suggestions from code review Co-authored-by: Jagadisha V <129049263+JV0812@users.noreply.github.com> --- .../databases/opentelemetry/mongodb-opentelemetry.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index c55928ae23..ed962d8def 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -19,7 +19,7 @@ MongoDB logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](htt ## Log and metrics types -This app supports metrics and logs for MongoDB instance. The MongoDB logs are generated in files as configured in the configuration file `/var/log/mongodb/mongodb.log`. For more details on MongoDB logs, see [this](https://docs.mongodb.com/manual/reference/log-messages/) link. +This app supports logs and metrics for MongoDB instance. The MongoDB logs are generated in files as configured in this configuration file `/var/log/mongodb/mongodb.log`. For more details on MongoDB logs, refer to the [MongoDB documentation](https://docs.mongodb.com/manual/reference/log-messages/). The app supports metrics generated by the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/MongoDBreceiver/documentation.md). @@ -46,7 +46,7 @@ By default, MongoDB logs are stored in a log file. 1. Configure logging verbosity in MongoDB : MongoDB logs have six levels of verbosity. All logging settings are located in [MongoDB.conf](https://docs.mongodb.com/manual/reference/method/db.setLogLevel/). To select a level, set loglevel to one of: - 0 is the MongoDB's default log verbosity level, to include [Informational](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-severity-levels) messages. - 1 to 5 increases the verbosity level to include[ Debug](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-severity-levels) messages. -2. You need to set the [profiling_level](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/) to a value of 1. But default its set to 0. You can also configure value of [slowms](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/#std-label-set-profiling-level-options-slowms) to a value greater then or equal to 100. Thus can be done using the below command in mongosh: +2. You need to set the [profiling_level](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/) to a value of 1. But by default it is set to 0. You can also configure the value of [slowms](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/#std-label-set-profiling-level-options-slowms) to a value greater than or equal to 100. Thus can be done using the below command in mongosh: `db.setProfilingLevel(1,100)` 3. Configure MongoDB to log to a Local file: Configuring MongoDB logs to go to log files. By default, MongoDB logs are stored in `/var/log/mongodb/mongodb.log`. The default directory for log files is listed in the MongoDB.conf file. To configure the log output destination to a log file, use one of the following settings, either in the [configuration file](https://docs.mongodb.com/manual/reference/configuration-options/) or command-line: - Configuration file: The [systemLog.destination](https://docs.mongodb.com/manual/reference/configuration-options/#mongodb-setting-systemLog.destination) option for file. From 8efbfcc2fd68e69b5c06aa2ad62218563f2a64b3 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Thu, 12 Sep 2024 17:05:41 +0530 Subject: [PATCH 11/18] Update mongodb-opentelemetry.md --- .../databases/opentelemetry/mongodb-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index ed962d8def..eafb6e4a61 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -21,7 +21,7 @@ MongoDB logs are sent to Sumo Logic through OpenTelemetry [filelog receiver](htt This app supports logs and metrics for MongoDB instance. The MongoDB logs are generated in files as configured in this configuration file `/var/log/mongodb/mongodb.log`. For more details on MongoDB logs, refer to the [MongoDB documentation](https://docs.mongodb.com/manual/reference/log-messages/). -The app supports metrics generated by the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/MongoDBreceiver/documentation.md). +The app supports metrics generated by the [MongoDB Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/mongodbreceiver/documentation.md). ## Fields creation in Sumo Logic for MongoDB From 1830ef127e8002b21ae8fc5c50769e82044ef5b2 Mon Sep 17 00:00:00 2001 From: yasar-sumologic Date: Thu, 12 Sep 2024 17:44:51 +0530 Subject: [PATCH 12/18] fixed PR review comment --- .../opentelemetry/mongodb-opentelemetry.md | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index eafb6e4a61..47658e529b 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -189,7 +189,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; ## Sample log messages -```sql +```json {    "t":{        "$date":"2021-05-21T10:22:57.373+00:00" @@ -223,9 +223,7 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md'; ## Sample queries -Dashboard: MongoDB - Errors and Warnings, Panel: Errors by Component - -```sql +```sql title="Errors by Component( MongoDB - Errors and Warnings)" deployment.environment=* db.cluster.name=* sumo.datasource=mongodb  | json "log" as _rawlog nodrop | if (isEmpty(_rawlog), _raw, _rawlog) as _raw | json field=_raw "t.$date" as timestamp @@ -239,17 +237,19 @@ deployment.environment=* db.cluster.name=* sumo.datasource=mongodb  | json "log ## Viewing MongoDB dashboards -If no relevant data was received within the time range of the Panel, the Panel will be empty. +import ViewDashboards from '../../reuse/apps/view-dashboards.md'; + + ### Overview -The **MongoDB - Overview** dashboard provides an at-a-glance view of MongoDB health, performance and problems causing errors. +The **MongoDB - Overview** dashboard provides an at-a-glance view of MongoDB health, performance, and problems causing errors. Use this dashboard to: -- Identify Slow CRUD and DB commands. -- Gain insights into Errors logs by component and context. -- Number of up servers. +- Identify slow CRUD and DB commands. +- Gain insights into errors logs by component and context. +- To know the number of up servers. Overview @@ -280,19 +280,19 @@ The **MongoDB - Query Logs** dashboard shows read and write query trends. Use this dashboard to: -- Monitor abnormal spikes in Query volume. -- Identify the read versus write ratio of your application queries. Adjusting indexes to improve query performance. +- Monitor abnormal spikes in query volume. +- Identify read versus write ratio of your application queries. This helps you to adjust indexes to improve query performance. Query Logs ### Sharding -The **MongoDB - Sharding** dashboard shows sharding related errors, events, failures and number of chunks moving between shards. +The **MongoDB - Sharding** dashboard shows sharding related errors, events, failures, and number of chunks moving between shards. Use this dashboard to: -- Identify Sharding errors and warnings. -- Gain insights into Chunk operations. +- Identify sharding errors and warnings. +- Gain insights into chunk operations. Sharding @@ -302,8 +302,8 @@ The **MongoDB - Replication Logs** dashboard shows replica deletes/updates/inser Use this dashboard to: -- Identify Replication errors and warnings. -- Gain insights into Replication operations. +- Identify replication errors and warnings. +- Gain insights into replication operations. Replication Logs @@ -312,7 +312,7 @@ Use this dashboard to: The **MongoDB - Resource** dashboard shows resource utilization by the MongoDB component. Use this dashboard to: -* Determine Memory and Disk Usage. +* Determine memory and disk usage. * Identify potential resource constraints and issues. Resource @@ -322,17 +322,17 @@ Use this dashboard to: The **MongoDB - Operations** dashboard shows MongoDB queries analytics using metrics. Use this dashboard to: -* Get to know different kind of operation count like Query,Insert & Delete etc. -* Determine Operation time taken by different queries. +* Know different kind of operation count like query, insert, and delete. +* Determine the operation time taken by different queries. Operations ### Replication -The **MongoDB - Replication** dashboard shows replication events, errors, warnings, and nodes. +The **MongoDB - Replication** dashboard displays the replication events, errors, warnings, and nodes information. Use this dashboard to: -* Get to know different kind of operation count getting executed on Replicas. -* Operation count like Query,Insert & Delete etc. +* Know different kind of operation count executed on replicas. +* Operation count like query, insert, and delete. Replication From f876eb885040ea25b5a9ab41b7703134c9618788 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 12 Sep 2024 18:31:46 +0530 Subject: [PATCH 13/18] 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 6bb1583169..026d86ea4e 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -118,7 +118,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; 1. Copy the yaml at `/etc/otelcol-sumo/conf.d/` folder in the Redis instance that needs to be monitored. -2. Place Env file in the following directory: +2. Move the env file in the following directory: ```sh /etc/otelcol-sumo/env/ ``` From f03beb3c712a89f51832ad54265db8c98544f0da Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 12 Sep 2024 18:33:02 +0530 Subject: [PATCH 14/18] Update docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md --- .../databases/opentelemetry/mongodb-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 47658e529b..1c2fdd0c09 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -291,7 +291,7 @@ The **MongoDB - Sharding** dashboard shows sharding related errors, events, fail Use this dashboard to: -- Identify sharding errors and warnings. +- Identify sharding errors and warnings. - Gain insights into chunk operations. Sharding From e5385b71a2489731971b222344e95630ef52c0a0 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 12 Sep 2024 18:33:18 +0530 Subject: [PATCH 15/18] Update docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md --- .../databases/opentelemetry/mongodb-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 1c2fdd0c09..cdd2b3376d 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -292,7 +292,7 @@ The **MongoDB - Sharding** dashboard shows sharding related errors, events, fail Use this dashboard to: - Identify sharding errors and warnings. -- Gain insights into chunk operations. +- Gain insights into chunk operations. Sharding From b0f9c0397764380c0ce3377c6c37b908f74e8f11 Mon Sep 17 00:00:00 2001 From: Jagadisha V <129049263+JV0812@users.noreply.github.com> Date: Thu, 12 Sep 2024 18:34:20 +0530 Subject: [PATCH 16/18] Update mongodb-opentelemetry.md --- .../opentelemetry/mongodb-opentelemetry.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index cdd2b3376d..d572cc99e9 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -247,9 +247,9 @@ The **MongoDB - Overview** dashboard provides an at-a-glance view of MongoDB hea Use this dashboard to: -- Identify slow CRUD and DB commands. -- Gain insights into errors logs by component and context. -- To know the number of up servers. +- Identify slow CRUD and DB commands. +- Gain insights into errors logs by component and context. +- To know the number of up servers. Overview @@ -259,7 +259,7 @@ The **MongoDB - Errors and Warnings** dashboard shows errors and warnings by the Use this dashboard to: -- Determine components producing multiple errors or warnings. +- Determine components producing multiple errors or warnings. Access @@ -269,8 +269,8 @@ The **MongoDB - Logins and Connections** dashboard shows geo location of client Use this dashboard to: -- Determine potential hacking attempts. -- Determine location of attacks. +- Determine potential hacking attempts. +- Determine location of attacks. Logins and Connections @@ -280,8 +280,8 @@ The **MongoDB - Query Logs** dashboard shows read and write query trends. Use this dashboard to: -- Monitor abnormal spikes in query volume. -- Identify read versus write ratio of your application queries. This helps you to adjust indexes to improve query performance. +- Monitor abnormal spikes in query volume. +- Identify read versus write ratio of your application queries. This helps you to adjust indexes to improve query performance. Query Logs From d57b937d1d1813303ade552210ba3fe215ad9bb1 Mon Sep 17 00:00:00 2001 From: John Pipkin Date: Thu, 12 Sep 2024 10:27:21 -0500 Subject: [PATCH 17/18] Fix build break --- .../databases/opentelemetry/mongodb-opentelemetry.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index d572cc99e9..1898d5c689 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -237,7 +237,7 @@ deployment.environment=* db.cluster.name=* sumo.datasource=mongodb  | json "log ## Viewing MongoDB dashboards -import ViewDashboards from '../../reuse/apps/view-dashboards.md'; +import ViewDashboards from '../../../reuse/apps/view-dashboards.md'; From 0be17a7c2ce196db628e93cbf5781cc5cf95a599 Mon Sep 17 00:00:00 2001 From: John Pipkin Date: Thu, 12 Sep 2024 11:19:37 -0500 Subject: [PATCH 18/18] Updates for review --- .../opentelemetry/mongodb-opentelemetry.md | 28 ++++++++--------- .../opentelemetry/redis-opentelemetry.md | 30 +++++++++---------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md index 1898d5c689..4990045aef 100644 --- a/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/mongodb-opentelemetry.md @@ -43,16 +43,16 @@ The MongoDB receiver fetches stats from a MongoDB instance using the [golang mon By default, MongoDB logs are stored in a log file. -1. Configure logging verbosity in MongoDB : MongoDB logs have six levels of verbosity. All logging settings are located in [MongoDB.conf](https://docs.mongodb.com/manual/reference/method/db.setLogLevel/). To select a level, set loglevel to one of: +1. Configure logging verbosity in MongoDB.
MongoDB logs have six levels of verbosity. All logging settings are located in [MongoDB.conf](https://docs.mongodb.com/manual/reference/method/db.setLogLevel/). To select a level, set loglevel to one of: - 0 is the MongoDB's default log verbosity level, to include [Informational](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-severity-levels) messages. - 1 to 5 increases the verbosity level to include[ Debug](https://docs.mongodb.com/manual/reference/log-messages/#std-label-log-severity-levels) messages. -2. You need to set the [profiling_level](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/) to a value of 1. But by default it is set to 0. You can also configure the value of [slowms](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/#std-label-set-profiling-level-options-slowms) to a value greater than or equal to 100. Thus can be done using the below command in mongosh: +2. You need to set the [profiling_level](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/) to a value of 1.
But by default it is set to 0. You can also configure the value of [slowms](https://www.mongodb.com/docs/manual/reference/method/db.setProfilingLevel/#std-label-set-profiling-level-options-slowms) to a value greater than or equal to 100. Thus can be done using the below command in mongosh: `db.setProfilingLevel(1,100)` -3. Configure MongoDB to log to a Local file: Configuring MongoDB logs to go to log files. By default, MongoDB logs are stored in `/var/log/mongodb/mongodb.log`. The default directory for log files is listed in the MongoDB.conf file. To configure the log output destination to a log file, use one of the following settings, either in the [configuration file](https://docs.mongodb.com/manual/reference/configuration-options/) or command-line: +3. Configure MongoDB to log to a local file.
By default, MongoDB logs are stored in `/var/log/mongodb/mongodb.log`. The default directory for log files is listed in the `MongoDB.conf` file. To configure the log output destination to a log file, use one of the following settings, either in the [configuration file](https://docs.mongodb.com/manual/reference/configuration-options/) or command-line: - Configuration file: The [systemLog.destination](https://docs.mongodb.com/manual/reference/configuration-options/#mongodb-setting-systemLog.destination) option for file. - - Command-line: - - The [--logpath](https://docs.mongodb.com/manual/reference/program/mongod/#std-option-mongod.--logpath) option for [mongod](https://docs.mongodb.com/manual/reference/program/mongod/#mongodb-binary-bin.mongod) for file. - - The [--logpath](https://docs.mongodb.com/manual/reference/program/mongos/#std-option-mongos.--logpath) option for [mongos](https://docs.mongodb.com/manual/reference/program/mongos/#mongodb-binary-bin.mongos) for file. + - Command-line: + - The [--logpath](https://docs.mongodb.com/manual/reference/program/mongod/#std-option-mongod.--logpath) option for [mongod](https://docs.mongodb.com/manual/reference/program/mongod/#mongodb-binary-bin.mongod) for file. + - The [--logpath](https://docs.mongodb.com/manual/reference/program/mongos/#std-option-mongos.--logpath) option for [mongos](https://docs.mongodb.com/manual/reference/program/mongos/#mongodb-binary-bin.mongos) for file. import LogsCollectionPrereqisites from '../../../reuse/apps/logs-collection-prereqisites.md'; @@ -90,9 +90,9 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; ### Step 2: Configure integration -OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collector/configuration/) yaml file with all the details concerning the data that needs to be collected. For example, it specifies the location of a log file that is read and sent to the Sumo Logic platform. +OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collector/configuration/) YAML file with all the details concerning the data that needs to be collected. For example, it specifies the location of a log file that is read and sent to the Sumo Logic platform. -In this step, you will configure the yaml file required for MongoDB collection. +In this step, you will configure the YAML file required for MongoDB collection. Below are the inputs required: @@ -101,9 +101,9 @@ Below are the inputs required: - **`username (optional)`**. If authentication is required, the user can with clusterMonitor permissions can be provided here. - **`password (optional)`**. If authentication is required, the password can be provided here. -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. +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. +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. @@ -129,7 +129,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the Mongodb instance which needs to be monitored. +1. Copy the YAML file to `/etc/otelcol-sumo/conf.d/` folder in the Mongodb instance which needs to be monitored. 2. Place Env file in the following directory: ```sh /etc/otelcol-sumo/env/ @@ -142,7 +142,7 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the machine which needs to be monitored. +1. Copy the YAML file to `C:\ProgramData\Sumo Logic\OpenTelemetry Collector\config\conf.d` folder in the machine which needs to be monitored. 2. Restart the collector using:  ```sh Restart-Service -Name OtelcolSumo @@ -151,7 +151,7 @@ Restart-Service -Name OtelcolSumo -1. Copy the yaml file to `/etc/otelcol-sumo/conf.d/` folder in the Mongodb instance which needs to be monitored. +1. Copy the YAML file to `/etc/otelcol-sumo/conf.d/` folder in the Mongodb instance which needs to be monitored. 2. Restart the otelcol-sumo process using: ```sh  otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"  @@ -249,7 +249,7 @@ Use this dashboard to: - Identify slow CRUD and DB commands. - Gain insights into errors logs by component and context. -- To know the number of up servers. +- Know the number of up servers. Overview diff --git a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md index 026d86ea4e..84b7d5e6d5 100644 --- a/docs/integrations/databases/opentelemetry/redis-opentelemetry.md +++ b/docs/integrations/databases/opentelemetry/redis-opentelemetry.md @@ -75,9 +75,9 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md'; ### Step 2: Configure integration -OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collector/configuration/) yaml file with all the details concerning the data that needs to be collected. For example, it specifies the location of a log file that is read and sent to the Sumo Logic platform. +OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collector/configuration/) YAML file with all the details concerning the data that needs to be collected. For example, it specifies the location of a log file that is read and sent to the Sumo Logic platform. -In this step, you will configure the yaml file required for Redis Collection. +In this step, you will configure the YAML file required for Redis Collection. Below are the inputs required: @@ -86,9 +86,9 @@ Below are the inputs required: The log file path configured to capture redis logs must be given here. The files are typically located in `/var/log/redis/redis-server.log`. If you are using a customized path, check the [`redis.conf`](https://download.redis.io/redis-stable/redis.conf) file for this information. -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. +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. +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. @@ -117,24 +117,24 @@ import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md'; -1. Copy the yaml at `/etc/otelcol-sumo/conf.d/` folder in the Redis instance that needs to be monitored. +1. Copy the YAML at `/etc/otelcol-sumo/conf.d/` folder in the Redis instance that needs to be monitored. 2. Move the env file in the following directory: - ```sh - /etc/otelcol-sumo/env/ - ``` + ```sh + /etc/otelcol-sumo/env/ + ``` 3. Restart the otelcol-sumo process using: - ```sh - sudo systemctl restart otelcol-sumo - ``` + ```sh + sudo systemctl restart otelcol-sumo + ``` -1. Copy the yaml at `/etc/otelcol-sumo/conf.d/` folder in the Redis instance that needs to be monitored. +1. Copy the YAML at `/etc/otelcol-sumo/conf.d/` folder in the Redis instance that needs to be monitored. 2. Restart the otelcol-sumo process using: - ```sh - otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --conf "glob:/etc/otelcol-sumo/conf.d/*.yaml" - ``` + ```sh + otelcol-sumo --config /etc/otelcol-sumo/sumologic.yaml --conf "glob:/etc/otelcol-sumo/conf.d/*.yaml" + ```