Documentation
¶
Overview ¶
Package model is SPECTRE's data model: the traffic that crosses a service's boundary through its proxies, and why a candidate was quarantined.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Direction ¶
type Direction string
Direction names the proxy that carries traffic: ingress into the service, or egress from it to a dependency.
type Divergence ¶
type Divergence struct {
Service string `json:"service"`
Environment string `json:"environment"`
// Revision is the commit of the candidate the mirror ran.
Revision string `json:"revision"`
// Direction is the proxy that quarantined the candidate.
Direction Direction `json:"direction"`
Quarantine Quarantine `json:"quarantine"`
}
Divergence is the latest quarantine that the mirror of a service environment reported for one of its directions. It outlives the mirror run.
type DivergenceFilter ¶
type DivergenceFilter struct {
Service Option[string]
Environment Option[string]
Revision Option[string]
// Node matches only quarantines on routes of that migration state node.
Node Option[string]
}
DivergenceFilter selects mirror states and divergences. An absent field matches every value.
func (DivergenceFilter) Matches ¶
func (f DivergenceFilter) Matches(divergence Divergence) bool
Matches reports whether divergence passes every field of the filter.
func (DivergenceFilter) MatchesState ¶ added in v0.47.0
func (f DivergenceFilter) MatchesState(state State) bool
MatchesState reports whether state passes every field of the filter. A node filter needs one of its quarantines to match.
type Protocol ¶
type Protocol string
Protocol names the protocol that a proxy intercepts, e.g. "http".
const ProtocolHTTP Protocol = "http"
ProtocolHTTP is the protocol of HTTP servers, including gRPC and Connect.
type Quarantine ¶
type Quarantine struct {
Reason QuarantineReason `json:"reason"` //nolint:narrowdeps // Other packages read the whole reason.
Since time.Time `json:"since"`
}
Quarantine is a quarantine in effect: why it began and when.
type QuarantineKind ¶
type QuarantineKind string
QuarantineKind is why the candidate was quarantined.
const ( // QuarantineDivergent means the candidate's responses differ from the reference's. QuarantineDivergent QuarantineKind = "divergent" // QuarantineUnable means the mirror could not compare or replay traffic. QuarantineUnable QuarantineKind = "unable" // QuarantineUnmatched means the candidate made a dependency request the reference did not. QuarantineUnmatched QuarantineKind = "unmatched" // QuarantineUnlisted means an ingress route is in no node of the migration state. QuarantineUnlisted QuarantineKind = "unlisted" // QuarantineCapacity means candidate work exceeded a concurrency or buffer limit. QuarantineCapacity QuarantineKind = "capacity" // QuarantinePairing means the mirror could not pair candidate and reference traffic. QuarantinePairing QuarantineKind = "pairing" )
type QuarantineReason ¶
type QuarantineReason struct {
Kind QuarantineKind `json:"kind"`
// Traffic is the request that triggered quarantine.
Traffic Option[Traffic] `json:"traffic,omitzero"`
// Node is the migration state node that owns an ingress route.
Node Option[string] `json:"node,omitzero"`
// Differences are the field paths of a divergence, without values.
Differences []string `json:"differences,omitempty"`
Detail string `json:"detail,omitempty"`
}
QuarantineReason is why the candidate was quarantined. Detail and Differences must never quote payload values, because reasons are reported outside the mirror.
func (QuarantineReason) String ¶
func (r QuarantineReason) String() string
String describes the reason for logs.
type Route ¶
type Route string
Route is a protocol's canonical request route, e.g. "GET forecasts.example/v1/forecasts/{location}". Equal routes must have identical text, because egress pairing hashes it.
type State ¶ added in v0.47.0
type State struct {
Service string `json:"service"`
Environment string `json:"environment"`
// Revision is the commit of the candidate the mirror runs.
Revision string `json:"revision"`
SpectreVersion string `json:"spectre_version"`
// Uptime is how long the mirror has run. Without quarantines, the candidate
// has been healthy that long, because quarantine lasts for the process.
Uptime time.Duration `json:"uptime"`
// Quarantines holds the quarantine of each direction whose proxy has one.
Quarantines map[Direction]Quarantine `json:"quarantines,omitempty"`
}
State is what the mirror of a service environment runs and holds, as its latest heartbeat reported it.
type Traffic ¶
type Traffic struct {
Direction Direction `json:"direction"`
Protocol Protocol `json:"protocol"`
Route Route `json:"route"`
}
Traffic identifies one request route of a kind of IO.
func (*Traffic) UnmarshalJSON ¶
UnmarshalJSON rejects unknown fields. Option decodes with json.Unmarshal, so a reason's traffic must enforce strict decoding itself.
Source Files