Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates - Redis and RabbitMQ - metrics collection capability #5088

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Changelog
description: Changelog for RabbitMQ source template for OpenTelemetry.
---

## [3.0.0] - 2025-02-25

### Added
- Metric collection through [RabbitMQ receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/rabbitmqreceiver).

:::note
Please follow [prerequisites](../#prerequisites) section before upgrading to this version for collecting metrics.
:::


## [2.1.1] - 2025-01-27

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

<img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="30"/><img src={useBaseUrl('/img/integrations/containers-orchestration/rabbitmq.png')} alt="Thumbnail icon" width="30"/>

The RabbitMQ source template creates an OpenTelemetry configuration that can be pushed to a remotely managed OpenTelemetry collector (abbreviated as otelcol). By creating this source template and pushing the config to the appropriate OpenTelemetry agent, you can collect your RabbitMQ logs to Sumo Logic.
The RabbitMQ source template creates an OpenTelemetry configuration that can be pushed to a remotely managed OpenTelemetry collector (abbreviated as otelcol). By creating this source template and pushing the config to the appropriate OpenTelemetry agent, you can collect your RabbitMQ logs and metrics to Sumo Logic.

## Fields created by the source template

Expand All @@ -24,6 +24,14 @@ When you create a source template, the following [fields](/docs/manage/fields/)

## Prerequisites

### For metrics collection

- Metrics collection is supported for RabbitMQ versions `3.8` and `3.9`.
- Metrics for RabbitMQ are collected through OpenTelemetry [RabbitMQ receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/rabbitmqreceiver).
- The RabbitMQ Management Plugin must be enabled by following the [official instructions](https://www.rabbitmq.com/management.html#getting-started).
- Also, a user with at least [monitoring](https://www.rabbitmq.com/management.html#permissions) level permissions must be used for monitoring.
- Make sure to set the RabbitMQ user's password as an environment variable for OpenTelemetry agent. Refer to the [Setting Environment Variables with Secret Values for Source Templates](../st-with-secrets.md).

### For logs collection
import LogsCollectionPrereqisites from '../../../../../reuse/apps/logs-collection-prereqisites.md';

Expand Down Expand Up @@ -52,6 +60,9 @@ In this step, you will configure the yaml required for Local File Collection. Be
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, sumo tags `_sourceCategory` with the value otel/rabbitmq.
- **File Path**. Provide the file which needs to be read by OpenTelemetry agent. You can provide path to multiple files by adding new entry to it.
- **DenyList**. Provide path expression describing the files to be excluded.
- **Endpoint**. (Default: `http://localhost:15672`.) The URL of the node to be monitored.
- **Username**. Required. Enter the RabbitMQ username.
- **Password Environment Variable Name**. Required. Enter the RabbitMQ password environment variable name.

import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ sidebar_label: Changelog
description: Changelog for Redis source template for OpenTelemetry.
---

## [3.0.0] - 2025-02-25

### Added
- Metric collection through [Redis receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/redisreceiver).

:::note
Please follow [prerequisites](../#prerequisites) section before upgrading to this version for collecting metrics.
:::


## [2.1.1] - 2025-01-27

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

<img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="30"/><img src={useBaseUrl('/img/integrations/databases/redis.png')} alt="Thumbnail icon" width="30"/>

The Redis source template creates an OpenTelemetry configuration that can be pushed to a remotely managed OpenTelemetry collector (abbreviated as otelcol). By creating this source template and pushing the config to the appropriate OpenTelemetry agent, you can collect your redis logs to Sumo Logic.
The Redis source template creates an OpenTelemetry configuration that can be pushed to a remotely managed OpenTelemetry collector (abbreviated as otelcol). By creating this source template and pushing the config to the appropriate OpenTelemetry agent, you can collect your redis logs and metrics to Sumo Logic.

## Fields created by the source template

Expand All @@ -24,6 +24,11 @@ When you create a source template, the following [fields](/docs/manage/fields/)

## Prerequisites

### For metrics collection
- Metrics for Redis are collected through OpenTelemetry [Redis receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/redisreceiver).
- Receiver uses the [INFO command](https://redis.io/docs/latest/commands/info/) to get Redis statistics.
- Make sure to set the Redis user's password as an environment variable for the OpenTelemetry agent. Refer to the [Setting Environment Variables with Secret Values for Source Templates](../st-with-secrets.md).

### For logs collection
import LogsCollectionPrereqisites from '../../../../../reuse/apps/logs-collection-prereqisites.md';

Expand All @@ -48,6 +53,10 @@ In this step, you will configure the yaml required for Local File Collection. Be
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, sumo tags `_sourceCategory` with the value otel/redis.
- **File Path**. Provide the file which needs to be read by OpenTelemetry agent. You can provide path to multiple files by adding new entry to it.
- **DenyList**. Provide path expression describing the files to be excluded.
- **Endpoint**. (Default: `localhost:6379`.) The hostname and port of the Redis instance,
separated by a colon.
- **Username** (Optional). Enter the Redis username in case you are using a specific user for monitoring.
- **Password Environment Variable Name** (Required). Enter the Redis password environment variable name.

import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';

Expand Down