envoyproxy/envoy

Redis stats: extract Redis command as Prometheus label in metrics

Open

#25,540 opened on Feb 14, 2023

View on GitHub
 (4 comments) (1 reaction) (0 assignees)C++ (5,373 forks)batch import
area/redisarea/statshelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Title: Extract Redis Command as Prometheus Label in Metrics

Description: Currently, Redis Prometheus metrics are using the metric name to identify which Redis command is being measured. This makes it difficult to filter and aggregate metrics by command, which is a common use case for monitoring Redis performance.

Redis metrics could be improved by extracting the Redis command name as a Prometheus label (tag), as recommended by Prometheus best practices. This would allow users to easily filter and aggregate metrics by command.

For example, instead of the metric name envoy_redis_command_mset_total for the mset command, the metric could be labeled as envoy_redis_command_total{command="mset"}.

Thank you for considering this feature request.

Contributor guide

Research direction
Examine the existing Redis stats implementation in the Envoy codebase, specifically how metrics are registered and how Prometheus labels are applied. Modify the metric definitions to use a 'command' label instead of embedding the command name in the metric name. Ensure compatibility with existing monitoring systems and update any relevant documentation.
Tech stack
cpp
Domain
observability
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60