Log lines, metric help and comments say "state files" where cache files are meant too #344

Closed
opened 2026-11-11 08:28:17 +01:00 by clawbot · 1 comment
Collaborator

From the rework of #336 (#336 (comment)), which moves the caches of outside services into their own files in SWW_CACHE_DIR. These texts still say "state files" where they also cover the cache files, so an operator reading them looks in the wrong directory:

  • internal/sww/sww.go: the log lines "cannot use the state files" and "writing the state files failed", and the comments around them;
  • internal/metrics/metrics.go: the help texts of the metrics about reading and writing the files;
  • internal/alerts/alerts.go: the comment on EventFileError.

Definition of done, one PR into next, after #336 lands:

  • Each text names what it covers: "state file" or "cache file" for one file of that kind, "state and cache files" for both. Log lines and help texts that a test or docs/ quotes change there too.
  • No metric or log field is renamed; only the texts change.

Follow AGENTS.md: checks only through make targets. make fmt, then flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check; a flock timeout also exits 1, so read the output. Edit by hand. Title ending (closes #N) with this issue's number. Label the PR needs-review.

Model: opus-5-5

From the rework of https://git.eeqj.de/sneak/smallwebwaf/pulls/336 (https://git.eeqj.de/sneak/smallwebwaf/pulls/336#issuecomment-178075), which moves the caches of outside services into their own files in `SWW_CACHE_DIR`. These texts still say "state files" where they also cover the cache files, so an operator reading them looks in the wrong directory: - `internal/sww/sww.go`: the log lines "cannot use the state files" and "writing the state files failed", and the comments around them; - `internal/metrics/metrics.go`: the help texts of the metrics about reading and writing the files; - `internal/alerts/alerts.go`: the comment on `EventFileError`. **Definition of done**, one PR into `next`, after https://git.eeqj.de/sneak/smallwebwaf/pulls/336 lands: - Each text names what it covers: "state file" or "cache file" for one file of that kind, "state and cache files" for both. Log lines and help texts that a test or `docs/` quotes change there too. - No metric or log field is renamed; only the texts change. Follow `AGENTS.md`: checks only through `make` targets. `make fmt`, then `flock -w 1800 /srv/code/tmp/.gate-smallwebwaf.lock make check`; a `flock` timeout also exits 1, so read the output. Edit by hand. Title ending ` (closes #N)` with this issue's number. Label the PR `needs-review`. Model: opus-5-5
clawbot self-assigned this 2026-11-11 08:28:17 +01:00
Author
Collaborator

Folded into #336 by #336 (comment); its rework makes these changes.

Model: opus-5-5

Folded into https://git.eeqj.de/sneak/smallwebwaf/pulls/336 by https://git.eeqj.de/sneak/smallwebwaf/pulls/336#issuecomment-178128; its rework makes these changes. Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/smallwebwaf#344