model

Documentation

Index

• func WriteToFile(path string, mdl ResilienceModel) error
• type BackoffPolicy
• type CircuitBreakerPolicy
• type CommonMetadata
• type Edge
• type EdgeKind
• type EdgeMetadata
• type Endpoint
• type EndpointMetadata
• type LatencySummary
• type Metadata
• type ObservedEdge
• type Placement
• type PolicyScope
• type ResilienceModel
  • func LoadFromFile(path string) (ResilienceModel, error)
  • func (m ResilienceModel) SortedEndpointIDs() []string
  • func (m ResilienceModel) Validate() error
• type ResiliencePolicy
• type RetryPolicy
• type Schema
• type Service
• type ServiceMetadata

Functions

func WriteToFile

func WriteToFile(path string, mdl ResilienceModel) error

Types

type BackoffPolicy

type BackoffPolicy struct {
	InitialMS  int     `json:"initial_ms,omitempty"`
	MaxMS      int     `json:"max_ms,omitempty"`
	Multiplier float64 `json:"multiplier,omitempty"`
	Jitter     string  `json:"jitter,omitempty"`
}

type CircuitBreakerPolicy

type CircuitBreakerPolicy struct {
	Enabled            *bool `json:"enabled,omitempty"`
	MaxPendingRequests int   `json:"max_pending_requests,omitempty"`
	MaxRequests        int   `json:"max_requests,omitempty"`
	MaxConnections     int   `json:"max_connections,omitempty"`
	Consecutive5xx     int   `json:"consecutive_5xx,omitempty"`
	IntervalMS         int   `json:"interval_ms,omitempty"`
	BaseEjectionTimeMS int   `json:"base_ejection_time_ms,omitempty"`
}

type CommonMetadata

type CommonMetadata struct {
	Labels     map[string]string `json:"labels,omitempty"`
	Tags       []string          `json:"tags,omitempty"`
	SLORefs    []string          `json:"slo_refs,omitempty"`
	Attributes map[string]string `json:"attributes,omitempty"`
}

type Edge

type Edge struct {
	ID          string            `json:"id,omitempty"`
	From        string            `json:"from"`
	To          string            `json:"to"`
	Kind        EdgeKind          `json:"kind"`
	Blocking    bool              `json:"blocking"`
	Metadata    *EdgeMetadata     `json:"metadata,omitempty"`
	Resilience  *ResiliencePolicy `json:"resilience,omitempty"`
	Observed    *ObservedEdge     `json:"observed,omitempty"`
	PolicyScope *PolicyScope      `json:"policy_scope,omitempty"`
}

type EdgeKind

type EdgeKind string

const (
	EdgeKindSync  EdgeKind = "sync"
	EdgeKindAsync EdgeKind = "async"
)

type EdgeMetadata

type EdgeMetadata struct {
	CommonMetadata
	Weight *float64 `json:"weight,omitempty"`
}

type Endpoint

type Endpoint struct {
	ID                  string                 `json:"id"`
	EntryService        string                 `json:"entry_service"`
	SuccessPredicateRef string                 `json:"success_predicate_ref"`
	SuccessPredicate    *predicates.Definition `json:"success_predicate,omitempty"`
	Method              string                 `json:"method,omitempty"`
	Path                string                 `json:"path,omitempty"`
	Metadata            *EndpointMetadata      `json:"metadata,omitempty"`
}

type EndpointMetadata

type EndpointMetadata struct {
	CommonMetadata
	Weight *float64 `json:"weight,omitempty"`
}

type LatencySummary

type LatencySummary struct {
	P50 float64 `json:"p50,omitempty"`
	P90 float64 `json:"p90,omitempty"`
	P95 float64 `json:"p95,omitempty"`
	P99 float64 `json:"p99,omitempty"`
}

type Metadata

type Metadata struct {
	SourceType      string  `json:"source_type"`
	SourceRef       string  `json:"source_ref"`
	DiscoveredAt    string  `json:"discovered_at"`
	Confidence      float64 `json:"confidence"`
	TopologyVersion string  `json:"topology_version,omitempty"`
	Schema          Schema  `json:"schema"`
}

type ObservedEdge

type ObservedEdge struct {
	LatencyMS *LatencySummary `json:"latency_ms,omitempty"`
	ErrorRate *float64        `json:"error_rate,omitempty"`
}

type Placement

type Placement struct {
	Replicas int               `json:"replicas"`
	Labels   map[string]string `json:"labels,omitempty"`
}

type PolicyScope

type PolicyScope struct {
	SourceEndpointID string `json:"source_endpoint_id,omitempty"`
	SourceRoute      string `json:"source_route,omitempty"`
	Method           string `json:"method,omitempty"`
	Operation        string `json:"operation,omitempty"`
}

type ResilienceModel

type ResilienceModel struct {
	Services        []Service                        `json:"services"`
	Edges           []Edge                           `json:"edges"`
	Endpoints       []Endpoint                       `json:"endpoints"`
	Predicates      map[string]predicates.Definition `json:"predicates,omitempty"`
	EndpointWeights map[string]float64               `json:"endpoint_weights,omitempty"`
	Metadata        Metadata                         `json:"metadata"`
}

func LoadFromFile

func LoadFromFile(path string) (ResilienceModel, error)

func (ResilienceModel) SortedEndpointIDs

func (m ResilienceModel) SortedEndpointIDs() []string

func (ResilienceModel) Validate

func (m ResilienceModel) Validate() error

type ResiliencePolicy

type ResiliencePolicy struct {
	RequestTimeoutMS int                   `json:"request_timeout_ms,omitempty"`
	PerTryTimeoutMS  int                   `json:"per_try_timeout_ms,omitempty"`
	Retry            *RetryPolicy          `json:"retry,omitempty"`
	CircuitBreaker   *CircuitBreakerPolicy `json:"circuit_breaker,omitempty"`
}

type RetryPolicy

type RetryPolicy struct {
	MaxAttempts int            `json:"max_attempts,omitempty"`
	BudgetCap   float64        `json:"budget_cap,omitempty"`
	RetryOn     []string       `json:"retry_on,omitempty"`
	Backoff     *BackoffPolicy `json:"backoff,omitempty"`
}

type Schema

type Schema struct {
	Name    string `json:"name"`
	Version string `json:"version"`
	URI     string `json:"uri"`
	Digest  string `json:"digest"`
}

type Service

type Service struct {
	ID       string           `json:"id"`
	Name     string           `json:"name"`
	Replicas int              `json:"replicas"`
	Metadata *ServiceMetadata `json:"metadata,omitempty"`
}

type ServiceMetadata

type ServiceMetadata struct {
	CommonMetadata
	FailureEligible    *bool       `json:"failure_eligible,omitempty"`
	Placements         []Placement `json:"placements,omitempty"`
	SharedResourceRefs []string    `json:"shared_resource_refs,omitempty"`
}