Documentation
¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cli is the built-in command line: its commands and the terminal output they write.
|
Package cli is the built-in command line: its commands and the terminal output they write. |
|
terminal
Package terminal styles command output for terminals.
|
Package terminal styles command output for terminals. |
|
Package comparison normalises payloads with scripts, then diffs or hashes them.
|
Package comparison normalises payloads with scripts, then diffs or hashes them. |
|
javascript
Package javascript evaluates Spectre payload normaliser scripts.
|
Package javascript evaluates Spectre payload normaliser scripts. |
|
Package descriptors loads the protobuf descriptors that gRPC and Connect wire decoding uses.
|
Package descriptors loads the protobuf descriptors that gRPC and Connect wire decoding uses. |
|
Package future provides a value that one goroutine sets once and others wait for.
|
Package future provides a value that one goroutine sets once and others wait for. |
|
Package httpserver serves HTTP ingress and egress points for the protocol engine.
|
Package httpserver serves HTTP ingress and egress points for the protocol engine. |
|
codec
Package codec decodes gRPC, Connect, and bare protobuf payloads to JSON.
|
Package codec decodes gRPC, Connect, and bare protobuf payloads to JSON. |
|
message
Package message decodes HTTP requests and responses into engine messages.
|
Package message decodes HTTP requests and responses into engine messages. |
|
middleware/health
Package health provides HTTP liveness and readiness middleware.
|
Package health provides HTTP liveness and readiness middleware. |
|
middleware/logging
Package logging provides structured HTTP request logging middleware.
|
Package logging provides structured HTTP request logging middleware. |
|
route
Package route matches HTTP requests against net/http.ServeMux patterns.
|
Package route matches HTTP requests against net/http.ServeMux patterns. |
|
Package jsonschema generates TypeScript schema declarations from JSON Schema.
|
Package jsonschema generates TypeScript schema declarations from JSON Schema. |
|
Package logger configures structured logging and carries loggers through contexts.
|
Package logger configures structured logging and carries loggers through contexts. |
|
Package model is SPECTRE's data model: the traffic that crosses a service's boundary through its proxies, and why a candidate was quarantined.
|
Package model is SPECTRE's data model: the traffic that crosses a service's boundary through its proxies, and why a candidate was quarantined. |
|
Package netaddr parses listen and backend addresses and opens or dials them.
|
Package netaddr parses listen and backend addresses and opens or dials them. |
|
Package protocol pairs the reference and candidate traffic that protocol servers report, compares ingress responses, and replays egress responses.
|
Package protocol pairs the reference and candidate traffic that protocol servers report, compares ingress responses, and replays egress responses. |
|
Package proxy admits candidate work and budgets shared memory for every protocol.
|
Package proxy admits candidate work and budgets shared memory for every protocol. |
|
Package sample provides a Connect service for ingress experiments.
|
Package sample provides a Connect service for ingress experiments. |
|
Package scaffold sets a service up for SPECTRE by rendering a template from a template repository into the spectre directory of its checkout with scaffolder.
|
Package scaffold sets a service up for SPECTRE by rendering a template from a template repository into the spectre directory of its checkout with scaffolder. |
|
Package schema models the payload types that normalisers and protocols share.
|
Package schema models the payload types that normalisers and protocols share. |
|
Package server is the SPECTRE server, which collects the quarantines that mirrors report.
|
Package server is the SPECTRE server, which collects the quarantines that mirrors report. |
|
client
Package client calls the SPECTRE server.
|
Package client calls the SPECTRE server. |
|
reporter
Package reporter reports a mirror's quarantines to the SPECTRE server.
|
Package reporter reports a mirror's quarantines to the SPECTRE server. |
|
storage
Package storage keeps the divergences that mirrors report to the SPECTRE server.
|
Package storage keeps the divergences that mirrors report to the SPECTRE server. |
|
wire
Package wire converts between the SPECTRE service protocol and the domain model, so only the server's API boundary handles protocol messages.
|
Package wire converts between the SPECTRE service protocol and the domain model, so only the server's API boundary handles protocol messages. |
|
Package state describes a service's migration state: the modules a migration moves, the IO each performs, and how far each has got.
|
Package state describes a service's migration state: the modules a migration moves, the IO each performs, and how far each has got. |
|
Package supervisor runs a candidate and reference service behind the SPECTRE proxies, sandboxing the candidate's egress and splitting host resources with cgroups.
|
Package supervisor runs a candidate and reference service behind the SPECTRE proxies, sandboxing the candidate's egress and splitting host resources with cgroups. |
Click to show internal directories.
Click to hide internal directories.