Skip to content

Commit c9a2c9f

Browse files
committed
final, tested version of guide
1 parent 9434922 commit c9a2c9f

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

docs/use-cases/observability/clickstack/integration-examples/redis-metrics.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
slug: /use-cases/observability/clickstack/integrations/redis-metrics
33
title: 'Monitoring Redis metrics with ClickStack'
4-
sidebar_label: 'Redis Metrics'
4+
sidebar_label: 'Redis metrics'
55
pagination_prev: null
66
pagination_next: null
77
description: 'Monitoring Redis metrics with ClickStack'
@@ -97,11 +97,19 @@ receivers:
9797
redis.keys.expired:
9898
enabled: true
9999

100+
processors:
101+
resource:
102+
attributes:
103+
- key: service.name
104+
value: "redis"
105+
action: upsert
106+
100107
service:
101108
pipelines:
102109
metrics/redis:
103110
receivers: [redis]
104111
processors:
112+
- resource
105113
- memory_limiter
106114
- batch
107115
exporters:
@@ -112,6 +120,7 @@ This configuration:
112120
- Connects to Redis on `localhost:6379` (adjust endpoint for your setup)
113121
- Collects metrics every 10 seconds
114122
- Collects key performance metrics (commands, clients, memory, keyspace stats)
123+
- **Sets the required `service.name` resource attribute** per [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/resource/#service)
115124
- Routes metrics to the ClickHouse exporter via a dedicated pipeline
116125

117126
**Key metrics collected:**
@@ -128,10 +137,12 @@ This configuration:
128137
- `redis.connections.rejected` - Rejected connections
129138

130139
:::note
131-
- You only define new receivers and pipelines in the custom config
132-
- The processors (`memory_limiter`, `batch`) and exporters (`clickhouse`) are already defined in the base ClickStack configuration - you just reference them by name
133-
- For production deployments with authentication, store the password in an environment variable and reference it as `${env:REDIS_PASSWORD}`
134-
- Adjust `collection_interval` based on your monitoring needs (10s is a good default; lower values increase data volume)
140+
- You only define new receivers, processors, and pipelines in the custom config
141+
- The `memory_limiter` and `batch` processors and `clickhouse` exporter are already defined in the base ClickStack configuration - you just reference them by name
142+
- The `resource` processor sets the required `service.name` attribute per OpenTelemetry semantic conventions
143+
- For production with authentication, store the password in an environment variable: `${env:REDIS_PASSWORD}`
144+
- Adjust `collection_interval` based on your needs (10s default; lower values increase data volume)
145+
- For multiple Redis instances, customize `service.name` to distinguish them (e.g., `"redis-cache"`, `"redis-sessions"`)
135146
:::
136147

137148
#### Configure ClickStack to load custom configuration {#load-custom}
@@ -298,14 +309,6 @@ The dashboard will be created with all visualizations pre-configured:
298309

299310
<Image img={example_dashboard} alt="Redis metrics dashboard"/>
300311

301-
**The dashboard includes:**
302-
- **Commands processed per second** - Redis throughput
303-
- **Memory usage** - Current memory consumption and trends
304-
- **Connected clients** - Active client connections
305-
- **Cache performance** - Keyspace hits and misses
306-
- **Key evictions** - Memory pressure indicator
307-
- **Rejected connections** - Connection limit issues
308-
309312
:::note
310313
For the demo dataset, ensure the time range is set to 2025-10-20 05:00:00 - 2025-10-21 05:00:00.
311314
:::
@@ -399,4 +402,4 @@ If you want to explore further, here are some next steps to experiment with your
399402

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

0 commit comments

Comments
 (0)