Redis metrics

The OpenTelemetry Collector provides an integration with Redis through a receiver in the contrib repo located at OpenTelemetry Collector Contrib. The Collector fetches metrics from the configured path in the Redis receiver. From there, the metrics are processed and exported to Cloud Observability.

To complete the integration, you will:

  • Configure the Redis receiver for the Collector
  • Enable the integration by adding it to a pipeline

Prerequisites

You’ve configured the Collector to export metric data to Cloud Observability.

Configure the Collector receiver

In the Collector configuration file, add Redis as a receiver and set the Redis endpoint.

1
2
3

receivers:
  redis:
    endpoint: redis:6379

The OpenTelemetry repo’s readme provides additional details about Redis configuration.

Enable the Collector receiver

Once the Redis receiver is configured, enable it by adding it to one or more pipelines as described in the Collector configuration documentation.

Validate metrics are reporting to Cloud Observability

You can validate that metrics are reporting to Cloud Observability on the Metrics details page in Settings.

  1. In Cloud Observability, click Settings > Metric details.

  2. Search for Redis metric names. Arrow points to the metrics search box.

    See the receiver’s metadata file for a complete list of emitted metrics.

  3. If needed, click on the metric to edit the description and how the units are displayed in Cloud Observability.

Create a dashboard for the metrics

You can create a pre-built dashboard for this integration from the Dashboard list view. Or use the Cloud Observability Terraform Provider to create a dashboard.

Additional resources

For a more complete example that’s ready to run, see the Redis integration in Cloud Observability OpenTelemetry Examples.

See also

Create and manage dashboards

Create alerts

Updated Dec 1, 2022