0 Fork 0

Files

T

check / check (push) Waiting to run

Details

Caches of outside APIs live in /var/cache/sww (closes #314 )

Every cache of answers from an outside service has its own file in `SWW_CACHE_DIR` (default `/var/cache/sww`): `lookups.json` (GeoJS), `lists.json` (lists fetched by URL, CrowdSec's decisions included), `dnsbl.json`, `abuseipdb-scores.json` and `routewatch.json` (at most 100,000 answers, each kept an hour). `reputation.json` is gone; the AbuseIPDB checks spent today stay in `SWW_STATE_DIR` as `abuseipdb-checks-spent.json`, since losing them would spend the daily budget twice.

A cache file never stops the start: one that does not parse is set aside as `<name>.bad` with a `file_error` alert. An unwritable `SWW_CACHE_DIR` stops the start. The `run` script creates the cache directory and gives it to `sww`. The cache directory needs no volume and can be left out of backups.

Model: opus-5-5

2026-11-11 10:56:43 +01:00

3.2 KiB

Raw Blame History

The metrics

What GET /_sww/metrics answers with, at waf's own address. "Metrics endpoint" in SPEC.md describes the endpoint. Prometheus keeps the instance label as exported_instance unless the scrape sets honor_labels: true. rproxy has no metrics.

Every sww_*request_bytes_total and sww_*response_bytes_total series counts body bytes, never headers, whatever SWW_BYTES_COUNT says.

Traffic

sww_requests_total, sww_request_bytes_total and sww_response_bytes_total, by status_class such as 2xx and by action;
sww_request_duration_seconds and sww_upstream_duration_seconds, as histograms;
sww_requests_in_flight: the questions and requests to its own endpoints that waf is handling.

Limits and bans

sww_rate_limit_hits_total, by window and by kind (requests, bytes or refusals);
sww_offences_total, by kind;
sww_bans_made_total, by cause;
sww_active_bans and sww_permanent_bans.

Attack detection

sww_rule_matches_total, by rule_id and action, and sww_rules_loaded;
sww_core_rule_set_matches_total, by mode and rule_id, for the rules that fired.

Countries and AS numbers

For the SWW_METRICS_TOP_N busiest of each, the rest as other:

sww_country_requests_total, sww_country_request_bytes_total, sww_country_response_bytes_total and sww_country_list_refusals_total, by country;
sww_asn_requests_total, sww_asn_request_bytes_total and sww_asn_response_bytes_total, by asn.

Lookups

sww_geojs_requests_total and sww_geojs_failures_total;
sww_requests_without_geojs_answer_total: the requests that needed an answer and went on without it;
with the file source, sww_lookup_database_last_read_timestamp_seconds and sww_lookup_database_read_failures_total.

Reputation sources

By source: each list's URL, each zone, and abuseipdb:

sww_reputation_hits_total, sww_reputation_queries_total and sww_reputation_failures_total;
sww_reputation_last_fetch_timestamp_seconds, for a list;
sww_reputation_daily_budget_remaining, for AbuseIPDB.

State and cache files

By file, the name of a state or cache file:

sww_state_file_writes_total, sww_state_file_write_failures_total, sww_state_file_last_write_timestamp_seconds and sww_state_file_size_bytes;
sww_state_file_edits_taken_in_total and sww_state_file_edits_set_aside_total;
sww_tracked_clients: the clients in the table.

Remote log, alerts and the process

while a syslog server is set, sww_remote_log_lines_sent_total, sww_remote_log_lines_dropped_total and sww_remote_log_lines_waiting;
by destination, sww_alerts_sent_total, sww_alert_send_failures_total, sww_alerts_suppressed_total and sww_alerts_dropped_total;
Go's own go_ metrics and the process's process_ metrics.

When a request is counted

waf counts a denied request at its decision, and a request to its own endpoints when it is answered. It counts an allowed request when its report comes, with the status, bytes and times the report gives. These are not counted:

a report itself;
an allowed request whose report never comes;
a question refused with 400;
a question whose body stopped arriving.

3.2 KiB Raw Blame History