feat(gateway): unsupported-engine telemetry beacon + Grafana counter
CI / changes (pull_request) Successful in 2s
CI / unit (pull_request) Successful in 10s
CI / integration (pull_request) Successful in 19s
CI / ui (pull_request) Successful in 1m5s
CI / conformance (pull_request) Successful in 9s
CI / gate (pull_request) Successful in 0s
CI / deploy (pull_request) Successful in 1m40s
CI / changes (pull_request) Successful in 2s
CI / unit (pull_request) Successful in 10s
CI / integration (pull_request) Successful in 19s
CI / ui (pull_request) Successful in 1m5s
CI / conformance (pull_request) Successful in 9s
CI / gate (pull_request) Successful in 0s
CI / deploy (pull_request) Successful in 1m40s
The index.html boot guard now fires a fire-and-forget beacon (POST /telemetry/unsupported)
when it turns a client away on the unsupported-engine screen, so the owner can see — on the
Users dashboard beside "app opens" — how many real clients hit it and on which engines.
- Client: navigator.sendBeacon (fetch fallback) with a localStorage dedup keyed by app version
+ reason + Chromium, so a user reopening the app is one report, not ten.
- Gateway: a new unauthenticated POST /telemetry/unsupported handler (the client never booted,
so it carries no session), per-IP public-limited and body-capped, mirroring the export-download
route. It folds the beacon into the OTel counter unsupported_engine_total {reason =
no_bigint/no_proxy/boot_error/other, chromium}, with reason allow-listed and the Chromium major
reduced to a bounded range (normalizeUnsupported) so a spoofed beacon cannot inflate the metric
cardinality; the full user agent is logged, not labelled.
- Caddy: /telemetry/* added to the @gateway matcher (else it falls to the landing catch-all).
- Grafana: two panels on the Scrabble — Users dashboard (by reason, by Chromium major).
- Docs: ARCHITECTURE.md §11.
Tests: recordUnsupportedEngine (metric split), normalizeUnsupported (cardinality bounding), and
the handler route end to end (204 / 405 / counter). go build+vet+test and gofmt clean; ui
check/build/e2e green; the client beacon + dedup verified against a forced hard-gate (BigInt
removed) — one POST, deduped on reopen, correct reason/chromium/version labels.
This commit is contained in:
@@ -128,3 +128,70 @@ func TestBannedMetric(t *testing.T) {
|
||||
t.Errorf("banned counts = %v, want tripwire=2 honeytoken=1", counts)
|
||||
}
|
||||
}
|
||||
|
||||
// TestUnsupportedEngineMetric records unsupported-engine beacons through a manual reader and asserts
|
||||
// unsupported_engine_total splits by reason and Chromium major.
|
||||
func TestUnsupportedEngineMetric(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
reader := sdkmetric.NewManualReader()
|
||||
meter := sdkmetric.NewMeterProvider(sdkmetric.WithReader(reader)).Meter("test")
|
||||
m := newServerMetrics(meter)
|
||||
|
||||
m.recordUnsupportedEngine(ctx, "no_bigint", "66")
|
||||
m.recordUnsupportedEngine(ctx, "no_bigint", "66")
|
||||
m.recordUnsupportedEngine(ctx, "boot_error", "74")
|
||||
|
||||
var rm metricdata.ResourceMetrics
|
||||
if err := reader.Collect(ctx, &rm); err != nil {
|
||||
t.Fatalf("collect: %v", err)
|
||||
}
|
||||
type key struct{ reason, chromium string }
|
||||
counts := map[key]int64{}
|
||||
for _, sm := range rm.ScopeMetrics {
|
||||
for _, md := range sm.Metrics {
|
||||
if md.Name != "unsupported_engine_total" {
|
||||
continue
|
||||
}
|
||||
sum, ok := md.Data.(metricdata.Sum[int64])
|
||||
if !ok {
|
||||
t.Fatalf("unsupported_engine_total is not an int64 sum")
|
||||
}
|
||||
for _, dp := range sum.DataPoints {
|
||||
reason, _ := dp.Attributes.Value(attribute.Key("reason"))
|
||||
chromium, _ := dp.Attributes.Value(attribute.Key("chromium"))
|
||||
counts[key{reason.AsString(), chromium.AsString()}] += dp.Value
|
||||
}
|
||||
}
|
||||
}
|
||||
if got := counts[key{"no_bigint", "66"}]; got != 2 {
|
||||
t.Errorf("unsupported no_bigint/66 = %d, want 2", got)
|
||||
}
|
||||
if got := counts[key{"boot_error", "74"}]; got != 1 {
|
||||
t.Errorf("unsupported boot_error/74 = %d, want 1", got)
|
||||
}
|
||||
}
|
||||
|
||||
// TestNormalizeUnsupported checks that a beacon's reason and Chromium are reduced to bounded label
|
||||
// values, so a spoofed beacon cannot explode the metric cardinality.
|
||||
func TestNormalizeUnsupported(t *testing.T) {
|
||||
cases := []struct {
|
||||
reason, chromium string
|
||||
wantReason, wantChromium string
|
||||
}{
|
||||
{"no_bigint", "66", "no_bigint", "66"},
|
||||
{"no_proxy", " 74 ", "no_proxy", "74"},
|
||||
{"boot_error", "105", "boot_error", "105"},
|
||||
{"garbage", "66", "other", "66"},
|
||||
{"", "", "other", "other"},
|
||||
{"no_bigint", "not-a-number", "no_bigint", "other"},
|
||||
{"no_bigint", "9999", "no_bigint", "other"},
|
||||
{"no_bigint", "0", "no_bigint", "other"},
|
||||
{"no_bigint", "-5", "no_bigint", "other"},
|
||||
}
|
||||
for _, c := range cases {
|
||||
gotR, gotC := normalizeUnsupported(c.reason, c.chromium)
|
||||
if gotR != c.wantReason || gotC != c.wantChromium {
|
||||
t.Errorf("normalizeUnsupported(%q,%q) = %q,%q; want %q,%q", c.reason, c.chromium, gotR, gotC, c.wantReason, c.wantChromium)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user