Monitoring Redis Metrics with ClickStack

Once configured, log into HyperDX and verify metrics are flowing:

1. Navigate to the Metrics explorer
2. Search for metrics starting with `redis.` (e.g., `redis.commands.processed`, `redis.memory.used`)
3. You should see metric data points appearing at your configured collection interval

## Demo dataset[​](#demo-dataset "Direct link to Demo dataset")

For users who want to test the Redis Metrics integration before configuring their production systems, we provide a pre-generated dataset with realistic Redis Metrics patterns.

Download the sample metrics dataset

#### Download the sample metrics dataset[​](#download-sample "Direct link to Download the sample metrics dataset")

Download the pre-generated metrics files (24 hours of Redis Metrics with realistic patterns):

```
# Download gauge metrics (memory, fragmentation ratio)
curl -O https://datasets-documentation.s3.eu-west-3.amazonaws.com/clickstack-integrations/redis/redis-metrics-gauge.csv

# Download sum metrics (commands, connections, keyspace stats)
curl -O https://datasets-documentation.s3.eu-west-3.amazonaws.com/clickstack-integrations/redis/redis-metrics-sum.csv
```

The dataset includes realistic patterns:

- **Cache warming event (06:00)** - Hit rate climbs from 30% to 80%
- **Traffic spike (14:30-14:45)** - 5x traffic surge with connection pressure
- **Memory pressure (20:00)** - Key evictions and cache performance degradation
- **Daily traffic patterns** - Business hours peaks, evening drops, random micro-spikes

Start ClickStack

#### Start ClickStack[​](#start-clickstack "Direct link to Start ClickStack")

Start a ClickStack instance:

```
docker run -d --name clickstack-demo \
  -p 8080:8080 -p 4317:4317 -p 4318:4318 \
  clickhouse/clickstack-all-in-one:latest
```

Wait approximately 30 seconds for ClickStack to fully start.

Load metrics into ClickStack

#### Load metrics into ClickStack[​](#load-metrics "Direct link to Load metrics into ClickStack")

Load the metrics directly into ClickHouse:

```
# Load gauge metrics (memory, fragmentation)
cat redis-metrics-gauge.csv | docker exec -i clickstack-demo \
  clickhouse-client --query "INSERT INTO otel_metrics_gauge FORMAT CSVWithNames"

# Load sum metrics (commands, connections, keyspace)
cat redis-metrics-sum.csv | docker exec -i clickstack-demo \
  clickhouse-client --query "INSERT INTO otel_metrics_sum FORMAT CSVWithNames"
```

Verify metrics in HyperDX

#### Verify metrics in HyperDX[​](#verify-metrics "Direct link to Verify metrics in HyperDX")

Once loaded, the quickest way to see your metrics is through the pre-built dashboard.

