Files
coder/coderd/database/dbauthz/sessioncountparams.go
T
Ehab Younes 0aae890d03 feat: return per-app session counts from workspace agent stats queries (#29134)
- Make all six raw session-count queries return a session_counts JSONB
object keyed by app name instead of fixed per-family columns. Fold the
results into existing family fields in Go using the shared SDK registry,
including unrecognized names under unknown.
- Remove the registry parameters and associated dbauthz validation from
these queries, which no longer perform family attribution in SQL.
Preserve existing deployment stats, Prometheus, and telemetry outputs.
- Select session maps directly in the two latest-row queries instead of
decomposing and reaggregating a single row. Keep byte, connection, and
latency aggregates independent of per-app expansion.
- Add regressions for latest eligible rows, empty session maps, distinct
same-family app names, labels, and unchanged traffic aggregates.
2026-09-10 14:07:03 +02:00

77 lines
3.3 KiB
Go

package dbauthz
import (
"context"
"encoding/json"
"slices"
"golang.org/x/xerrors"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/coderd/rbac/policy"
"github.com/coder/coder/v2/codersdk"
)
// The template insights read query and the usage stats rollup take the app
// family attribution registry as a single jsonb parameter. Both hardcode one
// probe per family, so a registry that is empty, malformed, or keyed
// differently from codersdk.AttributedAppFamilies would still run and return
// zero counts for the affected families, silently dropping sessions from
// insights and Prometheus. dbauthz wraps every production store, including
// the transaction stores used by the rollup, so validating here makes a wrong
// registry fail the call loudly instead of failing the data quietly. These
// methods override the generated ones in dbauthz.go; scripts/dbgen preserves
// methods defined outside that file.
// validateSessionCountAppFamilies checks that the registry has exactly the
// families the queries probe, each with at least one app name.
func validateSessionCountAppFamilies(appFamilies json.RawMessage) error {
if len(appFamilies) == 0 {
return xerrors.New("developer error: session count app families must not be empty, populate them with codersdk.SessionCountAppFamiliesJSON()")
}
var families map[codersdk.AppFamilyName][]string
if err := json.Unmarshal(appFamilies, &families); err != nil {
return xerrors.Errorf("developer error: session count app families must be a JSON object of family to app names, populate them with codersdk.SessionCountAppFamiliesJSON(): %w", err)
}
required := codersdk.AttributedAppFamilies()
for _, family := range required {
appNames, ok := families[family]
if !ok {
return xerrors.Errorf("developer error: session count app families is missing family %q, which the queries probe; populate them with codersdk.SessionCountAppFamiliesJSON()", family)
}
if len(appNames) == 0 {
return xerrors.Errorf("developer error: session count app families has no app names for family %q, so its sessions would go uncounted", family)
}
}
for family := range families {
if !slices.Contains(required, family) {
return xerrors.Errorf("developer error: session count app families has family %q, which no query probes; add a probe per query or drop it from codersdk.AttributedAppFamilies", family)
}
}
return nil
}
func (q *querier) GetTemplateInsightsByTemplate(ctx context.Context, arg database.GetTemplateInsightsByTemplateParams) ([]database.GetTemplateInsightsByTemplateRow, error) {
// Only used by prometheus metrics collector. No need to check update template perms.
if err := q.authorizeContext(ctx, policy.ActionViewInsights, rbac.ResourceTemplate); err != nil {
return nil, err
}
if err := validateSessionCountAppFamilies(arg.AppFamilies); err != nil {
return nil, err
}
return q.db.GetTemplateInsightsByTemplate(ctx, arg)
}
func (q *querier) UpsertTemplateUsageStats(ctx context.Context, appFamilies json.RawMessage) error {
if err := q.authorizeContext(ctx, policy.ActionUpdate, rbac.ResourceSystem); err != nil {
return err
}
if err := validateSessionCountAppFamilies(appFamilies); err != nil {
return err
}
return q.db.UpsertTemplateUsageStats(ctx, appFamilies)
}