Skip to content

feat: expose template insights as Prometheus metrics #10325

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 21 commits into from
Oct 19, 2023
Merged

feat: expose template insights as Prometheus metrics #10325

Changes from 1 commit
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
24e4ff3
WIP
mtojek Oct 13, 2023
a6c9c1a
Use db
mtojek Oct 13, 2023
86f45a0
debug
mtojek Oct 13, 2023
bfcd8f4
Merge branch 'main' into 9983-insights-metrics
mtojek Oct 17, 2023
a3c29a7
DB calls
mtojek Oct 17, 2023
24ae332
WIP
mtojek Oct 17, 2023
0cb1206
WIP dbfake
mtojek Oct 18, 2023
3c31168
Merge branch 'main' into 9983-insights-metrics
mtojek Oct 18, 2023
a764cef
Collect metrics data
mtojek Oct 18, 2023
32f5245
Only template
mtojek Oct 18, 2023
0c81a7a
Fixes
mtojek Oct 18, 2023
432af16
fmt
mtojek Oct 18, 2023
5ebbfe9
fix: dbauthz
mtojek Oct 18, 2023
f4c1202
Unit test
mtojek Oct 18, 2023
62ad6a4
golden file
mtojek Oct 18, 2023
85dc078
Fix
mtojek Oct 18, 2023
2d03fed
Fix?
mtojek Oct 18, 2023
e41bfbc
t.cleanup to defer
mtojek Oct 18, 2023
cd8a809
ticker.stop
mtojek Oct 19, 2023
3dbb6eb
GROUP BY alias
mtojek Oct 19, 2023
c25c499
Preallocate
mtojek Oct 19, 2023
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
Prev Previous commit
Next Next commit
Only template
  • Loading branch information
@mtojek
mtojek committed Oct 18, 2023
commit 32f524581a2b7eb73d62d33f621899db8e040ed5
62 changes: 8 additions & 54 deletions coderd/prometheusmetrics/insights/metricscollector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ import (
)

var (
activeUsersDesc = prometheus.NewDesc("coderd_insights_active_users", "The number of active users of the template.", []string{"template_name"}, nil)
applicationsUsageSecondsDesc = prometheus.NewDesc("coderd_insights_applications_usage_seconds", "The application usage per template.", []string{"application_name", "template_name"}, nil)
parametersDesc = prometheus.NewDesc("coderd_insights_parameters", "The parameter usage per template.", []string{"template_name", "name", "value"}, nil)
activeUsersDesc = prometheus.NewDesc("coderd_insights_active_users", "The number of active users of the template.", []string{"template_name"}, nil)
)

type MetricsCollector struct {
Expand All @@ -30,9 +28,7 @@ type MetricsCollector struct {
}

type insightsData struct {
templates []database.GetTemplateInsightsByTemplateRow
apps []database.GetTemplateAppInsightsRow
parameters []database.GetTemplateParameterInsightsRow
templates []database.GetTemplateInsightsByTemplateRow

templateNames map[uuid.UUID]string
}
Expand Down Expand Up @@ -71,12 +67,11 @@ func (mc *MetricsCollector) Run(ctx context.Context) (func(), error) {
// TODO collect iteration time

var templateInsights []database.GetTemplateInsightsByTemplateRow
var appInsights []database.GetTemplateAppInsightsRow
var parameterInsights []database.GetTemplateParameterInsightsRow

// Phase I: Fetch insights from database
// Phase 1: Fetch insights from database
// FIXME errorGroup will be used to fetch insights for apps and parameters
eg, egCtx := errgroup.WithContext(ctx)
eg.SetLimit(3)
eg.SetLimit(1)

eg.Go(func() error {
var err error
Expand All @@ -89,36 +84,13 @@ func (mc *MetricsCollector) Run(ctx context.Context) (func(), error) {
}
return err
})
eg.Go(func() error {
var err error
appInsights, err = mc.database.GetTemplateAppInsights(ctx, database.GetTemplateAppInsightsParams{
StartTime: startTime,
EndTime: endTime,
})
if err != nil {
mc.logger.Error(ctx, "unable to fetch app insights from database", slog.Error(err))
}
return err
})
eg.Go(func() error {
var err error
parameterInsights, err = mc.database.GetTemplateParameterInsights(ctx, database.GetTemplateParameterInsightsParams{
StartTime: startTime,
EndTime: endTime,
})
if err != nil {
mc.logger.Error(ctx, "unable to fetch parameter insights from database", slog.Error(err))
}
return err
})

err := eg.Wait()
if err != nil {
return
}

// Phase 2: Collect template IDs, and fetch relevant details
templateIDs := uniqueTemplateIDs(templateInsights, appInsights, parameterInsights)
templateIDs := uniqueTemplateIDs(templateInsights)
templates, err := mc.database.GetTemplatesWithFilter(ctx, database.GetTemplatesWithFilterParams{
IDs: templateIDs,
})
Expand All @@ -130,9 +102,7 @@ func (mc *MetricsCollector) Run(ctx context.Context) (func(), error) {
templateNames := onlyTemplateNames(templates)

mc.data.Store(&insightsData{
templates: templateInsights,
apps: appInsights,
parameters: parameterInsights,
templates: templateInsights,

templateNames: templateNames,
})
Expand All @@ -158,8 +128,6 @@ func (mc *MetricsCollector) Run(ctx context.Context) (func(), error) {

func (*MetricsCollector) Describe(descCh chan<- *prometheus.Desc) {
descCh <- activeUsersDesc
descCh <- applicationsUsageSecondsDesc
descCh <- parametersDesc
}

func (mc *MetricsCollector) Collect(metricsCh chan<- prometheus.Metric) {
Expand All @@ -172,31 +140,17 @@ func (mc *MetricsCollector) Collect(metricsCh chan<- prometheus.Metric) {

for _, templateRow := range data.templates {
metricsCh <- prometheus.MustNewConstMetric(activeUsersDesc, prometheus.GaugeValue, float64(templateRow.ActiveUsers), data.templateNames[templateRow.TemplateID])

// TODO applicationsUsageSeconds, parameters
}
}

// Helper functions below.

func uniqueTemplateIDs(templateInsights []database.GetTemplateInsightsByTemplateRow, appInsights []database.GetTemplateAppInsightsRow, parameterInsights []database.GetTemplateParameterInsightsRow) []uuid.UUID {
func uniqueTemplateIDs(templateInsights []database.GetTemplateInsightsByTemplateRow) []uuid.UUID {
tids := map[uuid.UUID]bool{}
for _, t := range templateInsights {
tids[t.TemplateID] = true
}

for _, a := range appInsights {
for _, tid := range a.TemplateIDs {
tids[tid] = true
}
}

for _, p := range parameterInsights {
for _, tid := range p.TemplateIDs {
tids[tid] = true
}
}

uniqueUUIDs := make([]uuid.UUID, len(tids))
var i int
for t := range tids {
Expand Down