Redis (deprecated) π
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 π
After you configure the integration, you can access these features:
View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Splunk Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.
Installation π
Follow these steps to deploy this integration:
Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.
Configuration π
To use this integration of a Smart Agent monitor with the Collector:
Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.
See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.
Example π
To activate this integration, add the following to your Collector configuration:
receivers:
smartagent/redis:
type: collectd/redis
... # Additional config
Next, add the monitor to the service.pipelines.metrics.receivers
section of your configuration file:
service:
pipelines:
metrics:
receivers: [smartagent/redis]
Configuration settings π
The following table shows the configuration options for the Redis integration:
Option |
Required |
Type |
Description |
---|---|---|---|
|
Yes |
|
|
|
Yes |
|
|
|
No |
|
|
|
No |
|
|
|
No |
|
Authentication |
|
No |
|
|
|
No |
|
|
The following table shows you the configuration options for the
sendListLengths
configuration object:
Option |
Required |
Type |
Description |
---|---|---|---|
|
Yes |
|
The database index |
|
Yes |
|
|
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:
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:
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.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:
Notes π
To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure
extraMetrics
in Add additional metrics
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
Submit a case in the Splunk Support Portal .
Contact Splunk Support .
Available to prospective customers and free trial users
Ask a question and get answers through community support at Splunk Answers .
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups in the Get Started with Splunk Community manual.
Database Query Performance π
You can troubleshoot Redis command performance issues using Database Query Performance in Splunk APM.
For a sample scenario, see Scenario: Skyler investigates Redis performance issues using Database Query Performance
For more information on Database Query Performance support for Redis, see Redis