Rebuild README for discoverability and honest limits - #1
Merged
Conversation
Restructures the README so positioning and real user questions come before
reference material, and states two limits the previous version didn't.
- Add "Questions this tool answers": ten questions phrased the way people
actually ask them, covering debugging, network and SRE angles.
- State the HTTP/1.x-only limit. Detection matches nine ASCII method tokens
and "HTTP/" (httptop.bpf.c:158-176), so h2c and HTTP/2 never appear —
the most likely cause of an empty dashboard on modern internal services.
Points h2c/gRPC users at grpcsnoop.
- Add "Have an agent set it up", and move the demo traffic generator into
the install flow: an empty dashboard and a broken one look identical.
- Move the environment table below the fold; it sat between the reader and
everything explaining the tool.
- Give each capability flag its reason, since dropping one fails quietly.
- Collapse the alerts implementation notes into <details>. Nothing removed.
- Rename "Honest caveats" to "What it can't see" and add the
aggregates-vs-stream trust rule.
- Name the category in the one-sentence definition.
- Link the badges; they were inert images.
- Rename "One `docker run`" to "Run it with Docker" (the inline code made a
poor anchor) and fix the references, including the agent prompt.
No LICENSE file exists in the repo, though GPL-2.0 is asserted from the BPF
program's SEC("license") declaration. Flagged for a reviewer.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rebuilds the README so positioning and real user questions come before reference material. Content is preserved; almost nothing was deleted, several things moved and two limits were added.
Reviewer action items
Apply the About description — needs repo admin; I have WRITE, so
gh repo edit404s.102 chars. Replaces a 222-char line that was too long for GitHub's display, opened lowercase, contained an em-dash, and claimed "one Docker command" (the real command has nine flags; the tagline now says "one container").
Apply the topic tags. Current set is 7 and
browser/gui/webare noise.Apply one per line or verify after applying. logedex shipped with four mangled tags (
devop,linu,fleet-managemen) from a space-separated paste.Add a LICENSE file. The README asserts GPL-2.0 and no
LICENSEexists. The claim is grounded in the BPF program'sSEC("license") = "GPL", which covers that program rather than the repo.Confirm the HTTP/1.x-only caveat (below). Grounded in source, but it's a limit the previous README never stated.
The one substantive finding
is_http_request()matches nine hardcoded ASCII method tokens andis_http_response()matches a literalHTTP/(httptop.bpf.c:158-176). HTTP/2 and cleartext h2c are binary with HPACK-compressed headers, so they never match and never appear.This was undocumented and is probably the most common "empty dashboard" report waiting to happen, since plenty of internal services speak h2c. It's now stated in "What it can't see", it's the first cause listed in a new "dashboard is empty" FAQ entry, and h2c/gRPC users are pointed at
grpcsnoop.Please confirm nobody intended h2c to work.
What changed
Added
Moved
Reshaped
--privileged.<details>block for the implementation rationale. The Block Kit ladder, the ReDoS canary reasoning and theyeet.alert-is-isolate-only constraint are all still there.recentDropped).## One \docker run`→## Run it with Docker`. The inline code made a poor anchor and TOC entry; all three references updated, including the one inside the agent prompt.Removed
Notes
~515 MBimage size dropped rather than repeated unverified.