Method collectBoundaryUsageSummary

coderd/telemetry/telemetry.go:918–965

collectBoundaryUsageSummary collects boundary usage statistics from all replicas and resets the stats for the next telemetry period. Returns nil if another replica has already collected for this period.

(ctx context.Context)

// replicas and resets the stats for the next telemetry period. Returns nil if
// another replica has already collected for this period.
func (r *remoteReporter) collectBoundaryUsageSummary(ctx context.Context) (*BoundaryUsageSummary, error) {
	// Use twice the snapshot frequency as the staleness limit to ensure we
	// capture data from replicas that may have slightly different flush times.
	maxStaleness := r.options.SnapshotFrequency * 2
	//nolint:gocritic // This is the actual collection of boundary usage tracking.
	boundaryCtx := dbauthz.AsBoundaryUsageTracker(ctx)

	// Claim the telemetry lock for this period. Use snapshot frequency so each
	// telemetry snapshot period gets exactly one collection.
	now := dbtime.Time(r.options.Clock.Now()).UTC()
	periodEndingAt := now.Truncate(r.options.SnapshotFrequency)
	err := r.options.Database.InsertTelemetryLock(ctx, database.InsertTelemetryLockParams{
		EventType:      "boundary_usage_summary",
		PeriodEndingAt: periodEndingAt,
	})
	if database.IsUniqueViolation(err, database.UniqueTelemetryLocksPkey) {
		r.options.Logger.Debug(ctx, "boundary usage telemetry lock already claimed by another replica, skipping", slog.F("period_ending_at", periodEndingAt))
		return nil, nil //nolint:nilnil // This is simple to handle when dealing with telemetry.
	}
	if err != nil {
		return nil, xerrors.Errorf("insert boundary usage telemetry lock (period_ending_at=%q): %w", periodEndingAt, err)
	}

	var summary database.GetAndResetBoundaryUsageSummaryRow
	err = r.options.Database.InTx(func(tx database.Store) error {
		// The advisory lock use here ensures a clean transition to the next snapshot by
		// preventing replicas from upserting row(s) at the same time as we aggregate and
		// delete all rows here.
		var txErr error
		if txErr = tx.AcquireLock(boundaryCtx, database.LockIDBoundaryUsageStats); txErr != nil {
			return txErr
		}
		summary, txErr = tx.GetAndResetBoundaryUsageSummary(boundaryCtx, maxStaleness.Milliseconds())
		return txErr
	}, nil)
	if err != nil {
		return nil, xerrors.Errorf("get and reset boundary usage summary: %w", err)
	}

	return &BoundaryUsageSummary{
		UniqueWorkspaces:           summary.UniqueWorkspaces,
		UniqueUsers:                summary.UniqueUsers,
		AllowedRequests:            summary.AllowedRequests,
		DeniedRequests:             summary.DeniedRequests,
		PeriodStart:                now.Add(-r.options.SnapshotFrequency),
		PeriodDurationMilliseconds: r.options.SnapshotFrequency.Milliseconds(),
	}, nil
}

// collectUserSecretsSummary returns a deployment-wide aggregate of user
// secrets configuration. Returns nil if another replica has already