Redis (deprecated)

Use this Splunk Observability Cloud integration for the Redis monitor. See benefits, install, configuration, and metrics

Note: The Redis monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won’t be able to use it to send data to Splunk Observability Cloud. To monitor your Redis databases, you can instead use the native OpenTelemetry Redis receiver. See Redis receiver to learn more.

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the redis monitor type to capture the following metrics:

  • Memory used

  • Commands processed per second

  • Number of connected clients and followers

  • Number of blocked clients

  • Number of keys stored per database

  • Uptime

  • Changes since last save

  • Replication delay per follower

It accepts endpoints and allows multiple instances.

This integration is available on Kubernetes and Linux, and supports Redis 2.8 and higher.

Benefits

インテグレーションを設定すると、これらの機能にアクセスできるようになります：

Installation

このインテグレーションを導入するには、以下の手順に従ってください：

  1. Splunk Distribution of OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします：

  2. 設定のセクションで説明するように、モニターを設定します。

  3. Splunk Distribution of OpenTelemetry Collector を再起動します。

Configuration

Smart Agent モニターとCollector のインテグレーションを使用するには、以下の手順に従います：

  1. Smart Agent レシーバーを設定ファイルに含めます。

  2. レシーバーセクションおよびパイプラインセクションの両方で、Collector 構成にモニタータイプを追加します。

Example

To activate this integration, add the following to your Collector configuration:

YAML 
receivers:
  smartagent/redis:
    type: collectd/redis
    ...  # Additional config

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

YAML 
service:
  pipelines:
    metrics:
      receivers: [smartagent/redis]

Configuration settings

The following table shows the configuration options for the Redis integration:

Option

Required

Type

Description

host

Yes

string

port

Yes

integer

pythonBinary

No

string

 Path to the Python binary. If you don’t provide a path, the

monitor uses its built-in runtime. The string can include arguments to the binary.

name

No

string

 Name for the Redis instance. The maximum length is 64

characters. The default value is "{host}:{port}".

auth

No

string

Authentication

sendListLengths

No

list of objects (see below)

 List of keys that you want to monitor for length. To learn more,

see the Monitor the length of Redis lists section.

verbose

No

bool

 Flag that controls verbose logging for the plugin. If true,

verbose logging is activated. The default value isfalse.

The following table shows you the configuration options for the sendListLengths configuration object:

Option

Required

Type

Description

databaseIndex

Yes

integer

The database index

keyPattern

Yes

string

 A string or pattern to use for selecting keys. A string selects

a single key. A pattern that uses * as a glob style wildcard processes all keys that match the pattern. Surround a pattern with single quotes (‘), for example 'mylist*'

Monitor the length of Redis lists

To monitor the length of list keys, you must specify the key and database index in the configuration using the following syntax:

YAML 
sendListLengths: [{databaseIndex: $db_index, keyPattern: "$key_name"}]

You can specify $key_name as a glob-style pattern. The only supported wildcard is * . When you use a pattern, the configuration processes all keys that match the pattern.

To ensure that the * is interpreted correctly, surround the pattern with double quotes (""). When a nonlist key matches the pattern, the Redis monitor writes an error to the agent logs.

in Splunk Observability Cloud, gauge.key_llen is the metric name for Redis list key lengths. Splunk Observability Cloud creates a separate MTS for each Redis list.

Notes:

  1. The Redis monitor uses the KEYS command to match patterns. Because this command isn’t optimized, you need to keep your match patterns small. Otherwise, the command can block other commands from executing.

  2. To avoid duplicate reporting, choose a single node in which to monitor list lengths. You can use the main node configuration or a follower node configuration.

Metrics

The following metrics are available for this integration:

https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/collectd/redis/metadata.yaml

Notes

  • Splunk Observability Cloud で利用可能なメトリクスタイプの詳細は、「メトリクスタイプ」を参照してください。

  • ホストベースのサブスクリプションプランでは、デフォルトのメトリクスは、ホスト、コンテナ、バンドルメトリクスなど、Splunk Observability Cloud のホストベースのサブスクリプションに含まれるメトリクスです。カスタムメトリクスはデフォルトでは提供されていないため、料金が発生する場合があります。詳細については、「メトリクスカテゴリ」を参照してください。

  • MTSベースのサブスクリプションプランでは、すべてのメトリクスがカスタムです。

  • メトリクスを追加するには、「その他のメトリクスの追加」で extraMetrics の設定方法を参照してください。

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Available to prospective customers and free trial users

  • Ask a question and get answers through community support at Splunk Answers.

  • Join the Splunk community #observability Slack channel to communicate with customers, partners, and Splunk employees worldwide.

Database Query Performance

You can troubleshoot Redis command performance issues using Database Query Performance in Splunk APM.