Name log fields, metrics and the Core Rule Set package for what they are (closes #192)

Log field, metric, action and event names now say what they count
and, for timings, the unit. Package internal/waf is internal/coreruleset.

Model: opus-5-5

docs/request-log.md

@@ -159,7 +159,7 @@ Every one of these lines has:
 - `limit_hit`: the limit broken:
     - `minute`, `hour` or `day` for a rate limit;
     - `minute_bytes`, `hour_bytes` or `day_bytes` for a byte limit;
-    - `minute_refusals` for the error burst (`SWW_ERROR_BURST_THRESHOLD`).
+    - `minute_refusals`.
 
     When the bytes counted for a request and its response break a limit, the
     request has been passed on whole, so its `action` stays `forward`. Only its

internal/alerts/alerts.go

@@ -220,7 +220,7 @@ type State struct {
 // requests to it failed, and how many alerts were dropped from its full
 // queue or given up as it refused them.
 type Counts struct {
-	Sent, SendFailures, Dropped int64
+	Sent, Failed, Dropped int64
 }
 
 // Queue takes the alerts raised, holds back those it must, and sends the
@@ -264,7 +264,7 @@ type destination struct {
 	// waiting are the alerts waiting to be sent, oldest first.
 	waiting []*Alert
 
-	sent, sendFailures, dropped atomic.Int64
+	sent, failed, dropped atomic.Int64
 }
 
 // cooldownKey is what makes an alert a repeat of another: the same event
@@ -426,9 +426,7 @@ func (q *Queue) Counts(name string) Counts {
 	for _, d := range q.destinations {
 		if d.name == name {
 			return Counts{
-				Sent:         d.sent.Load(),
-				SendFailures: d.sendFailures.Load(),
-				Dropped:      d.dropped.Load(),
+				Sent: d.sent.Load(), Failed: d.failed.Load(), Dropped: d.dropped.Load(),
 			}
 		}
 	}
@@ -677,7 +675,7 @@ func (d *destination) run(ctx context.Context) {
 				retryAt = time.Time{}
 			case errors.Is(err, errRefused):
 				d.remove(alert)
-				d.sendFailures.Add(1)
+				d.failed.Add(1)
 				d.dropped.Add(1)
 
 				retryDelay = 0
@@ -686,7 +684,7 @@ func (d *destination) run(ctx context.Context) {
 				d.processLog.Warn("gave up an alert "+d.setting+" refused",
 					"event", alert.Event, "error", err.Error())
 			case ctx.Err() == nil: // not cut off as sww stops
-				d.sendFailures.Add(1)
+				d.failed.Add(1)
 
 				retryDelay = min(max(retryDelayFactor*retryDelay, firstRetryDelay),
 					maxRetryDelay)

internal/alerts/alerts_test.go

@@ -897,7 +897,7 @@ func TestDestinationThatDoesNotAnswerHoldsUpNeitherOther(t *testing.T) {
 		synctest.Wait()
 
 		wantDestinationCounts(t, q, alerts.DestinationSlack,
-			alerts.Counts{Sent: 3, SendFailures: 1})
+			alerts.Counts{Sent: 3, Failed: 1})
 
 		logged := log.String()
 		if !strings.Contains(logged,
@@ -934,7 +934,7 @@ func TestDropsAreCountedForEachDestination(t *testing.T) {
 		for destination, want := range map[string]alerts.Counts{
 			alerts.DestinationWebhook: {Sent: all},
 			alerts.DestinationSlack:   {Dropped: 1},
-			alerts.DestinationNtfy:    {SendFailures: all, Dropped: all},
+			alerts.DestinationNtfy:    {Failed: all, Dropped: all},
 		} {
 			wantDestinationCounts(t, q, destination, want)
 		}
@@ -1223,12 +1223,12 @@ func wantEvents(t *testing.T, webhook *standIn, want ...string) {
 // requests to it that it counts as failed, the alerts it counts as held
 // back, and those it counts as dropped for the webhook.
 func wantCounts(
-	t *testing.T, q *alerts.Queue, sent, sendFailures, suppressed, dropped int64,
+	t *testing.T, q *alerts.Queue, sent, failed, suppressed, dropped int64,
 ) {
 	t.Helper()
 
 	wantDestinationCounts(t, q, alerts.DestinationWebhook,
-		alerts.Counts{Sent: sent, SendFailures: sendFailures, Dropped: dropped})
+		alerts.Counts{Sent: sent, Failed: failed, Dropped: dropped})
 
 	if q.Suppressed() != suppressed {
 		t.Errorf("%d alerts held back, want %d", q.Suppressed(), suppressed)

internal/anomaly/anomaly.go

@@ -391,7 +391,7 @@ func alertFor(r Request, k key, o overThreshold) alerts.Alert {
 		detail["asn"] = k.asn
 	case ScopeTotal:
 		counted = "the whole service"
-	default: // watched_net
+	default: // watch
 		counted = "the named netblock " + k.name + ", " + k.netblock.String()
 		detail["name"] = k.name
 	}

internal/bans/admin_test.go

@@ -24,9 +24,9 @@ func TestBanWithoutACauseIsAnAdmins(t *testing.T) {
 func TestAdminsBansAreNeverDroppedAndDoNotCountTowardMaxBans(t *testing.T) {
 	t.Parallel()
 
-	params := defaultParams()
-	params.MaxBans = 1
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBans = 1
+	ledger := bans.New(rules)
 	adminsOnly := netip.MustParsePrefix("198.51.100.0/24")
 	both := netip.MustParsePrefix("203.0.113.1/32")
 	second := netip.MustParsePrefix("203.0.113.2/32")
@@ -64,9 +64,9 @@ func TestAdminsBansAreNeverDroppedAndDoNotCountTowardMaxBans(t *testing.T) {
 func TestEarlierBansCountABanDroppedAfterAnAdminsBan(t *testing.T) {
 	t.Parallel()
 
-	params := defaultParams()
-	params.MaxBans = 2
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBans = 2
+	ledger := bans.New(rules)
 	netblock := netip.MustParsePrefix("203.0.113.1/32")
 	other := netip.MustParsePrefix("203.0.113.2/32")
 

internal/bans/bans_test.go

@@ -80,9 +80,9 @@ func TestRepeatWindowRunsOut(t *testing.T) {
 func TestFirstBanLongerThanTheMaximumIsPermanent(t *testing.T) {
 	t.Parallel()
 
-	params := defaultParams()
-	params.LimitBanDuration = params.MaxBanDuration + time.Hour
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.LimitBanDuration = rules.MaxBanDuration + time.Hour
+	ledger := bans.New(rules)
 
 	ban, _ := ledger.BanForLimit(netip.MustParsePrefix("203.0.113.9/32"), midnight(),
 		bans.Notes{})
@@ -97,9 +97,9 @@ func TestLongestBanSetFarOffDoesNotOverflow(t *testing.T) {
 	// With bans of up to 100,000 days, the 14th ban in a row, of 3^13
 	// hours, is within the maximum, and three times as long would not fit
 	// in a time.Duration. The 15th is permanent.
-	params := defaultParams()
-	params.MaxBanDuration = 100000 * day
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBanDuration = 100000 * day
+	ledger := bans.New(rules)
 	netblock := netip.MustParsePrefix("203.0.113.9/32")
 	now := midnight()
 
@@ -200,9 +200,9 @@ func TestFindCountsNothing(t *testing.T) {
 func TestMaxBansDropsTheEarliestBanOfTheNetblockSeenLongestAgo(t *testing.T) {
 	t.Parallel()
 
-	params := defaultParams()
-	params.MaxBans = 3
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBans = 3
+	ledger := bans.New(rules)
 	a := netip.MustParsePrefix("203.0.113.1/32")
 	b := netip.MustParsePrefix("203.0.113.2/32")
 	c := netip.MustParsePrefix("203.0.113.3/32")
@@ -239,9 +239,9 @@ func TestFullLedgerDropsTheEarlierBanOfTheNetblockBannedAgain(t *testing.T) {
 
 	// With room for one ban, the netblock's ended ban goes to make room for
 	// its new one, whose notes still count it.
-	params := defaultParams()
-	params.MaxBans = 1
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBans = 1
+	ledger := bans.New(rules)
 	netblock := netip.MustParsePrefix("203.0.113.9/32")
 
 	first, _ := ledger.BanForLimit(netblock, midnight(), bans.Notes{})

internal/bans/snapshot_test.go

@@ -219,9 +219,9 @@ func TestLoadKeepsAtMostMaxBansDroppingTheEarliest(t *testing.T) {
 		Cause:    bans.CauseLimit,
 	}
 
-	params := defaultParams()
-	params.MaxBans = 1
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBans = 1
+	ledger := bans.New(rules)
 	ledger.Load([]bans.Ban{later, earlier})
 
 	held := ledger.Snapshot()
@@ -235,9 +235,9 @@ func TestLoadReplacesTheBansHeld(t *testing.T) {
 
 	// Room for three bans, so that the second load, were it added to the
 	// two bans held, would drop none of them to make room.
-	params := defaultParams()
-	params.MaxBans = 3
-	ledger := bans.New(params)
+	rules := defaultParams()
+	rules.MaxBans = 3
+	ledger := bans.New(rules)
 	kept := bans.Ban{
 		Netblock: netip.MustParsePrefix("2001:db8::/64"),
 		Start:    midnight(),

internal/coreruleset/coreruleset.go

@@ -284,7 +284,7 @@ func checkExclusions(exclusions string) error {
 // CoreRuleSet is the Core Rule Set, ready to inspect requests. It is safe
 // for concurrent use.
 type CoreRuleSet struct {
-	engine    coraza.WAF
+	waf       coraza.WAF
 	bodyLimit int64
 }
 
@@ -327,14 +327,14 @@ func New(params Params) (*CoreRuleSet, error) {
 		text += "SecRuleRemoveById " + strings.Join(ids, " ") + "\n"
 	}
 
-	engine, err := coraza.NewWAF(coraza.NewWAFConfig().
+	waf, err := coraza.NewWAF(coraza.NewWAFConfig().
 		WithRootFS(coreruleset.FS).
 		WithDirectives(text))
 	if err != nil {
 		return nil, fmt.Errorf("load the Core Rule Set: %w", err)
 	}
 
-	return &CoreRuleSet{engine: engine, bodyLimit: params.BodyLimit}, nil
+	return &CoreRuleSet{waf: waf, bodyLimit: params.BodyLimit}, nil
 }
 
 // Result is what the Core Rule Set found in a request.
@@ -354,7 +354,7 @@ type Result struct {
 func (c *CoreRuleSet) Inspect(
 	r *http.Request, client netip.Addr, body io.Reader,
 ) (Result, []byte, error) {
-	tx := c.engine.NewTransaction()
+	tx := c.waf.NewTransaction()
 	// Closing would remove the files Coraza wrote, and it writes none.
 	defer func() { _ = tx.Close() }()
 

internal/discriminator/admin_test.go

@@ -40,7 +40,7 @@ func TestAdminEndpointsAreOffWhileTheTokenIsUnset(t *testing.T) {
 	// An empty token does not match the unset one either.
 	for _, authorization := range []string{adminBearer, bearer, "Bearer ", ""} {
 		for _, e := range adminEndpoints() {
-			s.ownEndpointRequest(authorization, e.method, e.path, e.body, http.StatusNotFound)
+			s.adminRequest(authorization, e.method, e.path, e.body, http.StatusNotFound)
 		}
 	}
 
@@ -67,7 +67,7 @@ func TestAdminEndpointsNeedTheAdminToken(t *testing.T) {
 		for _, authorization := range []string{
 			"", bearer, "Bearer " + strings.ToUpper(adminSecret), "Basic " + adminSecret,
 		} {
-			got := s.ownEndpointRequest(authorization, e.method, e.path, e.body,
+			got := s.adminRequest(authorization, e.method, e.path, e.body,
 				http.StatusUnauthorized)
 			if got.header.Get("WWW-Authenticate") != "Bearer" {
 				t.Errorf("%s %s with %q was answered without WWW-Authenticate: Bearer",
@@ -329,7 +329,7 @@ func TestAdminEndpointsNeedTheTokenInObserveMode(t *testing.T) {
 	})
 
 	for _, e := range adminEndpoints() {
-		s.ownEndpointRequest("", e.method, e.path, e.body, http.StatusUnauthorized)
+		s.adminRequest("", e.method, e.path, e.body, http.StatusUnauthorized)
 	}
 
 	if held := server.Ledger.Snapshot(); len(held) != 0 {
@@ -360,12 +360,12 @@ func adminEndpoints() []adminEndpoint {
 func (s *sender) admin(method, path, body string, status int) answer {
 	s.t.Helper()
 
-	return s.ownEndpointRequest(adminBearer, method, path, body, status)
+	return s.adminRequest(adminBearer, method, path, body, status)
 }
 
-// ownEndpointRequest is admin with authorization as the request's Authorization
-// header unless it is "".
-func (s *sender) ownEndpointRequest(
+// adminRequest is admin with authorization as the request's Authorization header
+// unless it is "".
+func (s *sender) adminRequest(
 	authorization, method, path, body string, status int,
 ) answer {
 	s.t.Helper()

internal/discriminator/answertime_test.go

@@ -36,8 +36,8 @@ const (
 	// tooLarge is how discriminator refuses a request over the header limits.
 	tooLarge = http.StatusRequestHeaderFieldsTooLarge
 	// silentAbuseIPDBURL is where AbuseIPDB never answers: at the stand-in
-	// that silentGeoJSURL names too.
-	silentAbuseIPDBURL = "silent://abuseipdb/api/v2/check"
+	// that unansweredGeoJSURL names too.
+	silentAbuseIPDBURL = "unanswered://abuseipdb/api/v2/check"
 	// wholeLimit is the percentage of a rate limit that lowers it not at all.
 	wholeLimit = 100
 	// clientsDecision is the CrowdSec decision list holding client alone.
@@ -340,7 +340,7 @@ func newDiscriminatorInBubble(
 	settings := map[string]string{tagDeny: "country=KP"}
 	maps.Copy(settings, env)
 
-	server, out, _ := newDiscriminator(t, silentGeoJSURL, time.Now, settings)
+	server, out, _ := newDiscriminator(t, unansweredGeoJSURL, time.Now, settings)
 
 	return server, out
 }

internal/discriminator/bans.go

@@ -134,9 +134,9 @@ func (rq *request) banForLimit(now time.Time, hit ratelimit.Hit, status int) {
 
 	switch hit.Kind {
 	case ratelimit.KindRequests:
-		notes.LimitPercent, notes.LimitPercentSetting = rq.rateLimitPercent.logged()
+		notes.LimitPercent, notes.LimitPercentSetting = rq.limitPercent.logged()
 	case ratelimit.KindBytes:
-		notes.LimitPercent, notes.LimitPercentSetting = rq.bytesLimitPercent.logged()
+		notes.LimitPercent, notes.LimitPercentSetting = rq.bytesPercent.logged()
 	}
 
 	if rq.h.config.Observe {

internal/discriminator/bans_test.go

@@ -415,7 +415,7 @@ func startWithClock(
 
 // sender sends requests to rproxy one after another, each on a connection of its
 // own, and checks each one's answer and log line. discriminatorAddr is where
-// discriminator's own endpoints are, which ownEndpointRequest asks. Every request
+// discriminator's own endpoints are, which adminRequest asks. Every request
 // discriminator gets must come through the sender, since the log lines are
 // matched to them in order.
 type sender struct {

internal/discriminator/biased_test.go

@@ -143,9 +143,9 @@ func TestBytesPercentSettingsTakeThePlaceOfTheOthersForByteLimits(t *testing.T)
 	for _, tc := range []struct {
 		name string
 		env  map[string]string
-		// rateLimitPercent and bytesLimitPercent are the log line's, as
-		// percentText gives them, and limitHit is its limit_hit.
-		rateLimitPercent, bytesLimitPercent, limitHit string
+		// limitPercent and bytesPercent are the log line's, as percentText
+		// gives them, and limitHit is its limit_hit.
+		limitPercent, bytesPercent, limitHit string
 	}{
 		{
 			"lowering the byte limits alone",
@@ -183,10 +183,10 @@ func TestBytesPercentSettingsTakeThePlaceOfTheOthersForByteLimits(t *testing.T)
 
 			wantPercent(t, "rate_limit_percent",
 				line.RateLimitPercent, line.RateLimitPercentSetting,
-				tc.rateLimitPercent)
+				tc.limitPercent)
 			wantPercent(t, "bytes_limit_percent",
 				line.BytesLimitPercent, line.BytesLimitPercentSetting,
-				tc.bytesLimitPercent)
+				tc.bytesPercent)
 		})
 	}
 }
@@ -291,7 +291,7 @@ func TestClientWithoutAnAnswerInTimeHasTheUnknownLimitPercent(t *testing.T) {
 	// In a synctest bubble, as TestRequestWaitsAsLongAsTheLookupTimeoutSays
 	// says, with a GeoJS that never answers.
 	synctest.Test(t, func(t *testing.T) {
-		server, out, _ := newDiscriminator(t, silentGeoJSURL, time.Now,
+		server, out, _ := newDiscriminator(t, unansweredGeoJSURL, time.Now,
 			map[string]string{unknownLimitPercent: "0"})
 
 		// Once the time the request waits for its answer is up, the client
@@ -335,7 +335,7 @@ func TestRequestWaitsForItsLookupWhileABiasedThresholdIsSet(t *testing.T) {
 			// In a synctest bubble, as TestRequestWaitsAsLongAsTheLookupTimeoutSays
 			// says, with a GeoJS that never answers.
 			synctest.Test(t, func(t *testing.T) {
-				server, out, _ := newDiscriminator(t, silentGeoJSURL, time.Now,
+				server, out, _ := newDiscriminator(t, unansweredGeoJSURL, time.Now,
 					map[string]string{
 						lookupTimeout: timeout.String(), tagLists: "vpn=" + vpnList, tc.setting: tc.value,
 					})

internal/discriminator/bytelimits.go

@@ -26,7 +26,7 @@ func (byteLimits) check(_ context.Context, rq *request, now time.Time) *verdict
 	}
 
 	counts, hit, over := rq.h.limiter.CountBytes(rq.h.clientGroup(rq.client), now,
-		rq.countedBytes(), rq.bytesLimitPercent.percent)
+		rq.countedBytes(), rq.bytesPercent.percent)
 	rq.line.Counts.MinuteBytes = counts.MinuteBytes
 	rq.line.Counts.HourBytes = counts.HourBytes
 	rq.line.Counts.DayBytes = counts.DayBytes

internal/discriminator/discriminator.go

@@ -183,7 +183,7 @@ func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
 	rq.line.DiscriminatorLine = requestlog.DiscriminatorLineDecision
 	refused := rq.check(r.Context())
 	rq.checked = time.Now()
-	underOwnPrefix := strings.HasPrefix(r.URL.Path, ownEndpointPrefix)
+	underOwnPrefix := strings.HasPrefix(r.URL.Path, adminPrefix)
 
 	if refused == nil && !underOwnPrefix {
 		// In observe mode, what enforce mode would have refused counts here.

internal/discriminator/health_test.go

@@ -21,8 +21,7 @@ func TestHealthEndpointCountsTowardNoLimit(t *testing.T) {
 	)
 
 	for range healthChecks {
-		got := s.ownEndpointRequest("", http.MethodGet, discriminator.HealthPath, "",
-			http.StatusOK)
+		got := s.adminRequest("", http.MethodGet, discriminator.HealthPath, "", http.StatusOK)
 
 		if string(got.body) != "ok\n" || got.header.Get("Content-Type") != contentType {
 			t.Errorf("health endpoint answered %q with Content-Type %q, want ok "+

internal/discriminator/history_test.go

@@ -100,8 +100,8 @@ func TestOwnEndpointsAreNotInTheHistory(t *testing.T) {
 
 	s, _, server := startWithClock(t, "", map[string]string{metricsToken: token})
 
-	s.ownEndpointRequest("", http.MethodGet, discriminator.HealthPath, "", http.StatusOK)
-	s.ownEndpointRequest("", http.MethodGet, discriminator.MetricsPath, "",
+	s.adminRequest("", http.MethodGet, discriminator.HealthPath, "", http.StatusOK)
+	s.adminRequest("", http.MethodGet, discriminator.MetricsPath, "",
 		http.StatusUnauthorized)
 	s.scrape()
 

internal/discriminator/lookup_test.go

@@ -385,7 +385,7 @@ func TestRequestWaitsAsLongAsTheLookupTimeoutSays(t *testing.T) {
 		// is never reached.
 		const timeout = 3 * time.Second
 
-		server, out, _ := newDiscriminator(t, silentGeoJSURL, time.Now,
+		server, out, _ := newDiscriminator(t, unansweredGeoJSURL, time.Now,
 			map[string]string{
 				lookupTimeout:    timeout.String(),
 				allowedCountries: "DE",
@@ -405,25 +405,25 @@ func TestRequestWaitsAsLongAsTheLookupTimeoutSays(t *testing.T) {
 	})
 }
 
-// silentGeoJSURL is where a GeoJS that never answers is asked: a
+// unansweredGeoJSURL is where a GeoJS that never answers is asked: a
 // request to it waits, without the network, until it is abandoned.
 // TestMain registers it with Go's default transport, through which GeoJS
 // is asked.
-const silentGeoJSURL = "silent://geojs/v1/ip/geo.json"
+const unansweredGeoJSURL = "unanswered://geojs/v1/ip/geo.json"
 
 func TestMain(m *testing.M) {
 	transport, _ := http.DefaultTransport.(*http.Transport)
-	transport.RegisterProtocol("silent", silentGeoJS{})
+	transport.RegisterProtocol("unanswered", unansweredGeoJS{})
 	transport.RegisterProtocol("abuseipdb", abuseIPDBStandIn{})
 
 	m.Run()
 }
 
-// silentGeoJS is the GeoJS at silentGeoJSURL.
-type silentGeoJS struct{}
+// unansweredGeoJS is the GeoJS at unansweredGeoJSURL.
+type unansweredGeoJS struct{}
 
 // RoundTrip waits until req is abandoned.
-func (silentGeoJS) RoundTrip(req *http.Request) (*http.Response, error) {
+func (unansweredGeoJS) RoundTrip(req *http.Request) (*http.Response, error) {
 	<-req.Context().Done()
 
 	return nil, req.Context().Err()

internal/discriminator/metrics_test.go

@@ -32,7 +32,7 @@ func TestMetricsAreOffWhileTheTokenIsUnset(t *testing.T) {
 
 	// An empty token does not match the unset one either.
 	for _, authorization := range []string{bearer, "Bearer ", ""} {
-		s.ownEndpointRequest(authorization, http.MethodGet, discriminator.MetricsPath, "",
+		s.adminRequest(authorization, http.MethodGet, discriminator.MetricsPath, "",
 			http.StatusNotFound)
 	}
 }
@@ -60,7 +60,7 @@ func TestMetricsNeedTheTokenAndOtherPathsAreNotFound(t *testing.T) {
 		{http.MethodGet, "/_sww/bans", bearer, http.StatusNotFound},
 		{http.MethodPost, discriminator.HealthPath, "", http.StatusNotFound},
 	} {
-		got := s.ownEndpointRequest(tc.authorization, tc.method, tc.path, "", tc.status)
+		got := s.adminRequest(tc.authorization, tc.method, tc.path, "", tc.status)
 
 		if tc.status == http.StatusUnauthorized &&
 			got.header.Get("WWW-Authenticate") != "Bearer" {
@@ -381,8 +381,8 @@ func scrape(t *testing.T, addr string) string {
 func (s *sender) scrape() string {
 	s.t.Helper()
 
-	return string(s.ownEndpointRequest(bearer, http.MethodGet, discriminator.MetricsPath,
-		"", http.StatusOK).body)
+	return string(s.adminRequest(bearer, http.MethodGet, discriminator.MetricsPath, "",
+		http.StatusOK).body)
 }
 
 // metric returns the value of series in metrics, which are in the

internal/discriminator/proxy.go

@@ -25,9 +25,9 @@ import (
 	"sneak.berlin/go/smallwebwaf/internal/rules"
 )
 
-// ownEndpointPrefix starts the path of each of discriminator's own endpoints. The app
-// never sees a path under it.
-const ownEndpointPrefix = "/_sww/"
+// adminPrefix starts the path of each of discriminator's own endpoints. The app never
+// sees a path under it.
+const adminPrefix = "/_sww/"
 
 // HealthPath is the health endpoint of discriminator and of rproxy, which the
 // container's health check asks.

internal/discriminator/ratelimits.go

@@ -28,14 +28,12 @@ func (rateLimits) check(_ context.Context, rq *request, now time.Time) *verdict
 		return nil
 	}
 
-	rq.rateLimitPercent, rq.bytesLimitPercent = rq.limitPercentages()
-	rq.line.RateLimitPercent, rq.line.RateLimitPercentSetting =
-		rq.rateLimitPercent.logged()
-	rq.line.BytesLimitPercent, rq.line.BytesLimitPercentSetting =
-		rq.bytesLimitPercent.logged()
+	rq.limitPercent, rq.bytesPercent = rq.limitPercentages()
+	rq.line.RateLimitPercent, rq.line.RateLimitPercentSetting = rq.limitPercent.logged()
+	rq.line.BytesLimitPercent, rq.line.BytesLimitPercentSetting = rq.bytesPercent.logged()
 
 	counts, hit, over := rq.h.limiter.Count(rq.h.clientGroup(rq.client), now,
-		rq.rateLimitPercent.percent)
+		rq.limitPercent.percent)
 	rq.line.Counts = counts
 
 	if !over {

internal/discriminator/reputation_test.go

@@ -256,9 +256,9 @@ func TestASNLimitPercentFileCountsAsTheSettingDoesTheLowerWinning(t *testing.T)
 		name string
 		env  map[string]string
 		file string
-		// rateLimitPercent and bytesLimitPercent are the upload's, as
-		// percentText gives them.
-		rateLimitPercent, bytesLimitPercent string
+		// limitPercent and bytesPercent are the upload's, as percentText
+		// gives them.
+		limitPercent, bytesPercent string
 	}{
 		{"the file's alone", nil, asnDEQuarter, fromURL, fromURL},
 		{
@@ -293,10 +293,10 @@ func TestASNLimitPercentFileCountsAsTheSettingDoesTheLowerWinning(t *testing.T)
 			line := s.uploadFrom(fromDE)
 			wantPercent(t, "rate_limit_percent",
 				line.RateLimitPercent, line.RateLimitPercentSetting,
-				tc.rateLimitPercent)
+				tc.limitPercent)
 			wantPercent(t, "bytes_limit_percent",
 				line.BytesLimitPercent, line.BytesLimitPercentSetting,
-				tc.bytesLimitPercent)
+				tc.bytesPercent)
 		})
 	}
 }

internal/discriminator/request.go

@@ -48,11 +48,11 @@ type decision struct {
 	// so that not waiting never lowers its client's limits.
 	skippedLookupWait bool
 	// counted is true for a request the rate limits counted, whose bytes
-	// the byte limits count once it has ended. rateLimitPercent and
-	// bytesLimitPercent are then its client's limit percentages for the rate
+	// the byte limits count once it has ended. limitPercent and
+	// bytesPercent are then its client's limit percentages for the rate
 	// limits and for the byte limits.
 	counted                    bool
-	rateLimitPercent, bytesLimitPercent percentage
+	limitPercent, bytesPercent percentage
 	// attack is true for a request that matched a ban rule or asked for a
 	// trap path, blockedByBlockRule for one a block rule refused, and
 	// blockedByCoreRuleSet for one the Core Rule Set refused, each an offence

internal/lookup/lookup_test.go

@@ -362,7 +362,7 @@ func TestWithoutWaitTheRequestGoesOnAtOnceAndTheAnswerIsGivenWhenItComes(
 		mu.Unlock()
 
 		wantCountry(t, g, client, germany)
-		wantRequestsWithoutGeoJSAnswer(t, m, 0)
+		wantUnanswered(t, m, 0)
 	})
 }
 
@@ -596,7 +596,7 @@ func TestClientsWithoutAnAnswerAreCounted(t *testing.T) {
 		// GeoJS fails, so the first client goes without an answer, and GeoJS
 		// is left alone for a second, which does not pass in this test.
 		wantCountry(t, g, clients(), "")
-		wantRequestsWithoutGeoJSAnswer(t, m, 1)
+		wantUnanswered(t, m, 1)
 
 		// Meanwhile each new client goes without one at once, while there is
 		// room for it among the 10,000 that may wait.
@@ -604,11 +604,11 @@ func TestClientsWithoutAnAnswerAreCounted(t *testing.T) {
 			wantCountry(t, g, clients(), "")
 		}
 
-		wantRequestsWithoutGeoJSAnswer(t, m, 10000)
+		wantUnanswered(t, m, 10000)
 
 		// One more, for which there is no room, goes without one too.
 		wantCountry(t, g, clients(), "")
-		wantRequestsWithoutGeoJSAnswer(t, m, 10001)
+		wantUnanswered(t, m, 10001)
 	})
 }
 
@@ -841,9 +841,9 @@ func wantAsked(t *testing.T, geojs *standIn, i int, want ...string) {
 	}
 }
 
-// wantRequestsWithoutGeoJSAnswer checks how many requests m counts as having
-// gone without an answer from GeoJS.
-func wantRequestsWithoutGeoJSAnswer(t *testing.T, m *metrics.Metrics, want float64) {
+// wantUnanswered checks how many requests m counts as having gone without
+// an answer from GeoJS.
+func wantUnanswered(t *testing.T, m *metrics.Metrics, want float64) {
 	t.Helper()
 
 	got := testutil.ToFloat64(m.RequestsWithoutGeoJSAnswer)

internal/metrics/metrics.go

@@ -359,7 +359,7 @@ func (m *Metrics) AddAlerts(queue *alerts.Queue) {
 				Help:        "Requests to the destination that failed.",
 				ConstLabels: destination,
 			}, func() float64 {
-				return float64(queue.Counts(name).SendFailures)
+				return float64(queue.Counts(name).Failed)
 			}),
 			prometheus.NewCounterFunc(prometheus.CounterOpts{
 				Name: "sww_alerts_suppressed_total",

internal/rproxy/rproxy.go

@@ -45,9 +45,9 @@ const (
 	idleTimeout = 120 * time.Second
 )
 
-// ownEndpointPrefix starts the path of every request for sww itself, which
+// adminPrefix starts the path of every request for sww itself, which
 // never reaches the app.
-const ownEndpointPrefix = "/_sww/"
+const adminPrefix = "/_sww/"
 
 // allowedMethods lists the methods rproxy passes on, as an Allow header gives
 // them. It answers any other method 405 itself.
@@ -211,8 +211,8 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 }
 
 // passToApp passes the request on to the app, unless a limit or its path keeps
-// it from the app. discriminator answers a path under ownEndpointPrefix itself, so
-// such a request gets here only when SWRP_DEFAULT_DISPOSITION allowed it. ctx is the
+// it from the app. discriminator answers a path under adminPrefix itself, so such a
+// request gets here only when SWRP_DEFAULT_DISPOSITION allowed it. ctx is the
 // request's own context.
 func (rq *request) passToApp(ctx context.Context) {
 	maxBytes := rq.h.config.MaxRequestSize
@@ -220,7 +220,7 @@ func (rq *request) passToApp(ctx context.Context) {
 	switch {
 	case rq.refused.Load() != 0 || (maxBytes > 0 && rq.in.ContentLength > maxBytes):
 		rq.answer(http.StatusRequestEntityTooLarge)
-	case strings.HasPrefix(rq.in.URL.Path, ownEndpointPrefix):
+	case strings.HasPrefix(rq.in.URL.Path, adminPrefix):
 		rq.answer(http.StatusNotFound)
 	default:
 		rq.forward(ctx)

internal/state/state.go

@@ -64,7 +64,7 @@ var (
 	errCause       = errors.New("is not limit, attack, admin or crowdsec")
 	errExpires     = errors.New("is not after its start")
 	errDestination = errors.New("is not webhook, slack or ntfy")
-	errScope       = errors.New("is not client, net, asn, total or watched_net")
+	errScope       = errors.New("is not client, net, asn, total or watch")
 	errWaitingList = errors.New(`waiting is a list, but now lists the alerts by ` +
 		`destination: put the list under "webhook", as "waiting": {"webhook": [...]}, ` +
 		`or remove the file`)
@@ -858,8 +858,8 @@ func (f *alertsFile) check([]byte) error {
 }
 
 // checkAnomalyCounters refuses an anomaly counter whose scope is not
-// client, net, asn, total or watched_net, most likely misspelt, and one
-// without a field it needs, as missingFromCounter tells.
+// client, net, asn, total or watch, most likely misspelt, and one without
+// a field it needs, as missingFromCounter tells.
 func checkAnomalyCounters(counters []anomaly.Counter) error {
 	for i, counter := range counters {
 		if !slices.Contains(anomaly.Scopes(), counter.Scope) {
@@ -879,9 +879,9 @@ func checkAnomalyCounters(counters []anomaly.Counter) error {
 // missingFromCounter returns the first field counter, an anomaly counter,
 // needs and has not, or "" when it has them all: what tells it from the
 // others in its scope, without which it would never be counted again, the
-// netblock of a client, net or watched_net counter, the AS number of an
-// asn one and the name of a watched_net one; and the start of a window in
-// which it has requests or bytes, without which they would be dropped.
+// netblock of a client, net or watch counter, the AS number of an asn one
+// and the name of a watch one; and the start of a window in which it has
+// requests or bytes, without which they would be dropped.
 func missingFromCounter(counter anomaly.Counter) string {
 	scope := counter.Scope
 

internal/state/state_test.go

@@ -534,7 +534,7 @@ func TestFileThatDoesNotParseStopsTheStart(t *testing.T) {
 			`{"version": 1, "anomaly_counters": [{"scope": "total"}, ` +
 				`{"scope": "nett", "netblock": "203.0.113.0/24"}]}`,
 			`: anomaly_counters entry 2's scope "nett" is not client, net, asn, total ` +
-				`or watched_net`,
+				`or watch`,
 		},
 		{
 			"a copy of a list with a line that does not read", reputationJSON,