* [management,proxy] Agent network: per-account LLM gateway (policy, metering, multi-provider) (#6555) * [agent-network] Shared proto, OpenAPI schema, and generated types * [agent-network] Management: store, manager, synthesizer, policy engine, provider catalog, HTTP/gRPC API Adds the account-scoped agent-network module: provider/policy/budget CRUD and store, the reverse-proxy service synthesizer, policy selection + limit enforcement, the provider catalog (incl. Vertex AI and AWS Bedrock entries), and the management HTTP + proxy gRPC surfaces. * [management] Fix agent-network proxy-peer fan-out on affected-peer recompute The affected-peers resolver loaded only persisted reverse-proxy services, but agent-network services are synthesized on demand and never persisted. As a result the embedded proxy peer was never folded into the affected set when a client's group changed, so the proxy received no network-map update for a newly authorised client and rejected its handshake until a full resync (restart). loadProxyServices now merges the synthesized agent-network services (injected via a registration hook to avoid an import cycle), so proxy peers learn newly authorised clients immediately. * [proxy] Reverse-proxy middleware framework, chain, and request plumbing The per-target middleware chain (slots, dispatcher, mutation gate, metadata merger), body capture, access-log terminal sink, and the proxy wiring that builds + runs chains for synthesized agent-network services. * [proxy] LLM parsers, pricing, and builtin middlewares (OpenAI, Anthropic, Vertex AI, AWS Bedrock) Request/response parsers and SSE/event-stream metering, the embedded pricing table, and the builtin middleware set: request parser, router, policy limit-check/record, cost meter, guardrail, identity inject, response parser. Includes the path-routed providers — Google Vertex AI (keyfile:: service-account OAuth minting) and AWS Bedrock (bearer auth, invoke/converse/streaming, optional /bedrock prefix) — plus the Models allowlist and unmeterable-publisher deny. * [proxy] IPv6 in-place apply and TCP accept-loop hardening on netstack listeners * [agent-network] End-to-end test suite, module docs, and deployment preset * [agent-network] Fix codespell typos and exclude false positives - labelgen word pool: vermillion -> vermilion, racoon -> raccoon. - codespell ignore list: add flate (Go compress/flate package), recordin (a test-local identifier), and unparseable (a valid alternative spelling used consistently across identifiers + a metadata-value constant). * [management] Set LastSeen on injected proxy peer in realstack test (MySQL strict-mode) The injected embedded proxy peer had a PeerStatus with a zero LastSeen, which serializes to '0000-00-00' and is rejected by MySQL in strict mode (SQLite tolerates it). Set LastSeen to a valid time so SaveAccount succeeds on both engines. * [agent-network] Remove e2e shell-script suite from this branch The end-to-end shell scripts under scripts/e2e/ are maintained in a separate testing suite and are not part of this change set. * [agent-network] Polish module docs: remove internal review scaffolding, fix links, verify diagrams Strip PR-review framing, commit references, absolute paths, and stale internal references from the agent-network module docs; fix broken relative links; verify all diagrams against the current architecture. Remove the internal AI-reviewer prompt file. * [management] Refine session expiration handling to support 3-state encoding for SSO deadlines * [agent-network] Relocate agentnetwork package to internals/modules Move management/server/agentnetwork (and its catalog/, labelgen/, types/ subpackages) to management/internals/modules/agentnetwork, alongside the reverse-proxy module, and rewrite all importers. Pure relocation: package names, the synthesizer + affectedpeers registration hook, and store access (shared store.Store) are unchanged, so no import cycle is introduced (affectedpeers still depends only on the agentnetwork/types leaf). * [agent-network] Co-locate HTTP handlers in the module (RegisterEndpoints) Move the agent-network HTTP handlers from server/http/handlers/agentnetwork into the module at internals/modules/agentnetwork/handlers (package handlers) and rename the entrypoint AddEndpoints -> RegisterEndpoints, matching the reverse-proxy module convention. Wiring in http/handler.go updated accordingly. * Update getting started to point to rc when agent network enabled * Add a reference to a commercial license * Fix docs localhost link * Fix docs localhost link * Add private services domain note * [management] Add agent-network telemetry metrics (#6561) Surface agent-network adoption and usage in the self-hosted metrics worker: distinct accounts, providers, policies, budget rules, accounts with log collection enabled, and aggregated input/output tokens plus cost. Tokens and cost are summed from agent_network_request_usage (the always-written per-request ledger) so the figures are accurate regardless of the log-collection toggle and carry no double-counting. All values come from a handful of indexed aggregate queries run only on the worker's periodic tick. Adds store.AgentNetworkMetrics with GetAgentNetworkMetrics on the Store interface, the SqlStore implementation, and a zero-valued FileStore stub. * Update NetBird server and proxy image versions to 0.74.0-rc.2 * [management,proxy] Reduce agent-network cognitive complexity (#6566) Address the SonarCloud quality-gate findings in new agent-network code by extracting focused helpers. No behavior change. - synthesizer.go: split buildIdentityInjectConfigJSON into per-shape rule builders; extract mergeGuardrail from mergeGuardrails to cut nesting depth. - llm_identity_inject: extract injectionEmitsAnything validation predicate from New. - llm_response_parser/streaming.go: extract applyOpenAIStreamUsage and applyAnthropicStreamUsage (via a named anthropicStreamUsage type) and simplify the OpenAI scanner loop. - reverseproxy.go: decompose ServeHTTP into serveRouteError, buildTargetContext, serveDirect, serveWithChain, captureRequestForChain, serveDeny, newResponseWriter, observeResponse, and forwardUpstream, preserving the defer ordering so response observation still reads the captured writer before it is released. * [management] Move agent-network access-log ingest into the agentnetwork module (#6568) The agent-network access-log ingest path (metaKey wire contract, flatten, usage derivation, and the dual-write of the usage ledger + settings-gated full row) lived in the reverseproxy accesslogs manager, even though the agentnetwork module already owns the rest of that domain — types, read (ListAccessLogs / GetUsageOverview), the budget-counter writes, and retention cleanup. Move it next to the rest: a stateless agentnetwork.IngestAccessLog(ctx, store, entry) that the reverseproxy SaveAccessLog delegates to when the entry is agent-network. Removes the agentNetworkTypes import from the reverseproxy manager. No behavior change; the write/read table separation is unchanged. Adds real-store coverage for the disable->enable log-collection toggle (usage ledger always written, full row gated) plus the metadata parse and group-dedup helpers, which previously had no dedicated tests. * Add session view support in the access log * [management,proxy] Container-based agent-network e2e harness (#6577) * [e2e] Add container-based agent-network e2e harness (Pillar 1) Introduce a self-contained, OIDC-free e2e harness that stands up NetBird in containers, so suites no longer depend on the hand-maintained Tilt stack or a real IdP. - harness brings up the combined server (management + signal + relay + STUN + embedded IdP) in a single container built from combined/Dockerfile.multistage, and mints an admin PAT through the unauthenticated /api/setup bootstrap (NB_SETUP_PAT_ENABLED). API access goes through the existing shared/management/client/rest typed client. - the image is built via the docker CLI (BuildKit) so the Dockerfile's cache mounts are honored; testcontainers then runs the tagged image. - everything is behind the `e2e` build tag so normal builds and unit tests never pull in testcontainers. Adds BuildKit cache mounts to combined/Dockerfile.multistage so source changes recompile incrementally rather than from scratch. Pillar 1 proven by TestCombinedBootstrap: server builds, boots, mints a PAT, and the PAT authenticates a real management API call. * [e2e] Add management-side agent-network scenarios (Pillar 2) Port the API-driven agent-network scenarios from the bash suites to Go, sharing one combined server per package run (TestMain) with each test owning its resource cleanup. Drives the /api/agent-network/* endpoints through the shared REST client's NewRequest primitive with the generated api types. Scenarios: - provider lifecycle (create/get/list/delete + 404 after delete) - provider validation (missing api_key, unknown catalog id → 4xx) - settings collection-toggle round-trip with cluster/subdomain immutability - policy window floor (reject <60s enabled limit, accept at 60s) - consumption read endpoint returns an array All deterministic and dependency-free (dummy provider keys; no upstream calls), so they run headless in CI. * [e2e] Add live chat-through-proxy scenario (Pillar 3) Stand up the full agent-network data path in containers and drive a real chat-completion through the gateway: - harness: a shared docker network (combined server reachable by alias), a proxy container built from the published reverse-proxy image (NB_PROXY_PRIVATE, NB_PROXY_ALLOW_INSECURE, NB_RELAY_TRANSPORT=ws to match the combined server's WS-multiplexed relay) with a generated self-signed wildcard cert, and a netbird client container that joins via a setup key. - the combined image, proxy image, and client image default to the published rc.2 releases (overridable via NB_E2E_*_IMAGE; a bare local tag is built from source instead). Geolocation download is disabled so the server starts without external fetches. - one shared domain is used for the management exposed address, the proxy domain, and the agent-network cluster; the proxy token is minted via the server CLI (global) to match the manual install. TestChatCompletionThroughProxy provisions provider+policy+group+setup key, runs proxy+client, drives an OpenAI chat-completion through the tunnel, and asserts a 200 plus the ingested access-log row. Requires OPENAI_TOKEN (skips otherwise). The provider must be created with enabled=true explicitly — the create default is false despite the API doc. * [e2e] Run the live chat scenario across a provider matrix Replace the single-provider chat test with a data-driven matrix that runs the same scenario through every provider whose credentials are present in the environment (keys/URLs sourced from ~/.llm-keys locally, Actions secrets in CI): - OpenAI (chat), Anthropic (messages), Vercel, OpenRouter, Cloudflare (OpenAI-compatible gateways), and Bedrock (path-routed, bearer, via the messages shape) — covering both wire shapes and the gateway routing. - all providers are created enabled with a unique model string so the proxy's connect-time snapshot carries them all and model->provider routing is unambiguous (provider toggles after connect don't reconcile to a connected proxy). - the client supports both wire shapes (/v1/chat/completions and /v1/messages); Cloudflare gets the openai provider segment appended to its gateway URL. Each provider must return 200 through the tunnel and produce an ingested access-log row. Vertex is intentionally excluded from the uniform matrix: it needs a bespoke rawPredict request shape rather than the shared chat/messages path, so it warrants a dedicated scenario. * [ci] Add manual workflow for the agent-network e2e suite The e2e suite (build tag `e2e`) stands up the combined server + proxy + client in Docker and drives live chat-completions, so it is slow and needs provider credentials. Gate it out of normal CI (it already is, via the build tag) and run it on demand via workflow_dispatch. Provider scenarios skip when their secret is unset, so it degrades gracefully. * [e2e] Add Vertex to the provider matrix; run e2e on ubuntu-latest Vertex (Anthropic-on-Vertex) doesn't share the chat/messages wire shapes: the model travels in a rawPredict path and the proxy mints the service account's OAuth token. Add a Vertex client method that posts /v1/projects/<project>/locations/<region>/publishers/anthropic/models/<model>:rawPredict with the Vertex anthropic_version body, and wire it into the matrix as a path-routed provider (created without a models array). It is keyed off GOOGLE_VERTEX_SA_BASE64 + GOOGLE_VERTEX_PROJECT (region defaults to "global", model to a pinned claude snapshot, both overridable). Also bump the e2e workflow runner to ubuntu-latest and add the Vertex secrets. * Add docker/docker and docker/go-connections as direct dependencies in go.mod * [ci] Trigger agent-network e2e workflow on push to main and pull requests * [e2e] Fix proxy cert permission denied on Linux CI runners The proxy bind-mounts a temp dir of self-signed certs. MkdirTemp creates it 0700 and the key was 0600, which Docker Desktop on macOS ignores but a non-root proxy container on Linux runners cannot traverse/read, so the cert watcher failed with "open /certs/tls.crt: permission denied" and the container exited. Widen the cert dir to 0755 and write the throwaway key 0644 so the proxy uid can read the bind-mounted material. * [e2e] Build images from source by default instead of pulling rc.2 The agent-network code under test lives in this branch, so the e2e should exercise it rather than a frozen published release. Flip the harness default: combined/proxy/client are now built from their in-repo Dockerfiles (combined/Dockerfile.multistage, proxy/Dockerfile.multistage, e2e/harness/Dockerfile.client) under local tags. Pulling a published image stays available by setting NB_E2E_*_IMAGE to a registry reference. Builds now go through buildx --load so the Dockerfile cache mounts are honored and the result is loaded for testcontainers. The CI workflow adds a container-driver builder and a local layer cache (NB_E2E_BUILDX_CACHE) persisted via actions/cache, which caches the base/apt/dep-download layers across runs. The Go compile still re-runs each time, as BuildKit mount caches cannot be exported to the GitHub cache. * [e2e] Cover real providers in lifecycle + assert real consumption metering - TestProviderLifecycle now runs per available real provider (create → get → list → delete → 404) instead of a single dummy provider, exercising each catalog's create and field round-trip. Create is offline, so it stays fast and burns no provider quota; falls back to a synthetic OpenAI provider when no keys are set. - TestProvidersMatrix attaches a token limit (high caps, 60s window) to its policy, which switches on usage metering, and asserts consumption rows are recorded with positive token counts after the live traffic. Consumption is account-scoped (keyed by source group / user and window, not per provider), so the assertion is aggregate. - TestProviderValidation gains invalid-upstream and blank-name cases. Create validation is uniform across catalogs (no per-provider required-field rules), so per-provider rejection cases would be redundant. * [e2e] Assert session id propagates per provider Each matrix request now sends a unique session id as the universal x-session-id header and asserts it round-trips into that provider's access-log row. This guards the session-grouping contract end to end for every provider (header extraction runs in llm_request_parser ahead of the parser-specific body extraction, so it is provider-agnostic). * [e2e] Drop accidentally committed sync-phases dashboard netbird-sync-phases.json was swept into the Pillar 1 commit by a broad git add; it belongs to the unrelated sync-phases metrics work, not this e2e harness. Remove it from the branch so the PR diff is scoped to the e2e changes. * [e2e] Revert accidentally committed sync-phase ingest spec The netbird_sync_phase measurement spec in metrics ingest was swept into the Pillar 1 commit; it belongs to the unrelated sync-phases metrics work, not this e2e harness. Its emission side never landed here, so the spec was orphaned anyway. Restore ingest/main.go to its origin/main state. * Fix golint issues * Fix sonar * Add access log session test * Fix access log tests --------- Co-authored-by: braginini <bangvalo@gmail.com> Co-authored-by: Zoltan Papp <zoltan.pmail@gmail.com>
20 KiB
proxy/llm-parsers — SDK adapters + pricing + SSE
The runtime-agnostic LLM library: the OpenAI Responses API (/v1/responses)
and the older Chat Completions API (/v1/chat/completions), the Anthropic
Messages API (/v1/messages), the SSE wire format (event: / data: lines,
\n\n framing, CRLF tolerance), and per-provider token accounting (OpenAI's
cached-prompt subset vs Anthropic's cache_read additive model). The
pricing table's per-provider cost formula is the highest-leverage place a
small bug would silently mis-bill operators.
Sibling module: 31-proxy-middleware-builtin.md — the 8 middlewares that consume this package's parsers + pricing loader.
Module boundary
proxy/internal/llm is the runtime-agnostic LLM library shared by every
middleware that needs to understand provider-specific shapes. Zero
proxy-framework dependencies:
parser.go—Parserinterface,Providerenum, public factories (Parsers,DetectParser,ParserByName).openai.go/anthropic.go/bedrock.go— per-providerParserimpls.sse.go— SSE scanner (Scanner,Event,NewScanner).errors.go— sentinels callers branch on witherrors.Is.pricing/— embedded-default + hot-reload override table with symlink-safe Unix loader (build-tagged stub elsewhere).fixtures/— captured request/response/stream bodies the tests replay.
The package carries zero proxy-framework dependencies so the same parsers can be reused later by a WASM adapter (parser.go:1–6).
Files
| File | LOC | Notes |
|---|---|---|
parser.go |
104 | Interface + factories + Provider{Unknown,OpenAI,Anthropic} enum |
openai.go |
347 | Chat Completions + Completions + Responses API; cached_tokens subset |
openai_test.go |
222 | 11 tests; fixture replay + cached/Responses-API matrix |
anthropic.go |
172 | Messages + legacy /v1/complete; cache_read + cache_creation additive |
anthropic_test.go |
154 | 7 tests including streaming-extraction-skipped contract |
bedrock.go |
190 | AWS Bedrock InvokeModel (snake_case) + Converse (camelCase) response shapes; model lives in URL path |
bedrock_test.go |
— | InvokeModel + Converse usage shapes; AWS event-stream content-type → ErrStreamingUnsupported on buffered ParseResponse |
sse.go |
117 | bufio-backed scanner; CRLF normalised; trailing-event handling |
sse_test.go |
175 | 12 tests; fixture replay + multiline + size limits |
parser_test.go |
53 | Parsers(), DetectParser, provider enum values |
errors.go |
31 | 6 sentinels: Err{Unknown,Unsupported}Provider/Model, Err{NotLLM,Malformed}Response, ErrStreamingUnsupported, ErrMalformedRequest |
pricing/pricing.go |
421 | Loader, Table, Entry; embedded defaults + atomic swap + mtime reload |
pricing/pricing_unix.go |
69 | O_NOFOLLOW + fstat-from-FD + 1 MiB cap |
pricing/pricing_other.go |
21 | Stub returning "not supported on this platform" |
pricing/pricing_test.go |
432 | 21 tests — symlink rejection, reload race, path traversal, oversize |
pricing/defaults_pricing.yaml |
85 | go:embed source of truth |
fixtures/* |
21–59 | OAI chat/responses/stream + Anthro messages/stream + pricing starter |
Request body → parser dispatch
flowchart TD
A[HTTP request<br/>URL + JSON body] --> B{ParserByName?<br/>provider_id config set}
B -- yes --> P[matched Parser]
B -- no --> C[DetectParser]
C --> D{loop Parsers<br/>OpenAIParser, AnthropicParser}
D -- DetectFromURL match --> P
D -- no match --> X[ok=false<br/>middleware skips]
P --> E[ParseRequest body]
E -->|err: ErrMalformedRequest| Y[middleware emits provider only]
E --> F[RequestFacts<br/>model + stream]
P --> G[ExtractPrompt body]
G --> H[joinMessages<br/>extractContentParts<br/>decodeStringOrJoin]
H --> I[prompt text<br/>or empty]
F --> J[stamps llm.model + llm.stream]
I --> K[stamps llm.request_prompt_raw<br/>subject to capture_prompt gate]
OpenAI's URL hints
(openai.go:27–33) include
both /v1/chat/completions and the bare /chat/completions — the latter
covers Cloudflare AI Gateway, which rewrites the canonical version segment.
Anthropic's hints are /v1/messages and /v1/complete
(anthropic.go:14–17).
Both implementations use case-insensitive substring matching so a proxy prefix
strip / rewrite doesn't defeat detection.
ParserByName (parser.go:93–103)
is the agent-network bypass: the synthesiser knows which parser to use
because it built the synth service from the catalog, so it stamps
provider_id on the parser config and the middleware skips URL sniffing
entirely. This is what makes the same parser set work whether the request
flows to OpenAI direct, to LiteLLM, to Portkey, or to any gateway with a
non-canonical URL shape.
Path-routed providers (Vertex AI, Bedrock) bypass both ParserByName and
DetectParser. The model and the parser surface live in the URL path, so the
request middleware extracts them directly (parseVertexPath /
parseBedrockPath) before the parser-selection step. For Vertex the publisher
segment picks the parser (anthropic → Anthropic parser; google/Gemini →
none, request denied as unmeterable). For Bedrock the dedicated BedrockParser
handles the response. Full treatment in
50-path-routed-providers.md.
Streaming response → SSE chunker → response parser → completion + token count
sequenceDiagram
participant U as upstream LLM
participant LR as llm_response_parser<br/>(OnResponse)
participant S as llm.NewScanner<br/>(SSE framer)
participant P as Parser-specific accumulator<br/>(accumulateOpenAIStream<br/>or accumulateAnthropicStream)
U-->>LR: text/event-stream<br/>(buffered prefix in RespBody)
LR->>S: NewScanner(bytes.NewReader(body))
loop until EOF or [DONE]
S-->>LR: Event{Type, Data}
LR->>P: dispatch per event.Type<br/>(OpenAI: data-only<br/>Anthropic: named events)
P-->>P: accumulate completion text<br/>track usage from final frame
end
P-->>LR: llm.Usage + completion string
LR->>LR: appendUsage stamps<br/>llm.{input,output,total,cached_input,cache_creation}_tokens
LR->>LR: truncateCompletion(3500 bytes, rune-safe)
LR->>LR: redactPII if redact_pii && captureCompletion
Scanner.Next
(sse.go:44–87) returns one
event per \n\n boundary; multiple data: lines join with \n; comment lines
(starting with :) are skipped per the SSE spec; a trailing event without a
closing blank line is still returned before io.EOF so a server that closes
the connection cleanly doesn't lose the last frame
(sse.go:55–58). CRLF is
normalised in trimEOL so fixtures captured from live servers replay
unchanged.
Per-provider
OpenAI
openai.go:54–67 defines
openAIRequest with three prompt fields: messages (Chat Completions),
prompt (legacy), input (Responses API). The decoder uses
json.RawMessage so each shape is parsed lazily.
ParseResponse
(openai.go:117–146)
accepts both naming conventions: Chat Completions returns
prompt_tokens/completion_tokens, Responses API returns
input_tokens/output_tokens. pickInt64 prefers Responses-API names and
falls back — same parser handles both endpoints without per-route config.
openAICachedTokens mirrors the fallback for
input_tokens_details.cached_tokens vs prompt_tokens_details.cached_tokens.
Key invariant: CachedInputTokens for OpenAI is a SUBSET of
InputTokens. The cost meter clamps to guard against malformed upstream
responses where cached > total.
Anthropic
anthropic.go:37–49
defines anthropicRequest covering Messages API (system + messages[])
and legacy /v1/complete (prompt string). ExtractPrompt emits
system: <text> first when present, then per-message role: content.
ParseResponse
(anthropic.go:82–104)
fills three independent token buckets: InputTokens, CacheReadInputTokens,
CacheCreationInputTokens. Latter two are additive (not subset).
TotalTokens sums all four so downstream dashboards render one "tokens"
number without double-counting.
ExtractCompletion walks content[] {type, text} parts and concatenates
non-empty text with newlines, falling back to legacy completion.
Bedrock
bedrock.go implements the
Parser interface for the AWS Bedrock runtime. Bedrock is path-routed: the
model lives in the URL (/model/{id}/{action}), so the request middleware
extracts it (see 50-path-routed-providers.md)
and ParseRequest is a deliberate no-op. The parser's real work is on the
response leg, covering both Bedrock body shapes:
- InvokeModel — vendor-native. Anthropic-on-Bedrock returns snake_case usage
(
input_tokens,output_tokens,cache_read_input_tokens,cache_creation_input_tokens) with the same additive cache buckets as first-party Anthropic. - Converse — unified camelCase (
inputTokens,outputTokens,totalTokens).firstNonZerofolds the two naming conventions into oneUsage; when Converse omitstotalTokensthe parser sums the buckets.
ProviderName() returns "bedrock" — its own defaults_pricing.yaml block,
keyed by the normalised model id (region prefix + version suffix stripped by
the request parser). ParseResponse returns ErrStreamingUnsupported for an
AWS binary event-stream content-type (application/vnd.amazon.eventstream,
isAWSEventStream) so the caller routes to the streaming accumulator instead.
SSE framing
Scanner is bufio-backed, 64 KiB read buffer, 1 MiB max line so a
malicious upstream can't blow process memory
(sse.go:33–38, 97–100).
splitField strips one space after the : per the SSE spec. Documented
not safe for concurrent use; every consumer creates a fresh scanner per
response body. Streaming accumulators live in the middleware package
(llm_response_parser/streaming.go)
but use llm.NewScanner so the framing contract stays here.
Pricing catalog
Table.Cost
(pricing.go:129–174)
is the cost formula — most security-relevant math in this module:
| Provider | Formula |
|---|---|
openai |
(inTokens − clamped) × InputPer1K + clamped × CachedInputPer1K + outTokens × OutputPer1K where clamped = min(cachedInput, inTokens) |
anthropic, bedrock |
inTokens × InputPer1K + cachedInput × CacheReadPer1K + cacheCreation × CacheCreationPer1K + outTokens × OutputPer1K |
| default | inTokens × InputPer1K + outTokens × OutputPer1K |
bedrock shares the Anthropic additive-cache formula
(pricing.go:172-174):
Anthropic-on-Bedrock reports the same additive cache buckets, while non-Anthropic
Bedrock models (Nova, Llama) simply report zero in those buckets so cost reduces
to input + output.
Each per-bucket rate falls back to InputPer1K when zero — operators opt in
to discounts by setting the field.
Loader
(pricing.go:212–268)
overlays an optional pricing.yaml from data-dir on top of the go:embed
defaults. Atomic pointer swap means readers never observe a partial update.
The mtime-poll reloader (30s default cadence) keeps the previous table on
parse failure so cost annotation never goes blank during a botched edit.
defaults_pricing.yaml is the source of truth for built-in pricing.
Operator overrides only carry the entries they want to change.
Public contracts
Parser interface
(parser.go:50–66):
type Parser interface {
Provider() Provider
ProviderName() string
DetectFromURL(path string) bool
ParseRequest(body []byte) (RequestFacts, error)
ParseResponse(status int, contentType string, body []byte) (Usage, error)
ExtractPrompt(body []byte) string
ExtractCompletion(status int, contentType string, body []byte) string
}
Adding a provider means implementing this interface and appending to the
slice returned by Parsers() (parser.go:78–84).
Order matters: DetectFromURL ties resolve by registration order.
Parsers() today returns {OpenAIParser, AnthropicParser, BedrockParser}.
Provider enum
(parser.go:8–18):
ProviderUnknown = 0, ProviderOpenAI = 1, ProviderAnthropic = 2,
ProviderBedrock = 3. Numeric values are persisted in nothing today but treat
them as wire-stable — new providers must take fresh numbers.
Pricing lookup
(pricing.go:129):
func (t *Table) Cost(provider, model string, inTokens, outTokens, cachedInput, cacheCreation int64) (float64, bool)
Nil-safe: t.Cost on a nil receiver returns (0, false)
(pricing.go:130–132).
ok=false means provider or model is absent from the loaded table; the caller
emits cost.skipped=unknown_model.
Invariants
-
Cross-platform pricing build.
pricing_unix.gocarries the only functionalloadPricing(usessyscall.O_NOFOLLOWandf.Stat()on an open descriptor — both Unix-only).pricing_other.gois a build-tag fallback that returns"not supported on this platform"(pricing_other.go:14–16). The proxy is Linux-only in production today; a Windows port needs an equivalent path-as-handle implementation. Reviewers building on Windows should expect this surface to return an error at startup if an override file is configured. -
SSE scanner handles partial chunks. A buffered prefix that doesn't end in
\n\nstill yields its accumulated event beforeio.EOF(sse.go:55–58). Tests:TestSSEScanner_OpenAIFixture,TestSSEScanner_AnthropicFixture,TestSSEScanner_MultilineData,TestSSEScanner_CRLF. The streaming accumulators ride on this:accumulateAnthropicStreamandaccumulateOpenAIStreambreakon any scanner error to return partial usage rather than aborting (streaming.go:68–73, 144–150). -
defaults_pricing.yamlis the source of truth. Compiled into the binary via//go:embed(pricing.go:29–30).DefaultTable()parses once and panics on parse failure (pricing.go:42–49) — by design: a broken embedded YAML must not ship to production. -
Loader path validation.
resolveMiddlewareDataPath(pricing.go:370–394) rejects absolute paths, traversal segments, and basenames that failbasenameRegex = ^[a-zA-Z0-9._-]+$. The resolved path must remain insidebaseDireven afterfilepath.Clean. Tests:TestNewLoader_PathValidation,TestNewLoader_PathValidation_Extended,TestNewLoader_SymlinkOutsideBaseDirRejected,TestNewLoader_SymlinkRejected. -
Unix loader symlink safety.
O_NOFOLLOWon open,f.Stat()on the open descriptor (never re-stat by path),info.Mode().IsRegular()check,io.LimitReader(f, maxPricingBytes+1)with a final size assertion (pricing_unix.go:25–57). A mid-read symlink swap is detected because the fstat is on the original fd. Test:TestNewLoader_RejectsOversizedFile_FixesM4. -
yaml.NewDecoder(...).KnownFields(true)(pricing.go:397–398) rejects YAML files that carry fields not in the schema. A typo in an operator override file fails loud instead of silently zeroing rates.
Things to scrutinise
Correctness. Verify OpenAI cached-prompt clamp at
pricing.go:147–149
short-circuits before subtraction. Anthropic.TotalTokens sums all four
buckets (in + out + cache_read + cache_creation) — downstream dashboards
need to know this differs from input + output.
OpenAIParser.ExtractPrompt falls through messages → input → prompt; a
request sending all three reports only messages (uncommon but worth
noting).
Security. Scanner.maxLine = 1 MiB; a 2 MiB single-line data: event
errors from Scanner.Next and both accumulators stop with partial usage.
Pricing file 1 MiB cap is orders of magnitude larger than realistic. Confirm
new schema additions are mirrored in both pricingFile and Entry;
KnownFields(true) will reject silently-typo'd operator overrides
otherwise.
Concurrency. Loader.table is atomic.Pointer[Table]; readers never
block or see a torn table. Loader.Reload is one goroutine, cancelled via
context (TestLoader_ReloadBackgroundLoopCancellation). DefaultTable()
uses sync.Once. Per-call Scanner instances mean no shared state across
concurrent response-parser calls.
Perf. Table.Cost is two map lookups + multiplications, O(1).
Scanner.Next is one ReadString('\n') per line. Pricing reload poll 30s.
Observability. Reload failures count via metric.Int64Counter keyed
plugin; warning log rate-limited at 5 min so a broken file doesn't flood.
Parser errors return sentinels — middleware uses errors.Is to map to the
right cost.skipped reason.
Test coverage
| File | Tests | Coverage highlights |
|---|---|---|
parser_test.go |
3 | Parsers() shape lock, DetectParser URL matrix, provider enum stability |
openai_test.go |
11 | Chat Completions + Responses API + legacy prompt; cached-tokens subset for both naming conventions; fixture replays |
anthropic_test.go |
7 | Messages + legacy /v1/complete; streaming REJECTED on ParseResponse (must use scanner); fixture replays |
sse_test.go |
12 | Fixture replay both providers; multiline data:; CRLF; comment skip; trailing-event-without-blank-line; oversize rejection |
pricing/pricing_test.go |
21 | Provider-shape switch; cached-rate fallback; cached-clamp; symlink rejection (target outside basedir + symlink to file); path validation matrix; oversize rejection; reload-keeps-previous-on-parse-error; mtime change detection; goroutine cancellation |
Fixtures (proxy/internal/llm/fixtures/):
openai_chat_completion.json (chat.completions with usage),
openai_responses.json (Responses API shape),
openai_stream.txt (3 deltas + usage + [DONE]),
anthropic_messages.json (Messages API non-streaming),
anthropic_stream.txt (full 7-event sequence: message_start →
content_block_{start,delta×2,stop} → message_delta (usage) → message_stop),
pricing.yaml (realistic-pricing starter for operator overrides).
Cross-references
- Sibling: 31-proxy-middleware-builtin.md
— the chain that calls
llm.Parsers(),llm.ParserByName,llm.NewScanner,pricing.NewLoader. - Path-routed providers (Vertex AI + Bedrock), credential syntax, and the Bedrock AWS event-stream accumulator: 50-path-routed-providers.md.
- Direct callers:
llm_request_parser/middleware.go:82–94,llm_response_parser/middleware.go:113–123,llm_response_parser/streaming.go:65, 142,cost_meter/factory.go:49–57. - Related elsewhere: the agent-network synthesiser stamping
provider_idis covered in the management-side module guide; proxy server boot +FactoryContextconstruction is covered in the proxy-framework guide.