registry

Documentation

Index

• func NewIndicatorDocumentsHandler(store *DocumentStore) http.HandlerFunc
• func NewRegisterHandler(store *DocumentStore) http.HandlerFunc
• func NewWebServer(c WebServerConfig) (func() error, func() error, error)
• func ToIndicatorDocument(d APIV0Document) indicator.Document
• type APIClient
  • func NewAPIClient(serverURL string, client *http.Client) APIClient
• type APIV0Alert
• type APIV0Document
  • func ToAPIV0Document(doc indicator.Document) APIV0Document
• type APIV0Indicator
• type APIV0Layout
• type APIV0Presentation
• type APIV0Product
• type APIV0Section
• type APIV0Threshold
• type Agent
  • func (a Agent) Start()
• type DocumentFinder
  • func (df DocumentFinder) FindAll() ([]document, error)
• type DocumentStore
  • func NewDocumentStore(timeout time.Duration) *DocumentStore
  • func (d *DocumentStore) AllDocuments() []indicator.Document
  • func (d *DocumentStore) AllPatches() []indicator.Patch
  • func (d *DocumentStore) UpsertDocument(doc indicator.Document)
  • func (d *DocumentStore) UpsertPatches(patchList PatchList)
• type PatchList
• type WebServerConfig

Functions

func NewIndicatorDocumentsHandler

func NewIndicatorDocumentsHandler(store *DocumentStore) http.HandlerFunc

func NewRegisterHandler

func NewRegisterHandler(store *DocumentStore) http.HandlerFunc

func NewWebServer

func NewWebServer(c WebServerConfig) (func() error, func() error, error)

func ToIndicatorDocument

func ToIndicatorDocument(d APIV0Document) indicator.Document

Types

type APIClient

type APIClient interface {
	IndicatorDocuments() ([]APIV0Document, error)
}

func NewAPIClient

func NewAPIClient(serverURL string, client *http.Client) APIClient

type APIV0Alert

type APIV0Alert struct {
	For  string `json:"for"`
	Step string `json:"step"`
}

type APIV0Document

type APIV0Document struct {
	APIVersion string            `json:"apiVersion"`
	Product    APIV0Product      `json:"product"`
	Metadata   map[string]string `json:"metadata"`
	Indicators []APIV0Indicator  `json:"indicators"`
	Layout     APIV0Layout       `json:"layout"`
}

func ToAPIV0Document

func ToAPIV0Document(doc indicator.Document) APIV0Document

type APIV0Indicator

type APIV0Indicator struct {
	Name          string             `json:"name"`
	PromQL        string             `json:"promql"`
	Thresholds    []APIV0Threshold   `json:"thresholds"`
	Alert         APIV0Alert         `json:"alert"`
	Documentation map[string]string  `json:"documentation,omitempty"`
	Presentation  *APIV0Presentation `json:"presentation"`
}

type APIV0Layout

type APIV0Layout struct {
	Title       string         `json:"title"`
	Description string         `json:"description"`
	Sections    []APIV0Section `json:"sections"`
	Owner       string         `json:"owner"`
}

type APIV0Presentation

type APIV0Presentation struct {
	ChartType    string   `json:"chartType"`
	CurrentValue bool     `json:"currentValue"`
	Frequency    float64  `json:"frequency"`
	Labels       []string `json:"labels"`
}

type APIV0Product

type APIV0Product struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type APIV0Section

type APIV0Section struct {
	Title       string   `json:"title"`
	Description string   `json:"description"`
	Indicators  []string `json:"indicators"`
}

type APIV0Threshold

type APIV0Threshold struct {
	Level    string  `json:"level"`
	Operator string  `json:"operator"`
	Value    float64 `json:"value"`
}

type Agent

type Agent struct {
	RegistryURI    string
	IntervalTime   time.Duration
	DocumentFinder DocumentFinder
	Client         *http.Client
}

func (Agent) Start

func (a Agent) Start()

type DocumentFinder

type DocumentFinder struct {
	Glob string
}

func (DocumentFinder) FindAll

func (df DocumentFinder) FindAll() ([]document, error)

type DocumentStore

type DocumentStore struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewDocumentStore

func NewDocumentStore(timeout time.Duration) *DocumentStore

func (*DocumentStore) AllDocuments

func (d *DocumentStore) AllDocuments() []indicator.Document

func (*DocumentStore) AllPatches

func (d *DocumentStore) AllPatches() []indicator.Patch

func (*DocumentStore) UpsertDocument

func (d *DocumentStore) UpsertDocument(doc indicator.Document)

func (*DocumentStore) UpsertPatches

func (d *DocumentStore) UpsertPatches(patchList PatchList)

type PatchList

type PatchList struct {
	Source  string
	Patches []indicator.Patch
}

type WebServerConfig

type WebServerConfig struct {
	Address       string
	ServerPEMPath string
	ServerKeyPath string
	RootCAPath    string
	*DocumentStore
}