feat(admin): exclude admin traffic from usage statistics

Operator directive (progress ledger, 2026-08-21): admin requests must
not touch req/min-req/day statistics. handleAdminAPI no longer calls
checkAndCount for GET /admin/api/overview or GET /admin/api/usage (it
already skipped it for GET /admin/api/usage/history) - admin traffic
must never appear in usage statistics, which measure real LLM traffic
only. identify()'s group return is now discarded (u, _, ok :=), since
buildLimitScopes is no longer built here.

Direct consequence, documented in the new doc comment: an admin's own
requestsPerMinute/requestsPerDay limit, if configured, is no longer
enforced against admin-route traffic either - accepted trade-off
(admin-gated, cheap reads; a self-inflicted, not shared, resource
cost).

admin_test.go: TestAdmin_RateLimitApplies (asserted a 2nd request
429s) inverted to TestAdmin_NeverRateLimitedAndCountersUntouched - 5x
requests to both overview and usage against an admin key pinned at
RequestsPerMinute:1, asserting every one is 200 and the admin's own
req/min counter stays exactly 0.

integration/integration_test.go: TestAdmin_Dashboard's admin-user
assertion inverted from requestsPerDay > 0 ("admin API calls count
too") to requestsPerDay == 0 ("admin routes never call
checkAndCount") - the admin key is used throughout the whole suite
exclusively to hit /admin/api/*, so it must show exactly 0 despite
issuing many requests by the time this test runs.
This commit is contained in:
2026-08-21 09:24:35 +01:00
parent 7b28f34bb2
commit 9fced97050
3 changed files with 57 additions and 43 deletions
+17 -23
View File
@@ -100,21 +100,23 @@ func (g *Gateway) handleAdmin(sw *statusTrackingWriter, r *http.Request) {
// handleAdminAPI is the gate for the three /admin/api/* JSON routes, // handleAdminAPI is the gate for the three /admin/api/* JSON routes,
// applying spec §4's gate order: unauthenticated → 401, authenticated // applying spec §4's gate order: unauthenticated → 401, authenticated
// non-admin → 403, admin → serve. GET /admin/api/overview and GET // non-admin → 403, admin → serve.
// /admin/api/usage count request counters via checkAndCount before
// serving, like every other authenticated route: an admin over their own
// req/min limit gets a 429 here exactly as they would on any other route
// (spec §4's "Accounting: admin routes count request counters like any
// authed route").
// //
// GET /admin/api/usage/history (v0.2 data-layer task) is the one // None of the three routes call checkAndCount (operator directive:
// exception: it skips checkAndCount entirely. The operator-directed // progress ledger, 2026-08-20 — "admin requests must NOT touch req/min,
// removal of admin-route stat counting (progress ledger, 2026-08-20) // req/day statistics"): admin traffic must never appear in usage
// lands for every /admin/api/* route in a later task; this new route is // statistics, which exist to measure real LLM traffic only. GET
// built consistent with that direction from the start, rather than // /admin/api/usage/history was built this way from the start (v0.2
// counted now and un-counted later. // data-layer task); this change extends the same treatment to GET
// /admin/api/overview and GET /admin/api/usage, which previously counted
// like any other authenticated route (spec §4 amended accordingly). An
// admin's own req/min or req/day limit, if configured, is therefore never
// enforced against admin-route traffic either — the accepted trade-off
// the operator directive names: these are admin-gated, cheap reads, and
// an admin holder polling the dashboard aggressively is a self-inflicted,
// not a shared, resource cost.
func (g *Gateway) handleAdminAPI(sw *statusTrackingWriter, r *http.Request) { func (g *Gateway) handleAdminAPI(sw *statusTrackingWriter, r *http.Request) {
u, grp, ok := g.auth.identify(r) u, _, ok := g.auth.identify(r)
g.logAuthEvent(ok, authEventUserName(u), r) g.logAuthEvent(ok, authEventUserName(u), r)
if !ok { if !ok {
writeOAIError(sw, http.StatusUnauthorized, "authentication_error", "invalid or missing API key") writeOAIError(sw, http.StatusUnauthorized, "authentication_error", "invalid or missing API key")
@@ -125,21 +127,13 @@ func (g *Gateway) handleAdminAPI(sw *statusTrackingWriter, r *http.Request) {
return return
} }
if r.URL.Path == adminUsageHistoryPath {
g.serveAdminUsageHistory(sw, r)
return
}
if violation := g.limiter.checkAndCount(buildLimitScopes(u, grp)); violation != nil {
writeLimitViolation(sw, violation)
return
}
switch r.URL.Path { switch r.URL.Path {
case adminOverviewPath: case adminOverviewPath:
g.serveAdminOverview(sw) g.serveAdminOverview(sw)
case adminUsagePath: case adminUsagePath:
g.serveAdminUsage(sw) g.serveAdminUsage(sw)
case adminUsageHistoryPath:
g.serveAdminUsageHistory(sw, r)
} }
} }
+23 -13
View File
@@ -504,9 +504,19 @@ func TestLimiterCurrentUsage_StoreDown(t *testing.T) {
} }
} }
// --- rate limit applies to admin routes --- // --- admin routes never rate-limit and never move usage counters (operator directive, 2026-08-21) ---
func TestAdmin_RateLimitApplies(t *testing.T) { // TestAdmin_NeverRateLimitedAndCountersUntouched proves the operator
// directive (progress ledger, 2026-08-21 — "admin requests must NOT touch
// req/min-req/day statistics"): GET /admin/api/overview and GET
// /admin/api/usage never call checkAndCount, so an admin key with a
// requestsPerMinute limit tight enough to 429 on any other authenticated
// route never 429s here, no matter how many requests it makes — and its
// own req/min counter stays at exactly 0 throughout. This inverts the
// pre-directive TestAdmin_RateLimitApplies, which asserted the opposite
// (a 2nd request 429ing); it mirrors TestAdminUsageHistory_DoesNotCountStats,
// which already proved this for the third admin route from the start.
func TestAdmin_NeverRateLimitedAndCountersUntouched(t *testing.T) {
t.Parallel() t.Parallel()
cfg := newAdminTestConfig() cfg := newAdminTestConfig()
cfg.Users.Inline[1].Limits = &LimitsConfig{RequestsPerMinute: 1} // admin1 cfg.Users.Inline[1].Limits = &LimitsConfig{RequestsPerMinute: 1} // admin1
@@ -515,19 +525,19 @@ func TestAdmin_RateLimitApplies(t *testing.T) {
fixedNow := time.Date(2026, 8, 20, 9, 0, 0, 0, time.UTC) fixedNow := time.Date(2026, 8, 20, 9, 0, 0, 0, time.UTC)
gw.limiter.nowFn = func() time.Time { return fixedNow } gw.limiter.nowFn = func() time.Time { return fixedNow }
rec1 := httptest.NewRecorder() for _, p := range []string{adminOverviewPath, adminUsagePath} {
h.ServeHTTP(rec1, adminRequest(http.MethodGet, adminOverviewPath, "sk-admin1")) for i := 0; i < 5; i++ {
if rec1.Code != http.StatusOK { rec := httptest.NewRecorder()
t.Fatalf("1st request status = %d, want 200, body=%s", rec1.Code, rec1.Body.String()) h.ServeHTTP(rec, adminRequest(http.MethodGet, p, "sk-admin1"))
if rec.Code != http.StatusOK {
t.Fatalf("%s request %d: status = %d, want 200 (never 429), body=%s", p, i, rec.Code, rec.Body.String())
}
}
} }
rec2 := httptest.NewRecorder() reqCount, ok := gw.limiter.getCounter("user", "admin1", metricReq, windowMin, fixedNow)
h.ServeHTTP(rec2, adminRequest(http.MethodGet, adminOverviewPath, "sk-admin1")) if !ok || reqCount != 0 {
if rec2.Code != http.StatusTooManyRequests { t.Errorf("admin1 req/min counter = %d (ok=%v), want 0 (admin routes never call checkAndCount)", reqCount, ok)
t.Fatalf("2nd request status = %d, want 429 (admin over req/min limit)", rec2.Code)
}
if rec2.Header().Get("Retry-After") == "" {
t.Error("429 response must carry a Retry-After header")
} }
} }
+17 -7
View File
@@ -949,10 +949,13 @@ func TestAudioTranscriptions(t *testing.T) {
// TestAdminDashboard covers v0.2 integration coverage (spec §4): the // TestAdminDashboard covers v0.2 integration coverage (spec §4): the
// unauthenticated HTML shell carries no data, the two JSON routes gate // unauthenticated HTML shell carries no data, the two JSON routes gate
// on admin vs. non-admin vs. unauthenticated, and GET /admin/api/usage // on admin vs. non-admin vs. unauthenticated, and GET /admin/api/usage
// reflects the traffic this suite has generated by the time this test // reflects the REAL LLM traffic this suite has generated by the time this
// runs — deliberately placed near the end of the file (Go runs tests in // test runs — deliberately placed near the end of the file (Go runs
// source order with no -shuffle in this suite's Makefile target) so // tests in source order with no -shuffle in this suite's Makefile
// alice's own request counters are already non-zero. // target) so alice's own request counters are already non-zero. It also
// asserts the stats-exclusion directive's other half: the admin key
// itself, used throughout this suite only to call /admin/api/* routes,
// must show exactly 0 requestsPerDay — admin traffic is never counted.
func TestAdminDashboard(t *testing.T) { func TestAdminDashboard(t *testing.T) {
pageReq, err := http.NewRequest(http.MethodGet, traefik1URL+"/admin", nil) pageReq, err := http.NewRequest(http.MethodGet, traefik1URL+"/admin", nil)
if err != nil { if err != nil {
@@ -995,11 +998,18 @@ func TestAdminDashboard(t *testing.T) {
aliceUsage := adminUsageEntry(t, "users", "alice") aliceUsage := adminUsageEntry(t, "users", "alice")
if reqDay, _ := aliceUsage["requestsPerDay"].(float64); reqDay <= 0 { if reqDay, _ := aliceUsage["requestsPerDay"].(float64); reqDay <= 0 {
t.Errorf("alice requestsPerDay = %v, want > 0 (this suite's own earlier traffic)", reqDay) t.Errorf("alice requestsPerDay = %v, want > 0 (this suite's own earlier real-LLM traffic)", reqDay)
} }
// Stats-exclusion directive (progress ledger, 2026-08-21): admin routes
// never call checkAndCount, so the admin key — used throughout this
// suite ONLY to call /admin/api/* (adminUsageEntry/adminUsageHistory,
// plus this test's own overview/usage calls above) — must show exactly
// 0 requestsPerDay despite having issued many requests by this point in
// the run. This inverts the pre-directive assertion here, which
// expected admin's own admin-API calls to count like any other route.
adminUsage := adminUsageEntry(t, "users", "admin") adminUsage := adminUsageEntry(t, "users", "admin")
if reqDay, _ := adminUsage["requestsPerDay"].(float64); reqDay <= 0 { if reqDay, _ := adminUsage["requestsPerDay"].(float64); reqDay != 0 {
t.Errorf("admin requestsPerDay = %v, want > 0 (this test's own admin API calls count too)", reqDay) t.Errorf("admin requestsPerDay = %v, want 0 (admin routes never call checkAndCount)", reqDay)
} }
// v0.2 data-layer task: GET /admin/api/usage/history's hour series for // v0.2 data-layer task: GET /admin/api/usage/history's hour series for