faults

Documentation

Index

• Constants
• type Assertion
  • func (a Assertion) Validate() error
• type AssertionTarget
  • func (t AssertionTarget) Validate() error
• type Contract
  • func Load(path string) (Contract, error)
  • func (c Contract) Validate() error
• type Fault
  • func (f Fault) Validate() error
• type Profile
• type Selector
  • func (s Selector) Validate() error

Constants

const (
	TypeCorrelatedFailureDomain   = "correlated_failure_domain"
	TypeEdgeFailStop              = "edge_fail_stop"
	TypeEdgePartialDegradation    = "edge_partial_degradation"
	TypeServicePartialDegradation = "service_partial_degradation"
)

const (
	MetricExpectedSuccessRate      = "expected_success_rate"
	MetricMaxAmplificationFactor   = "max_amplification_factor"
	MetricTimeoutMismatchCount     = "timeout_mismatch_count"
	MetricBlastRadiusServiceCount  = "blast_radius_service_count"
	MetricBlastRadiusEndpointCount = "blast_radius_endpoint_count"
)

const (
	TargetEndpoint = "endpoint"
	TargetPath     = "path"
	TargetEdge     = "edge"
	TargetProfile  = "profile"
)

const SchemaVersion = "1.0"

Types

type Assertion

type Assertion struct {
	Metric string          `json:"metric" yaml:"metric"`
	Target AssertionTarget `json:"target" yaml:"target"`
	Op     string          `json:"op" yaml:"op"`
	Value  float64         `json:"value" yaml:"value"`
}

func (Assertion) Validate

func (a Assertion) Validate() error

type AssertionTarget

type AssertionTarget struct {
	Type       string   `json:"type" yaml:"type"`
	EndpointID string   `json:"endpoint_id,omitempty" yaml:"endpoint_id,omitempty"`
	Services   []string `json:"services,omitempty" yaml:"services,omitempty"`
	EdgeID     string   `json:"edge_id,omitempty" yaml:"edge_id,omitempty"`
}

func (AssertionTarget) Validate

func (t AssertionTarget) Validate() error

type Contract

type Contract struct {
	SchemaVersion string             `json:"schema_version" yaml:"schema_version"`
	Profiles      map[string]Profile `json:"profiles" yaml:"profiles"`
}

func Load

func Load(path string) (Contract, error)

func (Contract) Validate

func (c Contract) Validate() error

type Fault

type Fault struct {
	Type                string                `json:"type" yaml:"type"`
	Selector            Selector              `json:"selector" yaml:"selector"`
	OnlyFailureEligible bool                  `json:"only_failure_eligible,omitempty" yaml:"only_failure_eligible,omitempty"`
	ErrorRate           *float64              `json:"error_rate,omitempty" yaml:"error_rate,omitempty"`
	LatencyMS           *model.LatencySummary `json:"latency_ms,omitempty" yaml:"latency_ms,omitempty"`
}

func (Fault) Validate

func (f Fault) Validate() error

type Profile

type Profile struct {
	Faults     []Fault     `json:"faults,omitempty" yaml:"faults,omitempty"`
	Assertions []Assertion `json:"assertions,omitempty" yaml:"assertions,omitempty"`
}

type Selector

type Selector struct {
	ServiceIDs         []string          `json:"service_ids,omitempty" yaml:"service_ids,omitempty"`
	ServiceLabels      map[string]string `json:"service_labels,omitempty" yaml:"service_labels,omitempty"`
	PlacementLabels    map[string]string `json:"placement_labels,omitempty" yaml:"placement_labels,omitempty"`
	SharedResourceRefs []string          `json:"shared_resource_refs,omitempty" yaml:"shared_resource_refs,omitempty"`
	EdgeIDs            []string          `json:"edge_ids,omitempty" yaml:"edge_ids,omitempty"`
}

func (Selector) Validate

func (s Selector) Validate() error