username/s5p
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update project docs for backoff, stale expiry, pool metrics

Browse Source 
Add failure backoff and stale expiry sections to USAGE. Document pool=
field in metrics output. Update ROADMAP, TASKS, TODO with completed
items and remaining suggestions. Add metrics example to CHEATSHEET.
This commit is contained in:
user
2026-02-15 15:56:06 +01:00
parent 8aa384a80b
commit eddcc5f615
7 changed files with 36 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/CHEATSHEET.md
View File

@@ -87,6 +87,12 @@ curl --max-time 30 -x socks5h://127.0.0.1:1080 https://example.com
python -m pstats s5p.prof # interactive stats viewer
```
## Metrics Log
```
metrics: conn=142 ok=98 fail=44 retries=88 active=3 in=1.2M out=4.5M up=0h05m12s pool=42/65
```
## Troubleshooting
| Symptom | Check |
@@ -97,3 +103,4 @@ python -m pstats s5p.prof # interactive stats viewer
| Auth failed | Verify credentials in proxy URL |
| Port in use | `fuser -k 1080/tcp` to free the port |
| Container slow stop | Rebuild image after SIGTERM fix |
| Proxy keeps failing | Backoff penalizes for 60s; check `pool=` in metrics |