Skip to content

feat(coderd): export metric indicating each experiment's status #12657

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 5 commits into from
Mar 19, 2024
Merged

feat(coderd): export metric indicating each experiment's status #12657

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
62c0551
Export metric indicating each experiment's status
dannykopping Mar 19, 2024
c93e4e2
Test metric name
dannykopping Mar 19, 2024
6f351d7
Ignore gocognit lint error for now
dannykopping Mar 19, 2024
50ccb7c
Apply suggestions from code review
dannykopping Mar 19, 2024
11abaa6
Review comments, expanding tests
dannykopping Mar 19, 2024
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
4 changes: 4 additions & 0 deletions cli/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -892,6 +892,10 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
return xerrors.Errorf("register agents prometheus metric: %w", err)
}
defer closeAgentsFunc()

if err = prometheusmetrics.Experiments(logger, options.PrometheusRegistry, options.DeploymentValues.Experiments.Value(), codersdk.ExperimentsAll); err != nil {
return xerrors.Errorf("register experiments metric: %w", err)
}
}

client := codersdk.New(localURL)
Expand Down
25 changes: 25 additions & 0 deletions coderd/prometheusmetrics/prometheusmetrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,31 @@ func AgentStats(ctx context.Context, logger slog.Logger, registerer prometheus.R
}, nil
}

// Experiments registers a metric which indicates whether each experiment is enabled or not.
func Experiments(_ slog.Logger, registerer prometheus.Registerer, exps []string, all codersdk.Experiments) error {
experimentsGauge := prometheus.NewGaugeVec(prometheus.GaugeOpts{
Namespace: "coderd",
Name: "experiments",
Help: "Indicates whether each experiment is enabled (1) or not (0)",
}, []string{"experiment"})
if err := registerer.Register(experimentsGauge); err != nil {
return err
}

for _, exp := range all {
var val float64
for _, enabled := range exps {
if string(exp) == enabled {
val = 1
}
}

experimentsGauge.WithLabelValues(string(exp)).Set(val)
}

return nil
}

// filterAcceptableAgentLabels handles a slightly messy situation whereby `prometheus-aggregate-agent-stats-by` can control on
// which labels agent stats are aggregated, but for these specific metrics in this file there is no `template` label value,
// and therefore we have to exclude it from the list of acceptable labels.
Expand Down
35 changes: 35 additions & 0 deletions coderd/prometheusmetrics/prometheusmetrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,41 @@ func TestAgentStats(t *testing.T) {
assert.EqualValues(t, golden, collected)
}

func TestExperimentsMetric(t *testing.T) {
t.Parallel()

log := slogtest.Make(t, nil).Leveled(slog.LevelDebug)
reg := prometheus.NewRegistry()

const (
a codersdk.Experiment = "a"
b codersdk.Experiment = "b"
c codersdk.Experiment = "c"
)
allExps := codersdk.Experiments{a, b, c}
require.NoError(t, prometheusmetrics.Experiments(log, reg, []string{string(b), string(c)}, allExps))

expectation := map[codersdk.Experiment]float64{
a: 0,
b: 1,
c: 1,
}

out, err := reg.Gather()
require.NoError(t, err)
require.Lenf(t, out, 1, "unexpected number of registered metrics")

for _, metric := range out[0].GetMetric() {
labels := metric.GetLabel()
require.Lenf(t, labels, 1, "unexpected number of labels")

experiment := labels[0].GetValue()
expected, found := expectation[codersdk.Experiment(experiment)]
require.Truef(t, found, "did not find experiment %q in expectations", experiment)
require.EqualValues(t, expected, metric.GetGauge().GetValue())
}
}

func prepareWorkspaceAndAgent(t *testing.T, client *codersdk.Client, user codersdk.CreateFirstUserResponse, workspaceNum int) *agentsdk.Client {
authToken := uuid.NewString()

Expand Down