Compare commits
3
Commits
07ea5b01ec
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
18d01b64d7 | ||
|
|
5dfd2c0f7e | ||
|
|
d6ddac4a03 |
@@ -84,3 +84,15 @@ When acting as a coding agent on this project:
|
|||||||
4. Never modify files outside the project root without explicit permission
|
4. Never modify files outside the project root without explicit permission
|
||||||
5. When adding a dependency, explain why in the commit message
|
5. When adding a dependency, explain why in the commit message
|
||||||
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
||||||
|
|
||||||
|
## `main` is protected: ship by PR (local-dev#42, decided 2026-10-08)
|
||||||
|
|
||||||
|
Gitea refuses direct pushes to `main` in this repo, and a PR merges only after its CI status (`CI / Lint / Test / Vet (pull_request)`) passes.
|
||||||
|
**Why:** local-dev rule 5's reviewed lane (risk/medium+ is reviewed by a human) was enforced on the merge tools
|
||||||
|
(`tbd_ship`, `pr_merge`: gitea-mcp v0.17.0/v0.18.0, merge only for an issue labelled exactly `risk/low` with green CI)
|
||||||
|
but not on a direct commit to `main`, which bypassed it. This overrides rule 5's "risk/low commits straight to main"
|
||||||
|
for this repo; control code is where the lane matters.
|
||||||
|
**How:** `tbd_ship` for a one-file change, or branch -> PR -> `pr_merge` (name the `risk/low` issue); above `risk/low`
|
||||||
|
open the PR and a human merges it in the Gitea UI after review. Tags are not protected. CD jobs push image tags to
|
||||||
|
the **infra** repo with deploy keys, never to this repo's `main`. Undo (Mathias only): Settings -> Branches, or
|
||||||
|
`PATCH /repos/mathias/hyperguild/branch_protections/main {"enable_push": true}`.
|
||||||
|
|||||||
+81
-17
@@ -164,6 +164,63 @@ These rules apply to every task across every project, regardless of harness.
|
|||||||
the thing it was named for was exploitable. If you cannot name the mechanism,
|
the thing it was named for was exploitable. If you cannot name the mechanism,
|
||||||
you do not yet know what the test observes.
|
you do not yet know what the test observes.
|
||||||
|
|
||||||
|
10. **Short sessions, one rc per repo, edit only in a locked worktree of the repo
|
||||||
|
you are changing** (ADR-0002, accepted 2026-10-06).
|
||||||
|
- One session per issue or task, ending with rule 6's close ritual. Related
|
||||||
|
issues may share a session only when they share a worktree and an owner.
|
||||||
|
State that must outlive the session goes in an issue, not the chat.
|
||||||
|
- Start `claude rc` in the repo you will edit (`infra`, `trucker-ecommerce`,
|
||||||
|
`hyperguild`, ...), not in `~/dev`: the rc worktree is a worktree of the
|
||||||
|
launch directory's repo, so launched from `~/dev` it protects nothing you
|
||||||
|
edit (measured: 73% of edits landed in shared checkouts). Start it only
|
||||||
|
while working there.
|
||||||
|
- Keep at most one thin `~/dev` coordinator session. It files issues and hands
|
||||||
|
out tasks; it reads and edits no sub-repo code.
|
||||||
|
- Split cross-repo work per repo. The contract between the halves lives in an
|
||||||
|
issue on each repo.
|
||||||
|
- Edit in a worktree of that repo, locked at creation:
|
||||||
|
`scripts/wt.sh add <repo> <task>` does it (fetch, `wt/<task>` from origin/main, lock);
|
||||||
|
`scripts/wt.sh done <repo>-<task>` removes it after the push and refuses dirty or
|
||||||
|
unpushed work. By hand: `git worktree add ~/worktrees/<name> -b <branch> origin/main`
|
||||||
|
then `git worktree lock --reason "manual: <purpose>" ~/worktrees/<name>`.
|
||||||
|
- Before working a repo another session may touch, announce your issue list to
|
||||||
|
that session (`SendMessage`) and ask for theirs.
|
||||||
|
- Auto-memory is keyed by cwd, so a repo rc starts without it. Cross-repo
|
||||||
|
working rules live in brain (`wiki/homelab/decisions/2026-10-06-062416-auto.md`, wing homelab, hall
|
||||||
|
decisions) and the section below, not in per-directory memory.
|
||||||
|
|
||||||
|
## Standing footguns
|
||||||
|
|
||||||
|
Each cost real time once. Detail and evidence: brain `wiki/homelab/decisions/2026-10-06-062416-auto.md` (title standing-working-rules).
|
||||||
|
|
||||||
|
- **Gate then commit with `&&`, never `;`.** "Green" means exit code 0 and
|
||||||
|
`grep -c FAIL` is 0, not a filtered grep.
|
||||||
|
- **Stage by path, never `git add -A` or `git add .`** (they stage from the repo
|
||||||
|
root and swept in other sessions' work twice). Check `git status --porcelain` first.
|
||||||
|
- **Before committing in a shared checkout:** `git branch --show-current`.
|
||||||
|
- **Before tagging:** `git fetch origin --tags`, then `git describe --tags --abbrev=0 <sha>`
|
||||||
|
and `git tag --sort=-v:refname | head`; go above both. Never take the last tag
|
||||||
|
from a report.
|
||||||
|
- **Run only what the project's gate runs.** No repo-wide formatter unless the gate
|
||||||
|
runs it.
|
||||||
|
- **Reproduce a CI red at the cited commit before applying an issue's prescribed fix.**
|
||||||
|
- **Read an issue's comments (`issue_list_comments`), not just its body, before working it.**
|
||||||
|
- **A comment naming a control ("behind branch protection") is not evidence; query
|
||||||
|
the control.** A working detector can hide a missing preventer.
|
||||||
|
- **On koala the MCP servers are `mcp__plugin_skills_{brain,gitea,infra}__*`.** The
|
||||||
|
per-turn auth reminder is not evidence; call the tool or run `claude mcp list`.
|
||||||
|
Brain writes always pass `wing` + `hall`.
|
||||||
|
- **`cat /etc/hostname` before assuming which host you are on.**
|
||||||
|
- **Never run bare `git remote -v` or `git config --list`** (url.insteadOf expands
|
||||||
|
into a live token); use `git config --get remote.origin.url`.
|
||||||
|
- **On koala `sudo` is denied outright; k8s exec, env dumps and flux reconcile need
|
||||||
|
per-action approval; decrypting a SOPS file and printing in one Bash call is
|
||||||
|
hook-blocked.** Do the repo-side work and hand the host-side step over in an issue.
|
||||||
|
- **`set -o pipefail` plus an optional `grep | head | awk` dies on no match:** append `|| true`.
|
||||||
|
- **Gitea `file_write_branch` takes plain text, not base64.**
|
||||||
|
- **`OP_SERVICE_ACCOUNT_TOKEN` in the shell is read-only for `op`.** Operational
|
||||||
|
secrets go in the AgentSecrets vault via `set -a; . ~/.op-agent-write.env; set +a`.
|
||||||
|
|
||||||
## CAD sprint patterns
|
## CAD sprint patterns
|
||||||
|
|
||||||
Two CAD sprint archetypes (defs: brain `wiki/homelab/decisions/continuous-agentic-development-cad-concept-2026-06-16`):
|
Two CAD sprint archetypes (defs: brain `wiki/homelab/decisions/continuous-agentic-development-cad-concept-2026-06-16`):
|
||||||
@@ -244,25 +301,20 @@ Three machines on Tailscale:
|
|||||||
|
|
||||||
All development repos live at `~/dev/` (softlink from `~/Documents/local-dev/`).
|
All development repos live at `~/dev/` (softlink from `~/Documents/local-dev/`).
|
||||||
|
|
||||||
Organized in thematic folders:
|
Organized by **role**, because the role decides which rules apply (ADR-0003):
|
||||||
|
|
||||||
| Folder | Focus | Count |
|
| Folder | Role | Rules that key off it |
|
||||||
|--------|-------|-------|
|
|--------|------|-----------------------|
|
||||||
| `GO/` | Go web frameworks, API integrations, learning projects | ~10 |
|
| `platform/` | infra, brain, hyperguild, gitea-mcp, dispatch, shared tooling | control code (rule 8), GitOps review lane |
|
||||||
| `AI/` | ML research, AI frameworks (FinRL, DSPy, crawl4ai) | ~6 |
|
| `products/` | tapir, cobalt-dingo, openbanking-api, ... | ordinary trunk-based work |
|
||||||
| `AGENTS/` | Autonomous agents, coding agents, MCP servers, infra | ~15 |
|
| `clients/` | client work | local models only, never cloud APIs (Client work rules) |
|
||||||
| `QKX/` | Invoice processing, financial automation, payment systems | ~13 |
|
| `spikes/` | throwaway | no ceremony |
|
||||||
| `XT/` | Climate data, sustainability (Klimatkollen, Garbo) | ~2 |
|
|
||||||
|
|
||||||
See `~/dev/PROJECT_SUMMARY.md` for detailed descriptions of each project.
|
New projects are born into a role folder (`task new-project -- <name> <client|personal>
|
||||||
|
<role-folder>`); a client tag requires `clients/` and `clients/` requires a client tag.
|
||||||
### Key active projects
|
Existing repos still sit in the old `AGENTS/` and `AI/` folders until they are moved one by
|
||||||
|
one (ADR-0003 step 3). `~/dev/PROJECT_SUMMARY.md` (generated) lists every repo and where it
|
||||||
- **super-koala** (`AGENTS/`) — multi-component agent stack with LangGraph, DSPy, MCP
|
is. How a session runs on koala (worktrees, rc per repo, the reaper, memory): `docs/working-on-koala.md`.
|
||||||
- **azure-tiger** (`QKX/`) — invoice extraction → ISO 20022 payment instructions
|
|
||||||
- **gocrwl** (`AGENTS/`) — Go web crawler with containerized deployment
|
|
||||||
- **koala-ai-stack** (`AGENTS/`) — local AI server infrastructure management
|
|
||||||
- **klimatkollen** (`XT/`) — Swedish municipal climate data platform
|
|
||||||
|
|
||||||
## Knowledge base — actively use it
|
## Knowledge base — actively use it
|
||||||
|
|
||||||
@@ -514,4 +566,16 @@ When acting as a coding agent on this project:
|
|||||||
5. When adding a dependency, explain why in the commit message
|
5. When adding a dependency, explain why in the commit message
|
||||||
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
||||||
|
|
||||||
|
## `main` is protected: ship by PR (local-dev#42, decided 2026-10-08)
|
||||||
|
|
||||||
|
Gitea refuses direct pushes to `main` in this repo, and a PR merges only after its CI status (`CI / Lint / Test / Vet (pull_request)`) passes.
|
||||||
|
**Why:** local-dev rule 5's reviewed lane (risk/medium+ is reviewed by a human) was enforced on the merge tools
|
||||||
|
(`tbd_ship`, `pr_merge`: gitea-mcp v0.17.0/v0.18.0, merge only for an issue labelled exactly `risk/low` with green CI)
|
||||||
|
but not on a direct commit to `main`, which bypassed it. This overrides rule 5's "risk/low commits straight to main"
|
||||||
|
for this repo; control code is where the lane matters.
|
||||||
|
**How:** `tbd_ship` for a one-file change, or branch -> PR -> `pr_merge` (name the `risk/low` issue); above `risk/low`
|
||||||
|
open the PR and a human merges it in the Gitea UI after review. Tags are not protected. CD jobs push image tags to
|
||||||
|
the **infra** repo with deploy keys, never to this repo's `main`. Undo (Mathias only): Settings -> Branches, or
|
||||||
|
`PATCH /repos/mathias/hyperguild/branch_protections/main {"enable_push": true}`.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -159,6 +159,63 @@ These rules apply to every task across every project, regardless of harness.
|
|||||||
the thing it was named for was exploitable. If you cannot name the mechanism,
|
the thing it was named for was exploitable. If you cannot name the mechanism,
|
||||||
you do not yet know what the test observes.
|
you do not yet know what the test observes.
|
||||||
|
|
||||||
|
10. **Short sessions, one rc per repo, edit only in a locked worktree of the repo
|
||||||
|
you are changing** (ADR-0002, accepted 2026-10-06).
|
||||||
|
- One session per issue or task, ending with rule 6's close ritual. Related
|
||||||
|
issues may share a session only when they share a worktree and an owner.
|
||||||
|
State that must outlive the session goes in an issue, not the chat.
|
||||||
|
- Start `claude rc` in the repo you will edit (`infra`, `trucker-ecommerce`,
|
||||||
|
`hyperguild`, ...), not in `~/dev`: the rc worktree is a worktree of the
|
||||||
|
launch directory's repo, so launched from `~/dev` it protects nothing you
|
||||||
|
edit (measured: 73% of edits landed in shared checkouts). Start it only
|
||||||
|
while working there.
|
||||||
|
- Keep at most one thin `~/dev` coordinator session. It files issues and hands
|
||||||
|
out tasks; it reads and edits no sub-repo code.
|
||||||
|
- Split cross-repo work per repo. The contract between the halves lives in an
|
||||||
|
issue on each repo.
|
||||||
|
- Edit in a worktree of that repo, locked at creation:
|
||||||
|
`scripts/wt.sh add <repo> <task>` does it (fetch, `wt/<task>` from origin/main, lock);
|
||||||
|
`scripts/wt.sh done <repo>-<task>` removes it after the push and refuses dirty or
|
||||||
|
unpushed work. By hand: `git worktree add ~/worktrees/<name> -b <branch> origin/main`
|
||||||
|
then `git worktree lock --reason "manual: <purpose>" ~/worktrees/<name>`.
|
||||||
|
- Before working a repo another session may touch, announce your issue list to
|
||||||
|
that session (`SendMessage`) and ask for theirs.
|
||||||
|
- Auto-memory is keyed by cwd, so a repo rc starts without it. Cross-repo
|
||||||
|
working rules live in brain (`wiki/homelab/decisions/2026-10-06-062416-auto.md`, wing homelab, hall
|
||||||
|
decisions) and the section below, not in per-directory memory.
|
||||||
|
|
||||||
|
## Standing footguns
|
||||||
|
|
||||||
|
Each cost real time once. Detail and evidence: brain `wiki/homelab/decisions/2026-10-06-062416-auto.md` (title standing-working-rules).
|
||||||
|
|
||||||
|
- **Gate then commit with `&&`, never `;`.** "Green" means exit code 0 and
|
||||||
|
`grep -c FAIL` is 0, not a filtered grep.
|
||||||
|
- **Stage by path, never `git add -A` or `git add .`** (they stage from the repo
|
||||||
|
root and swept in other sessions' work twice). Check `git status --porcelain` first.
|
||||||
|
- **Before committing in a shared checkout:** `git branch --show-current`.
|
||||||
|
- **Before tagging:** `git fetch origin --tags`, then `git describe --tags --abbrev=0 <sha>`
|
||||||
|
and `git tag --sort=-v:refname | head`; go above both. Never take the last tag
|
||||||
|
from a report.
|
||||||
|
- **Run only what the project's gate runs.** No repo-wide formatter unless the gate
|
||||||
|
runs it.
|
||||||
|
- **Reproduce a CI red at the cited commit before applying an issue's prescribed fix.**
|
||||||
|
- **Read an issue's comments (`issue_list_comments`), not just its body, before working it.**
|
||||||
|
- **A comment naming a control ("behind branch protection") is not evidence; query
|
||||||
|
the control.** A working detector can hide a missing preventer.
|
||||||
|
- **On koala the MCP servers are `mcp__plugin_skills_{brain,gitea,infra}__*`.** The
|
||||||
|
per-turn auth reminder is not evidence; call the tool or run `claude mcp list`.
|
||||||
|
Brain writes always pass `wing` + `hall`.
|
||||||
|
- **`cat /etc/hostname` before assuming which host you are on.**
|
||||||
|
- **Never run bare `git remote -v` or `git config --list`** (url.insteadOf expands
|
||||||
|
into a live token); use `git config --get remote.origin.url`.
|
||||||
|
- **On koala `sudo` is denied outright; k8s exec, env dumps and flux reconcile need
|
||||||
|
per-action approval; decrypting a SOPS file and printing in one Bash call is
|
||||||
|
hook-blocked.** Do the repo-side work and hand the host-side step over in an issue.
|
||||||
|
- **`set -o pipefail` plus an optional `grep | head | awk` dies on no match:** append `|| true`.
|
||||||
|
- **Gitea `file_write_branch` takes plain text, not base64.**
|
||||||
|
- **`OP_SERVICE_ACCOUNT_TOKEN` in the shell is read-only for `op`.** Operational
|
||||||
|
secrets go in the AgentSecrets vault via `set -a; . ~/.op-agent-write.env; set +a`.
|
||||||
|
|
||||||
## CAD sprint patterns
|
## CAD sprint patterns
|
||||||
|
|
||||||
Two CAD sprint archetypes (defs: brain `wiki/homelab/decisions/continuous-agentic-development-cad-concept-2026-06-16`):
|
Two CAD sprint archetypes (defs: brain `wiki/homelab/decisions/continuous-agentic-development-cad-concept-2026-06-16`):
|
||||||
@@ -239,25 +296,20 @@ Three machines on Tailscale:
|
|||||||
|
|
||||||
All development repos live at `~/dev/` (softlink from `~/Documents/local-dev/`).
|
All development repos live at `~/dev/` (softlink from `~/Documents/local-dev/`).
|
||||||
|
|
||||||
Organized in thematic folders:
|
Organized by **role**, because the role decides which rules apply (ADR-0003):
|
||||||
|
|
||||||
| Folder | Focus | Count |
|
| Folder | Role | Rules that key off it |
|
||||||
|--------|-------|-------|
|
|--------|------|-----------------------|
|
||||||
| `GO/` | Go web frameworks, API integrations, learning projects | ~10 |
|
| `platform/` | infra, brain, hyperguild, gitea-mcp, dispatch, shared tooling | control code (rule 8), GitOps review lane |
|
||||||
| `AI/` | ML research, AI frameworks (FinRL, DSPy, crawl4ai) | ~6 |
|
| `products/` | tapir, cobalt-dingo, openbanking-api, ... | ordinary trunk-based work |
|
||||||
| `AGENTS/` | Autonomous agents, coding agents, MCP servers, infra | ~15 |
|
| `clients/` | client work | local models only, never cloud APIs (Client work rules) |
|
||||||
| `QKX/` | Invoice processing, financial automation, payment systems | ~13 |
|
| `spikes/` | throwaway | no ceremony |
|
||||||
| `XT/` | Climate data, sustainability (Klimatkollen, Garbo) | ~2 |
|
|
||||||
|
|
||||||
See `~/dev/PROJECT_SUMMARY.md` for detailed descriptions of each project.
|
New projects are born into a role folder (`task new-project -- <name> <client|personal>
|
||||||
|
<role-folder>`); a client tag requires `clients/` and `clients/` requires a client tag.
|
||||||
### Key active projects
|
Existing repos still sit in the old `AGENTS/` and `AI/` folders until they are moved one by
|
||||||
|
one (ADR-0003 step 3). `~/dev/PROJECT_SUMMARY.md` (generated) lists every repo and where it
|
||||||
- **super-koala** (`AGENTS/`) — multi-component agent stack with LangGraph, DSPy, MCP
|
is. How a session runs on koala (worktrees, rc per repo, the reaper, memory): `docs/working-on-koala.md`.
|
||||||
- **azure-tiger** (`QKX/`) — invoice extraction → ISO 20022 payment instructions
|
|
||||||
- **gocrwl** (`AGENTS/`) — Go web crawler with containerized deployment
|
|
||||||
- **koala-ai-stack** (`AGENTS/`) — local AI server infrastructure management
|
|
||||||
- **klimatkollen** (`XT/`) — Swedish municipal climate data platform
|
|
||||||
|
|
||||||
## Knowledge base — actively use it
|
## Knowledge base — actively use it
|
||||||
|
|
||||||
@@ -508,3 +560,15 @@ When acting as a coding agent on this project:
|
|||||||
4. Never modify files outside the project root without explicit permission
|
4. Never modify files outside the project root without explicit permission
|
||||||
5. When adding a dependency, explain why in the commit message
|
5. When adding a dependency, explain why in the commit message
|
||||||
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
||||||
|
|
||||||
|
## `main` is protected: ship by PR (local-dev#42, decided 2026-10-08)
|
||||||
|
|
||||||
|
Gitea refuses direct pushes to `main` in this repo, and a PR merges only after its CI status (`CI / Lint / Test / Vet (pull_request)`) passes.
|
||||||
|
**Why:** local-dev rule 5's reviewed lane (risk/medium+ is reviewed by a human) was enforced on the merge tools
|
||||||
|
(`tbd_ship`, `pr_merge`: gitea-mcp v0.17.0/v0.18.0, merge only for an issue labelled exactly `risk/low` with green CI)
|
||||||
|
but not on a direct commit to `main`, which bypassed it. This overrides rule 5's "risk/low commits straight to main"
|
||||||
|
for this repo; control code is where the lane matters.
|
||||||
|
**How:** `tbd_ship` for a one-file change, or branch -> PR -> `pr_merge` (name the `risk/low` issue); above `risk/low`
|
||||||
|
open the PR and a human merges it in the Gitea UI after review. Tags are not protected. CD jobs push image tags to
|
||||||
|
the **infra** repo with deploy keys, never to this repo's `main`. Undo (Mathias only): Settings -> Branches, or
|
||||||
|
`PATCH /repos/mathias/hyperguild/branch_protections/main {"enable_push": true}`.
|
||||||
|
|||||||
@@ -84,3 +84,15 @@ When acting as a coding agent on this project:
|
|||||||
4. Never modify files outside the project root without explicit permission
|
4. Never modify files outside the project root without explicit permission
|
||||||
5. When adding a dependency, explain why in the commit message
|
5. When adding a dependency, explain why in the commit message
|
||||||
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
6. For client projects: never send code or context to cloud APIs — use local models via LiteLLM
|
||||||
|
|
||||||
|
## `main` is protected: ship by PR (local-dev#42, decided 2026-10-08)
|
||||||
|
|
||||||
|
Gitea refuses direct pushes to `main` in this repo, and a PR merges only after its CI status (`CI / Lint / Test / Vet (pull_request)`) passes.
|
||||||
|
**Why:** local-dev rule 5's reviewed lane (risk/medium+ is reviewed by a human) was enforced on the merge tools
|
||||||
|
(`tbd_ship`, `pr_merge`: gitea-mcp v0.17.0/v0.18.0, merge only for an issue labelled exactly `risk/low` with green CI)
|
||||||
|
but not on a direct commit to `main`, which bypassed it. This overrides rule 5's "risk/low commits straight to main"
|
||||||
|
for this repo; control code is where the lane matters.
|
||||||
|
**How:** `tbd_ship` for a one-file change, or branch -> PR -> `pr_merge` (name the `risk/low` issue); above `risk/low`
|
||||||
|
open the PR and a human merges it in the Gitea UI after review. Tags are not protected. CD jobs push image tags to
|
||||||
|
the **infra** repo with deploy keys, never to this repo's `main`. Undo (Mathias only): Settings -> Branches, or
|
||||||
|
`PATCH /repos/mathias/hyperguild/branch_protections/main {"enable_push": true}`.
|
||||||
|
|||||||
@@ -159,3 +159,16 @@ func TestBuildMuxObservesRequestsAndServesMetrics(t *testing.T) {
|
|||||||
require.Equal(t, http.StatusOK, code)
|
require.Equal(t, http.StatusOK, code)
|
||||||
assert.Contains(t, body, `path="GET /pending"`)
|
assert.Contains(t, body, `path="GET /pending"`)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// hyperguild#185: an authenticated request to an unregistered path reached
|
||||||
|
// the inner REST mux, which left Pattern empty, and the metrics label fell
|
||||||
|
// back to the raw URL path: one Prometheus series per unique path any token
|
||||||
|
// holder sends. It is now labelled with a fixed catch-all.
|
||||||
|
func TestBuildMuxLabelsAnUnregisteredPathWithAFixedLabel(t *testing.T) {
|
||||||
|
r := testMux(t)
|
||||||
|
code, _ := do(t, r, "GET", "/zqrandom-185-segment", "Bearer "+routesTok)
|
||||||
|
require.Equal(t, http.StatusNotFound, code)
|
||||||
|
_, body := do(t, r, "GET", "/metrics", "")
|
||||||
|
assert.NotContains(t, body, "zqrandom-185-segment", "the raw path became a metrics label")
|
||||||
|
assert.Contains(t, body, `path="unmatched"`)
|
||||||
|
}
|
||||||
|
|||||||
@@ -83,8 +83,9 @@ func (r *Registry) Observe(path, status string, d time.Duration) {
|
|||||||
|
|
||||||
// Middleware wraps next, observing every request's duration + status.
|
// Middleware wraps next, observing every request's duration + status.
|
||||||
// The metric label `path` uses the request's Pattern (Go 1.22+ ServeMux),
|
// The metric label `path` uses the request's Pattern (Go 1.22+ ServeMux),
|
||||||
// falling back to the URL path if no Pattern is set. Pattern keeps
|
// or the fixed label "unmatched" if no Pattern is set: falling back to the
|
||||||
// cardinality bounded (one series per route, not one per unique URL).
|
// raw URL path gave any caller one series per unique path (hyperguild#185).
|
||||||
|
// Pattern keeps cardinality bounded (one series per route).
|
||||||
func (r *Registry) Middleware(next http.Handler) http.Handler {
|
func (r *Registry) Middleware(next http.Handler) http.Handler {
|
||||||
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
||||||
rec := &statusRecorder{ResponseWriter: w, code: http.StatusOK}
|
rec := &statusRecorder{ResponseWriter: w, code: http.StatusOK}
|
||||||
@@ -92,7 +93,7 @@ func (r *Registry) Middleware(next http.Handler) http.Handler {
|
|||||||
next.ServeHTTP(rec, req)
|
next.ServeHTTP(rec, req)
|
||||||
path := req.Pattern
|
path := req.Pattern
|
||||||
if path == "" {
|
if path == "" {
|
||||||
path = req.URL.Path
|
path = "unmatched"
|
||||||
}
|
}
|
||||||
r.Observe(path, statusClass(rec.code), time.Since(start))
|
r.Observe(path, statusClass(rec.code), time.Since(start))
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -71,11 +71,16 @@ func TestMiddleware_RecordsTiming(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
r := New()
|
r := New()
|
||||||
handler := r.Middleware(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
// Routed through a ServeMux, as in production: the mux sets the
|
||||||
|
// request's Pattern, which is the label (an unrouted request is
|
||||||
|
// "unmatched", hyperguild#185).
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/query", func(w http.ResponseWriter, _ *http.Request) {
|
||||||
time.Sleep(2 * time.Millisecond)
|
time.Sleep(2 * time.Millisecond)
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
_, _ = io.WriteString(w, "ok")
|
_, _ = io.WriteString(w, "ok")
|
||||||
}))
|
})
|
||||||
|
handler := r.Middleware(mux)
|
||||||
|
|
||||||
srv := httptest.NewServer(handler)
|
srv := httptest.NewServer(handler)
|
||||||
defer srv.Close()
|
defer srv.Close()
|
||||||
@@ -117,3 +122,19 @@ func TestStatusRecorder_DefaultsTo200(t *testing.T) {
|
|||||||
t.Errorf("code %d, want 200", rec.Code)
|
t.Errorf("code %d, want 200", rec.Code)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A request with no matched Pattern is labelled "unmatched", never with its
|
||||||
|
// raw URL path (unbounded cardinality, hyperguild#185).
|
||||||
|
func TestMiddleware_LabelsAnUnmatchedRequestWithAFixedLabel(t *testing.T) {
|
||||||
|
r := New()
|
||||||
|
h := r.Middleware(http.NotFoundHandler())
|
||||||
|
h.ServeHTTP(httptest.NewRecorder(), httptest.NewRequest("GET", "/zqrandom-185-unit", nil))
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
r.Handler().ServeHTTP(rec, httptest.NewRequest("GET", "/metrics", nil))
|
||||||
|
if strings.Contains(rec.Body.String(), "zqrandom-185-unit") {
|
||||||
|
t.Errorf("the raw path became a metrics label:\n%s", rec.Body.String())
|
||||||
|
}
|
||||||
|
if !strings.Contains(rec.Body.String(), `path="unmatched"`) {
|
||||||
|
t.Errorf("no unmatched label:\n%s", rec.Body.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user