Repository navigation
docs: Match README, TELEMETRY, and AGENTS to the code of 0.3.0 - #59
Merged
Merged
Conversation
Check each path, limit, metric, attribute, and section against the code after the service split (#55) and the client tidy (#57): - README: name the `url` input of the action, the rule name limits, the length limit of run secrets, the full list of credential header names, what a recording keeps (method, redacted URL, `content-type` and `location`), the 500 misses that the stats keep, `http.request.method` on `roach.request` and `roach.upstream`, the 10 s limit of a PROXY header, the 201/400/401/429 answers of `POST /__roach/runs`, and the 404 for a wrong run token. - README: the service log gets the class, the code, and the GCS status of an error. - README: shorten the one-time PROXY protocol rollout to the steady-state order: deploy the image, apply the config secret with `-target`, reset the VM, apply the rest. - README: drop the cache list of "Sentry" that TELEMETRY.md repeats, and the repeat of the miss rule of "Misses" in "Service". Move the changing-keys query to TELEMETRY.md. - README: list redaction.test.ts and packages/roach/tests/package.test.ts, and say that CI also runs coverage and packs the package. - TELEMETRY: name server.ts as a source, add `roach.recordings`, `roach.written`, and `http.request.method`, and the log fields. - AGENTS: the Image workflow runs `terraform validate`, not CI. - service.ts and server.ts comments: the key worker is a process, and the keep-alive time is 5 s and 1 s more. Only docs and comments change. The tunnel limits bullet stays as on main, because the fix of the tunnel idle limit changes it. Co-Authored-By: David Cramer <23610+dcramer@users.noreply.github.com>
CI runs the tests only with coverage. POST /runs also answers 400 for a body that is not JSON and 413 over 1 MiB. Put back the warning about a false PROXY header from step 3 to step 4. roach.written is also on roach.run.end, and a call without a request model has gen_ai.response.model, so the cost query groups by both. Co-Authored-By: David Cramer <23610+dcramer@users.noreply.github.com>
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.
Stacked on the tunnel idle PR (
fix/tunnel-idle). Merge that first.Every path, limit, status code, metric, attribute and deploy step was checked against the code:
urlinput, rule-name limits, the 16 Ki secret length, and the full list of credential nameshttp.request.methodon spans, and the 10 s PROXY header limitPOST /__roach/runs: 201/400/401/413/429, including 400 for a body that is not JSON; 404 for a wrong run token-target, reset the VM, then the full apply. The warning that a client can send its own PROXY header between step 3 and step 4 is kept.TELEMETRY.md:roach.writtenis also onroach.run.end; a call without a request model hasgen_ai.response.model, so the cost query groups by bothAGENTS.mdnow says the Image workflow runsterraform validateTELEMETRY.mdalready has, and a repeated miss ruleserver.tsandservice.tschange only in comments. An independent review checked each claim against the code.pnpm checkpasses.via @dcramer.
--
View Session [Sentry]