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

Show file tree
Hide file tree
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
Next Next commit
WIP
  • Loading branch information
@mtojek
mtojek committed Oct 13, 2023
commit 24e4ff388fd182124b63f25edf1cb68c04ed2287
13 changes: 13 additions & 0 deletions cli/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ import (
"github.com/coder/coder/v2/coderd/httpmw"
"github.com/coder/coder/v2/coderd/oauthpki"
"github.com/coder/coder/v2/coderd/prometheusmetrics"
"github.com/coder/coder/v2/coderd/prometheusmetrics/insights"
"github.com/coder/coder/v2/coderd/schedule"
"github.com/coder/coder/v2/coderd/telemetry"
"github.com/coder/coder/v2/coderd/tracing"
Expand Down Expand Up @@ -198,6 +199,18 @@ func enablePrometheus(
}
afterCtx(ctx, closeWorkspacesFunc)

insightsMetricsCollector := insights.NewMetricsCollector(options.Database, 0)
err = options.PrometheusRegistry.Register(insightsMetricsCollector)
if err != nil {
return nil, xerrors.Errorf("unable to register insights metrics collector: %w", err)
}

closeInsightsMetricsCollector, err := insightsMetricsCollector.Run(ctx)
if err != nil {
return nil, xerrors.Errorf("unable to run insights metrics collector: %w", err)
}
afterCtx(ctx, closeInsightsMetricsCollector)

if vals.Prometheus.CollectAgentStats {
closeAgentStatsFunc, err := prometheusmetrics.AgentStats(ctx, logger, options.PrometheusRegistry, options.Database, time.Now(), 0)
if err != nil {
Expand Down
72 changes: 72 additions & 0 deletions coderd/prometheusmetrics/insights/metricscollector.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
package insights

import (
"context"
"time"

"github.com/prometheus/client_golang/prometheus"

"github.com/coder/coder/v2/coderd/database"
)

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)
)

type MetricsCollector struct {
database database.Store
duration time.Duration
}

var _ prometheus.Collector = new(MetricsCollector)

func NewMetricsCollector(db database.Store, duration time.Duration) *MetricsCollector {
if duration == 0 {
duration = 5 * time.Minute
}

return &MetricsCollector{
database: db,
duration: duration,
}
}

func (mc *MetricsCollector) Run(ctx context.Context) (func(), error) {
ctx, closeFunc := context.WithCancel(ctx)
done := make(chan struct{})

// Use time.Nanosecond to force an initial tick. It will be reset to the
// correct duration after executing once.
ticker := time.NewTicker(time.Nanosecond)
doTick := func() {
defer ticker.Reset(mc.duration)
}

go func() {
defer close(done)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return
case <-ticker.C:
doTick()
}
}
}()
return func() {
closeFunc()
<-done
}, nil
}

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

func (mc *MetricsCollector) Collect(metricsCh chan<- prometheus.Metric) {
}