Skip to content

fix(redisotel): fix buggy append in reportPoolStats #3122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 5, 2025
+70 −11
Merged

fix(redisotel): fix buggy append in reportPoolStats #3122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
48b08da
fix(redisotel): fix buggy append in reportPoolStats
wzy9607 Mar 9, 2025
3251c0c
Merge branch 'master' into otel
ndyakov Aug 5, 2025
3c98196
Merge branch 'master' into otel
ndyakov Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions extra/redisotel/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,15 @@ func registerClient(rdb *redis.Client, conf *config, state *metricsState) error
return nil
}

func poolStatsAttrs(conf *config) (poolAttrs, idleAttrs, usedAttrs attribute.Set) {
poolAttrs = attribute.NewSet(conf.attrs...)
idleAttrs = attribute.NewSet(append(poolAttrs.ToSlice(), attribute.String("state", "idle"))...)
usedAttrs = attribute.NewSet(append(poolAttrs.ToSlice(), attribute.String("state", "used"))...)
return
}

func reportPoolStats(rdb *redis.Client, conf *config) (metric.Registration, error) {
labels := conf.attrs
idleAttrs := append(labels, attribute.String("state", "idle"))
usedAttrs := append(labels, attribute.String("state", "used"))
poolAttrs, idleAttrs, usedAttrs := poolStatsAttrs(conf)

idleMax, err := conf.meter.Int64ObservableUpDownCounter(
"db.client.connections.idle.max",
Expand Down Expand Up @@ -179,16 +184,16 @@ func reportPoolStats(rdb *redis.Client, conf *config) (metric.Registration, erro
func(ctx context.Context, o metric.Observer) error {
stats := rdb.PoolStats()

o.ObserveInt64(idleMax, int64(redisConf.MaxIdleConns), metric.WithAttributes(labels...))
o.ObserveInt64(idleMin, int64(redisConf.MinIdleConns), metric.WithAttributes(labels...))
o.ObserveInt64(connsMax, int64(redisConf.PoolSize), metric.WithAttributes(labels...))
o.ObserveInt64(idleMax, int64(redisConf.MaxIdleConns), metric.WithAttributeSet(poolAttrs))
o.ObserveInt64(idleMin, int64(redisConf.MinIdleConns), metric.WithAttributeSet(poolAttrs))
o.ObserveInt64(connsMax, int64(redisConf.PoolSize), metric.WithAttributeSet(poolAttrs))

o.ObserveInt64(usage, int64(stats.IdleConns), metric.WithAttributes(idleAttrs...))
o.ObserveInt64(usage, int64(stats.TotalConns-stats.IdleConns), metric.WithAttributes(usedAttrs...))
o.ObserveInt64(usage, int64(stats.IdleConns), metric.WithAttributeSet(idleAttrs))
o.ObserveInt64(usage, int64(stats.TotalConns-stats.IdleConns), metric.WithAttributeSet(usedAttrs))

o.ObserveInt64(timeouts, int64(stats.Timeouts), metric.WithAttributes(labels...))
o.ObserveInt64(hits, int64(stats.Hits), metric.WithAttributes(labels...))
o.ObserveInt64(misses, int64(stats.Misses), metric.WithAttributes(labels...))
o.ObserveInt64(timeouts, int64(stats.Timeouts), metric.WithAttributeSet(poolAttrs))
o.ObserveInt64(hits, int64(stats.Hits), metric.WithAttributeSet(poolAttrs))
o.ObserveInt64(misses, int64(stats.Misses), metric.WithAttributeSet(poolAttrs))
return nil
},
idleMax,
Expand Down
54 changes: 54 additions & 0 deletions extra/redisotel/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
package redisotel

import (
"reflect"
"testing"

"go.opentelemetry.io/otel/attribute"
)

func Test_poolStatsAttrs(t *testing.T) {
t.Parallel()
type args struct {
conf *config
}
tests := []struct {
name string
args args
wantPoolAttrs attribute.Set
wantIdleAttrs attribute.Set
wantUsedAttrs attribute.Set
}{
{
name: "#3122",
args: func() args {
conf := &config{
attrs: make([]attribute.KeyValue, 0, 4),
}
conf.attrs = append(conf.attrs, attribute.String("foo1", "bar1"), attribute.String("foo2", "bar2"))
conf.attrs = append(conf.attrs, attribute.String("pool.name", "pool1"))
return args{conf: conf}
}(),
wantPoolAttrs: attribute.NewSet(attribute.String("foo1", "bar1"), attribute.String("foo2", "bar2"),
attribute.String("pool.name", "pool1")),
wantIdleAttrs: attribute.NewSet(attribute.String("foo1", "bar1"), attribute.String("foo2", "bar2"),
attribute.String("pool.name", "pool1"), attribute.String("state", "idle")),
wantUsedAttrs: attribute.NewSet(attribute.String("foo1", "bar1"), attribute.String("foo2", "bar2"),
attribute.String("pool.name", "pool1"), attribute.String("state", "used")),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
gotPoolAttrs, gotIdleAttrs, gotUsedAttrs := poolStatsAttrs(tt.args.conf)
if !reflect.DeepEqual(gotPoolAttrs, tt.wantPoolAttrs) {
t.Errorf("poolStatsAttrs() gotPoolAttrs = %v, want %v", gotPoolAttrs, tt.wantPoolAttrs)
}
if !reflect.DeepEqual(gotIdleAttrs, tt.wantIdleAttrs) {
t.Errorf("poolStatsAttrs() gotIdleAttrs = %v, want %v", gotIdleAttrs, tt.wantIdleAttrs)
}
if !reflect.DeepEqual(gotUsedAttrs, tt.wantUsedAttrs) {
t.Errorf("poolStatsAttrs() gotUsedAttrs = %v, want %v", gotUsedAttrs, tt.wantUsedAttrs)
}
})
}
}
Loading