tools

type AlertDecisionProvider interface {
	AlertDecision(context.Context, tenancy.OrgScope, string) (AlertDecisionSnapshot, error)
}

type AlertDecisionSnapshot struct {
	Identifier   string     `json:"identifier"`
	Found        bool       `json:"found"`
	DecisionType string     `json:"decision_type,omitempty"`
	Status       string     `json:"status,omitempty"`
	Action       string     `json:"action,omitempty"`
	Outcome      string     `json:"outcome,omitempty"`
	ReasonKnown  bool       `json:"reason_known"`
	Reason       string     `json:"reason,omitempty"`
	Evidence     []string   `json:"evidence,omitempty"`
	Provenance   string     `json:"provenance,omitempty"`
	Timestamp    *time.Time `json:"timestamp,omitempty"`
	Rule         string     `json:"rule,omitempty"`
	Fingerprint  string     `json:"fingerprint,omitempty"`
}

type CapabilityStatus struct {
	Name        string `json:"name"`
	Group       string `json:"group,omitempty"`
	Configured  bool   `json:"configured"`
	Licensed    string `json:"licensed"`
	Available   string `json:"available"`
	Reason      string `json:"reason,omitempty"`
	Observation string `json:"observation,omitempty"`
	SetupAction string `json:"setup_action,omitempty"`
}

type CapabilityStatusProvider interface {
	CapabilityStatuses(tenancy.OrgScope) []CapabilityStatus
}

type CatalogPageOptions struct {
	Offset  int
	Limit   int
	Search  string
	Service string
}

type CategoryHealth struct {
	Kind       string `json:"kind"`
	Configured bool   `json:"configured"`
	Dark       bool   `json:"dark"`
}

type DetectionHealthReader interface {
	DetectionHealth(tenancy.OrgScope) DetectionHealthSnapshot
}

type DetectionHealthSnapshot struct {
	Sources     []SourceHealth   `json:"sources"`
	Categories  []CategoryHealth `json:"categories"`
	Observation string           `json:"observation"`
}

type GetAlertDecision struct {
	Provider AlertDecisionProvider
	Scope    tenancy.OrgScope
	Redactor LineRedactor
}

type GetDetectionHealth struct {
	Reader DetectionHealthReader
	Scope  tenancy.OrgScope
}

type GetIncident struct {
	Store    storage.Provider
	Scope    tenancy.OrgScope
	Redactor LineRedactor
}

type GetPattern struct {
	Catalog  PatternCatalog
	Redactor LineRedactor
}

type GetService struct {
	Catalog     PatternCatalog
	Redactor    LineRedactor
	Reliability ServiceReliabilityProvider
	Scope       tenancy.OrgScope
}

type GetSystemOverview struct {
	Store   storage.Provider
	Scope   tenancy.OrgScope
	Catalog PagedPatternCatalog
	Health  DetectionHealthReader
}

type LineRedactor interface {
	Scrub(string) string
}

type ListAnalyses struct {
	Store    storage.Provider
	Scope    tenancy.OrgScope
	Redactor LineRedactor
}

type ListCapabilities struct{ Capabilities []CapabilityStatus }

type ListPatterns struct {
	Catalog  PagedPatternCatalog
	Redactor LineRedactor
}

type ListServices struct {
	Store   storage.Provider
	Scope   tenancy.OrgScope
	Catalog PagedPatternCatalog
}

type PagedPatternCatalog interface {
	PatternsPage(CatalogPageOptions) ([]*PatternView, int, error)
	ServicesPage(CatalogPageOptions) ([]ServiceRow, int, error)
}

type PatternCatalog interface {
	Get(id string) *PatternView
	All() []*PatternView
	AllServices() map[string]ServiceInfo
}

type PatternView struct {
	ID        string
	Template  string
	Source    string
	Service   string
	RuleName  string
	Verdict   string
	Tags      []string
	Count     int
	Baseline  float64
	FirstSeen time.Time
	LastSeen  time.Time
	Samples   []string
	// AutoPromoteAfter is the effective sighting threshold used by the
	// owning catalog. Zero means the threshold is unavailable.
	AutoPromoteAfter int
}

type SearchIncidents struct {
	Store    storage.Provider
	Scope    tenancy.OrgScope
	Redactor LineRedactor
}

type ServiceIndicator struct {
	Name        string   `json:"name"`
	Kind        string   `json:"kind,omitempty"`
	Description string   `json:"description,omitempty"`
	Current     *float64 `json:"current,omitempty"`
	Unit        string   `json:"unit,omitempty"`
}

type ServiceInfo struct {
	FirstSeen time.Time
}

type ServiceObjective struct {
	Name       string  `json:"name"`
	SLI        string  `json:"sli"`
	Target     float64 `json:"target"`
	WindowDays int     `json:"window_days,omitempty"`
	Derived    bool    `json:"derived,omitempty"`
}

type ServiceReliabilityProvider interface {
	ServiceReliability(context.Context, tenancy.OrgScope, string) (ServiceReliabilitySnapshot, error)
}

type ServiceReliabilitySnapshot struct {
	Service     string             `json:"service"`
	SLIs        []ServiceIndicator `json:"slis"`
	SLOs        []ServiceObjective `json:"slos"`
	Source      string             `json:"source,omitempty"`
	Observation string             `json:"observation,omitempty"`
	Configured  bool               `json:"configured"`
	Licensed    string             `json:"licensed"`
	Available   string             `json:"available"`
	Reason      string             `json:"reason,omitempty"`
	SetupAction string             `json:"setup_action,omitempty"`
}

type ServiceRow struct {
	Name string
	Info ServiceInfo
}

type SourceHealth struct {
	Name               string     `json:"name"`
	Kind               string     `json:"kind"`
	Configured         bool       `json:"configured"`
	Observation        string     `json:"observation"`
	LastSuccessfulPull *time.Time `json:"last_successful_pull,omitempty"`
	ErrorClass         string     `json:"error_class,omitempty"`
}