jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-10-27 12:40:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(relay): document the DEBUG empty-read rule and optional list counts

Browse Source 
Signed-off-by: Duncan <dcfd242e557282d7a1e2cf2e6877522682f1e5c6156dc92ca7d90eaedd3b0f95@buzz.block.builderlab.xyz>
This commit is contained in:
Duncan
2026-10-26 20:03:12 -04:00
parent 5d6a4724f2
commit 3a4e6f92c1
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
.env.example
View File

@@ -240,7 +240,8 @@ RUST_LOG=buzz_relay=debug,buzz_datastore=info,buzz_db=debug,buzz_auth=debug,buzz
# `req`, `count`, or `close`. `http` is one line per HTTP request, written
# by one layer when the response is ready (not proof the body was delivered):
# `route` is the matched route template (never the raw path), with the response
# `status` and `time_to_response_ms` on every line. It carries the login
# `status` and `time_to_response_ms` on every line; the method is the
# enclosing `http.request` span's `http.request.method`. It carries the login
# (`method`, `pubkey`, `pubkey_verified`) and `outcome` (`success`, `denied`,
# `failed`, `challenged`, or `undecided` when the route recorded no decision; a
# refusal is final). `/query` and `/count` add the filter summary and
@@ -261,7 +262,10 @@ RUST_LOG=buzz_relay=debug,buzz_datastore=info,buzz_db=debug,buzz_auth=debug,buzz
# `auth` is one line per WebSocket login, written when it succeeds or is
# refused; every root WebSocket `auth` line carries the TCP `peer_addr`.
# `req` / `count` is one line per WebSocket read, with the same filter summary
# (search text is never logged, only `search: true`). `close` is the
# (search text is never logged, only `search: true`). The summary lists up to
# 10 kinds, channel ids, authors and `p` values each; `kind_count`,
# `channel_count`, `author_count` and `p_count` appear only when the list is
# `*` or shows fewer values than the filters held. `close` is the
# connection's one line: duration, totals, the login's `pubkey`, `method` and
# `pubkey_verified`, and `reads_suppressed` / `auth_suppressed` for repeated
# refusals past the first 16. It is written however the connection ends, with
@@ -270,7 +274,9 @@ RUST_LOG=buzz_relay=debug,buzz_datastore=info,buzz_db=debug,buzz_auth=debug,buzz
# their own lines.
# Successful lines and git's credential-less first request
# (`outcome=challenged`) are INFO; refusals, error statuses and aborted
# requests are WARN. A WebSocket read is WARN only when it ends in `error`;
# requests are WARN. A successful `/query` or `/count` that returned nothing
# (`result_count=0`) is DEBUG, since polling clients make most of them. A
# WebSocket read is WARN only when it ends in `error`;
# refused and `aborted` reads stay INFO, since `aborted` means the client
# closed the connection mid-read, which is routine. Turn it down with
# `buzz_relay::access=warn` (keeps refusals, errors and aborted HTTP requests,