docs: Add README operator cache check #30

2026-09-03T00:16:39-05:00

pike commented

2026-09-03 00:16:39 -05:00

What

Front-and-center README Quick check: is it caching? after Quick Start: start cache → a little traffic → make validate-check → read cache_hits, cache_misses, hit_rate, memory_cache_hits, disk_cache_hits, total_requests, errors.
make validate-check is a single Makefile target: print the full /metrics dump, highlight hit/miss fields, and curl /lancache-heartbeat (default :80). Listed in make help.
Heartbeat is GET curl -s -i http://localhost/lancache-heartbeat (HTTP 204, X-LanCache-Processed-By: SteamCache2). HEAD is not accepted (server is GET-only).
SteamPrefill validation chapter, troubleshooting (one Not sure if it is caching item), and docs/examples/validate-config.yaml comments match that helper.

No new daemon, Prometheus, dashboards, metrics auth, or second metrics system.

Why

steamcache2 already exposes hit/miss on /metrics and a heartbeat, but operators had to read the long SteamPrefill validation chapter (and a Makefile target that did not exist) to answer "is it caching?".

Fixes #29

Test

make help lists one validate-check that curls /metrics (full dump + hit/miss fields) and /lancache-heartbeat.
With steamcache2 listening on default :80, make validate-check prints the full metrics dump, the hit/miss subset, and the heartbeat headers.
Manual equivalents: curl -s http://localhost/metrics and curl -s -i http://localhost/lancache-heartbeat (GET only; heartbeat 204 + X-LanCache-Processed-By: SteamCache2).
Commands assume current config default listen_address: :80.

## What - Front-and-center README **Quick check: is it caching?** after Quick Start: start cache → a little traffic → `make validate-check` → read `cache_hits`, `cache_misses`, `hit_rate`, `memory_cache_hits`, `disk_cache_hits`, `total_requests`, `errors`. - `make validate-check` is a single Makefile target: print the full `/metrics` dump, highlight hit/miss fields, and curl `/lancache-heartbeat` (default `:80`). Listed in `make help`. - Heartbeat is GET `curl -s -i http://localhost/lancache-heartbeat` (HTTP 204, `X-LanCache-Processed-By: SteamCache2`). HEAD is not accepted (server is GET-only). - SteamPrefill validation chapter, troubleshooting (one **Not sure if it is caching** item), and `docs/examples/validate-config.yaml` comments match that helper. No new daemon, Prometheus, dashboards, metrics auth, or second metrics system. ## Why steamcache2 already exposes hit/miss on `/metrics` and a heartbeat, but operators had to read the long SteamPrefill validation chapter (and a Makefile target that did not exist) to answer "is it caching?". Fixes #29 ## Test - `make help` lists one `validate-check` that curls `/metrics` (full dump + hit/miss fields) and `/lancache-heartbeat`. - With steamcache2 listening on default `:80`, `make validate-check` prints the full metrics dump, the hit/miss subset, and the heartbeat headers. - Manual equivalents: `curl -s http://localhost/metrics` and `curl -s -i http://localhost/lancache-heartbeat` (GET only; heartbeat 204 + `X-LanCache-Processed-By: SteamCache2`). - Commands assume current config default `listen_address: :80`.

pike changed target branch from main to develop

2026-09-03 00:19:52 -05:00

pike added 2 commits 2026-09-03 00:19:52 -05:00

docs: Add README operator cache check

CI / vulncheck (pull_request) Successful in 14s

Details

CI / check-and-test (pull_request) Successful in 41s

Details

ff1ab31327

The README buried hit/miss verification under the SteamPrefill validation
chapter, and advertised make validate-check without a Makefile target.
Operators need a short start → traffic → metrics path against the existing
/metrics and /lancache-heartbeat endpoints.

Link: #29

docs: Deduplicate validate-check helper

CI / vulncheck (pull_request) Successful in 14s

Details

CI / check-and-test (pull_request) Successful in 41s

Details

8b1b229539

Keep a single Makefile validate-check target that prints the full
/metrics dump, highlights hit/miss fields, and curls /lancache-heartbeat.
Drop the duplicate README troubleshooting item and align the validation
chapter plus validate-config.yaml comments with that behavior.

Link: #29

linus merged commit 71d5106777 into develop

2026-09-03 00:19:53 -05:00

linus deleted branch docs/operator-cache-check

2026-09-03 00:19:53 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: s1d3sw1ped/steamcache2#30