Proceed to the [Dashboards and visualization](#dashboards) section to import the dashboard and view all Redis Metrics at once.

Note

The demo dataset time range is 2025-10-20 00:00:00 to 2025-10-21 05:00:00. Make sure your time range in HyperDX matches this window.

Look for these interesting patterns:

- **06:00** - Cache warming (low hit rate climbing)
- **14:30-14:45** - Traffic spike (high client connections, some rejections)
- **20:00** - Memory pressure (key evictions begin)

## Dashboards and visualization[​](#dashboards "Direct link to Dashboards and visualization")

To help you get started monitoring Redis with ClickStack, we provide essential visualizations for Redis Metrics.

Download the dashboard configuration

#### [Download](/docs/examples/redis-metrics-dashboard.json) the dashboard configuration[​](#download "Direct link to download")

Import the pre-built dashboard

#### Import the pre-built dashboard[​](#import-dashboard "Direct link to Import the pre-built dashboard")

1. Open HyperDX and navigate to the Dashboards section
2. Click **Import Dashboard** in the upper right corner under the ellipses

3. Upload the `redis-metrics-dashboard.json` file and click **Finish Import**

View the dashboard

#### View the dashboard[​](#created-dashboard "Direct link to View the dashboard")

The dashboard will be created with all visualizations pre-configured:

Note

For the demo dataset, set the time range to **2025-10-20 05:00:00 - 2025-10-21 05:00:00 (UTC)** (adjust based on your local timezone). The imported dashboard won't have a time range specified by default.

## Troubleshooting[​](#troubleshooting "Direct link to Troubleshooting")

### Custom config not loading[​](#troubleshooting-not-loading "Direct link to Custom config not loading")

Verify the environment variable `CUSTOM_OTELCOL_CONFIG_FILE` is set correctly:

```
docker exec <container-name> printenv CUSTOM_OTELCOL_CONFIG_FILE
```

Check that the custom config file is mounted at `/etc/otelcol-contrib/custom.config.yaml`:

```
docker exec <container-name> ls -lh /etc/otelcol-contrib/custom.config.yaml
```

View the custom config content to verify it's readable:

```
docker exec <container-name> cat /etc/otelcol-contrib/custom.config.yaml
```

### No metrics appearing in HyperDX[​](#no-metrics "Direct link to No metrics appearing in HyperDX")

Verify Redis is accessible from the collector:

```
# From the ClickStack container
docker exec <clickstack-container> redis-cli -h <redis-host> ping
# Expected output: PONG
```

Check if the Redis INFO command works:

```
docker exec <clickstack-container> redis-cli -h <redis-host> INFO stats
# Should display Redis statistics
```

Verify the effective config includes your Redis receiver:

```
docker exec <container> cat /etc/otel/supervisor-data/effective.yaml | grep -A 10 "redis:"
```

Check for errors in the collector logs:

```
docker exec <container> cat /etc/otel/supervisor-data/agent.log | grep -i redis
# Look for connection errors or authentication failures
```

### Authentication errors[​](#auth-errors "Direct link to Authentication errors")

If you see authentication errors in the logs:

```
# Verify Redis requires authentication
redis-cli CONFIG GET requirepass

# Test authentication
redis-cli -a <password> ping

# Ensure password is set in ClickStack environment
docker exec <clickstack-container> printenv REDIS_PASSWORD
```

Update your configuration to use the password:

```
receivers:
  redis:
    endpoint: "redis:6379"
    password: ${env:REDIS_PASSWORD}
```

### Network connectivity issues[​](#network-issues "Direct link to Network connectivity issues")

If ClickStack can't reach Redis:

```
# Check if both containers are on the same network
docker network inspect <network-name>

# Test connectivity
docker exec <clickstack-container> ping redis
docker exec <clickstack-container> telnet redis 6379
```

Ensure your Docker Compose file or `docker run` commands place both containers on the same network.

## Next steps[​](#next-steps "Direct link to Next steps")

- Set up [alerts](/docs/use-cases/observability/clickstack/alerts) for critical metrics (memory usage thresholds, connection limits, cache hit rate drops)
- Create additional dashboards for specific use cases (replication lag, persistence performance)
- Monitor multiple Redis instances by duplicating the receiver configuration with different endpoints and service names

## Going to production[​](#going-to-production "Direct link to Going to production")

This guide extends ClickStack's built-in OpenTelemetry Collector for quick setup. For production deployments, we recommend running your own OTel Collector and sending data to ClickStack's OTLP endpoint. See [Sending OpenTelemetry data](/docs/use-cases/observability/clickstack/ingesting-data/opentelemetry) for production configuration.

- [Integration with existing Redis](#existing-redis)- [Demo dataset](#demo-dataset)- [Dashboards and visualization](#dashboards)- [Troubleshooting](#troubleshooting)
        - [Custom config not loading](#troubleshooting-not-loading)- [No metrics appearing in HyperDX](#no-metrics)- [Authentication errors](#auth-errors)- [Network connectivity issues](#network-issues)- [Next steps](#next-steps)- [Going to production](#going-to-production)

Was this page helpful?