Commit3c1d016

committed

Filter out unacceptable labels in AgentStats

Signed-off-by: Danny Kopping <danny@coder.com>

1 parent06f2f87 commit3c1d016Copy full SHA for 3c1d016

File tree

+22

-2

lines changed

+22

-2

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -262,7 +262,7 @@ func TestUpdateMetrics_MetricsExpire(t *testing.T) {`
`262`	`262`
`263`	`263`	`// given`
`264`	`264`	`registry:=prometheus.NewRegistry()`
`265`		`-metricsAggregator,err:=prometheusmetrics.NewMetricsAggregator(slogtest.Make(t,&slogtest.Options{IgnoreErrors:true}),registry,time.Millisecond,nil)`
	`265`	`+metricsAggregator,err:=prometheusmetrics.NewMetricsAggregator(slogtest.Make(t,&slogtest.Options{IgnoreErrors:true}),registry,time.Millisecond,agentmetrics.LabelAll)`
`266`	`266`	`require.NoError(t,err)`
`267`	`267`
`268`	`268`	`ctx,cancelFunc:=context.WithCancel(context.Background())`

Lines changed: 19 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -338,6 +338,8 @@ func AgentStats(ctx context.Context, logger slog.Logger, registerer prometheus.R`
`338`	`338`	`aggregateByLabels=agentmetrics.LabelAgentStats`
`339`	`339`	`}`
`340`	`340`
	`341`	`+aggregateByLabels=filterInvalidLabels(aggregateByLabels)`
	`342`	`+`
`341`	`343`	`metricsCollectorAgentStats:=prometheus.NewHistogram(prometheus.HistogramOpts{`
`342`	`344`	`Namespace:"coderd",`
`343`	`345`	`Subsystem:"prometheusmetrics",`
`@@ -514,3 +516,20 @@ func AgentStats(ctx context.Context, logger slog.Logger, registerer prometheus.R`
`514`	`516`	`<-done`
`515`	`517`	`},nil`
`516`	`518`	`}`
	`519`	`+`
	`520`	+// filterInvalidLabels handles a slightly messy situation whereby `prometheus-aggregate-agent-stats-by` can control on
	`521`	+// which labels agent stats are aggregated, but for these specific metrics in this file there is no `template` label value,
	`522`	`+// and therefore we have to exclude it from the list of acceptable labels.`
	`523`	`+funcfilterInvalidLabels(labels []string) []string {`
	`524`	`+varout []string`
	`525`	`+`
	`526`	`+for_,label:=rangelabels {`
	`527`	`+iflabel==agentmetrics.LabelTemplateName {`
	`528`	`+continue`
	`529`	`+}`
	`530`	`+`
	`531`	`+out=append(out,label)`
	`532`	`+}`
	`533`	`+`
	`534`	`+returnout`
	`535`	`+}`

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import (`
`5`	`5`	`"database/sql"`
`6`	`6`	`"encoding/json"`
`7`	`7`	`"fmt"`
	`8`	`+"github.com/coder/coder/v2/coderd/agentmetrics"`
`8`	`9`	`"os"`
`9`	`10`	`"reflect"`
`10`	`11`	`"sync/atomic"`
`@@ -451,7 +452,7 @@ func TestAgentStats(t *testing.T) {`
`451`	`452`	`// and it doesn't depend on the real time.`
`452`	`453`	`closeFunc,err:=prometheusmetrics.AgentStats(ctx,slogtest.Make(t,&slogtest.Options{`
`453`	`454`	`IgnoreErrors:true,`
`454`		`-}),registry,db,time.Now().Add(-time.Minute),time.Millisecond,nil)`
	`455`	`+}),registry,db,time.Now().Add(-time.Minute),time.Millisecond,agentmetrics.LabelAll)`
`455`	`456`	`require.NoError(t,err)`
`456`	`457`	`t.Cleanup(closeFunc)`
`457`	`458`

Comments

(0)