alerts

type Duration time.Duration

type Event struct {
	Kind  string `json:"event"`
	Scope string `json:"kind,omitempty"`
	// Target is the board, or for a site only its public IP.
	Target Target `json:"target"`
	// Site is the public IP of a site event and Members its visors.
	Site           string    `json:"site,omitempty"`
	Members        []Target  `json:"members,omitempty"`
	Since          time.Time `json:"offline_since,omitzero"`
	At             time.Time `json:"at"`
	Diagnosis      string    `json:"diagnosis,omitempty"`
	RecoveryReason string    `json:"recovery_reason,omitempty"`
	Warnings       []string  `json:"warnings,omitempty"`
}

type MX struct {
	Host string
	Pref uint16
}

type PushKeys struct {
	P256DH string `json:"p256dh,omitempty"`
	Auth   string `json:"auth,omitempty"`
}

type PushPayload struct {
	Title   string    `json:"title"`
	Body    string    `json:"body"`
	Event   string    `json:"event"`
	PK      string    `json:"pk,omitempty"`
	Watcher string    `json:"watcher"`
	At      time.Time `json:"at"`
	// Tag groups the notifications of one visor or site.
	Tag string `json:"tag"`
}

type PushSubscription struct {
	ID       string    `json:"id,omitempty"`
	Endpoint string    `json:"endpoint"`
	Keys     PushKeys  `json:"keys"`
	Label    string    `json:"label,omitempty"`
	Created  time.Time `json:"created,omitzero"`
	// ExpirationTime is the browser's, in ms since the epoch, if any.
	ExpirationTime *int64 `json:"expirationTime,omitempty"`
}

type Result struct {
	Channel string `json:"channel"`
	Target  string `json:"target"`
	Err     string `json:"error,omitempty"`
	// contains filtered or unexported fields
}

type SMTP struct {
	Host     string `json:"host"`
	Port     int    `json:"port,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	StartTLS bool   `json:"starttls,omitempty"`
	// PasswordSet is only set in reads, which never carry the password.
	PasswordSet bool `json:"password_set,omitempty"`
}

type Saved struct {
	Since   time.Time `json:"since,omitzero"`
	Site    string    `json:"site,omitempty"`
	Storage []string  `json:"storage,omitempty"`
	// Lost is when the link lost alert's outage began.
	Lost time.Time `json:"lost,omitzero"`
}

type Sender struct {
	// Watcher is the public key of the visor doing the watching.
	Watcher cipher.PubKey
	// Hostname is the watcher's host name, for the default sender address.
	Hostname string
	// LookupMX and MXPort are overridable for tests. Defaults are the
	// system resolver and 25.
	LookupMX func(ctx context.Context, domain string) ([]*MX, error)
	MXPort   int
	// TLSConfig is used for STARTTLS and implicit TLS. Nil verifies the
	// server name against the system roots.
	TLSConfig *tls.Config
	// HTTPClient posts webhooks and pushes. Nil is a client with a 15s
	// timeout.
	HTTPClient *http.Client
	// VAPID signs Web Push requests (RFC 8292). Nil sends no pushes.
	VAPID *ecdsa.PrivateKey
}

type Service struct {
	Sender *Sender
	// Targets returns the current liveness of every watched visor.
	Targets func(ctx context.Context, s Settings) []Target
	// Probe asks the visor via to check whether ip answers on its LAN.
	// Nil skips the LAN check.
	Probe func(ctx context.Context, via cipher.PubKey, ip string) (bool, error)
	// Self is the watching visor, a LAN neighbor when it shares a site.
	// Nil means it is never one.
	Self func() Target
	// Logf logs delivery failures. Nil discards.
	Logf func(format string, args ...any)
	// contains filtered or unexported fields
}

type Settings struct {
	EmailTo      []string        `json:"email_to,omitempty"`
	OfflineAfter Duration        `json:"offline_after,omitempty"`
	SMTP         *SMTP           `json:"smtp,omitempty"`
	Webhook      string          `json:"webhook,omitempty"`
	Watch        []cipher.PubKey `json:"watch,omitempty"`
	// From is the sender address. Default: skywire-alerts@<hostname>.
	From string `json:"from,omitempty"`
	// DiskWarnPercent is the disk use that raises a storage warning.
	// Default: DefaultDiskWarn.
	DiskWarnPercent float64 `json:"disk_warn_percent,omitempty"`
	// Push are the browsers that get Web Push alerts. They change only
	// through Service.PushAdd and Service.PushRemove.
	Push []PushSubscription `json:"push,omitempty"`
}

type Status struct {
	Settings     Settings      `json:"settings"`
	Enabled      bool          `json:"enabled"`
	OfflineAfter string        `json:"offline_after"`
	Watched      []TargetState `json:"watched"`
	LastCheck    time.Time     `json:"last_check,omitzero"`
	LastSent     time.Time     `json:"last_sent,omitzero"`
	LastResults  []Result      `json:"last_results,omitempty"`
	Pending      int           `json:"pending,omitempty"`
	// LastEvents are the most recent alerts, newest last.
	LastEvents []Event `json:"last_events,omitempty"`
	// PushPublicKey is the VAPID public key a browser subscribes with.
	PushPublicKey string `json:"push_public_key,omitempty"`
}

type Storage struct {
	ReadOnlyRoot    bool    `json:"root_read_only,omitempty"`
	IOErrors        int     `json:"io_errors,omitempty"`
	LastIOError     string  `json:"last_io_error,omitempty"`
	DiskUsedPercent float64 `json:"disk_used_percent,omitempty"`
}

type Target struct {
	PK       cipher.PubKey `json:"pk"`
	Hostname string        `json:"hostname,omitempty"`
	PublicIP string        `json:"public_ip,omitempty"`
	LocalIP  string        `json:"local_ip,omitempty"`
	// LastSeen is when the visor was last seen online, if known.
	LastSeen time.Time `json:"last_seen,omitzero"`
	Online   bool      `json:"online"`
	// State is one of the State values. Empty means StateOnline or
	// StateOffline, from Online.
	State string `json:"state,omitempty"`
	// Source is "hypervisor" or "watch".
	Source string `json:"source,omitempty"`
	// Uptime is how long the board has been up at the check, the host's
	// uptime when the visor reports it and the visor's own otherwise.
	Uptime Duration `json:"uptime,omitempty"`
	// Storage is the board's last reported storage health.
	Storage *Storage `json:"storage,omitempty"`
}

type TargetState struct {
	Target
	OfflineSince time.Time `json:"offline_since,omitzero"`
	Alerted      bool      `json:"alerted,omitempty"`
	// Site is set while the visor is part of an alerted site outage.
	Site            string   `json:"site,omitempty"`
	StorageWarnings []string `json:"storage_warnings,omitempty"`
	// LinkLostSince is when a reconnecting visor lost its hypervisor link.
	LinkLostSince time.Time `json:"link_lost_since,omitzero"`
	LinkAlerted   bool      `json:"link_alerted,omitempty"`
}

type Tracker struct {

	// Floor is the earliest time an offline period counts from, so visors
	// that went down while nothing watched get the full delay to return.
	Floor time.Time
	// DiskWarn is the disk use percent that raises a storage warning.
	// Zero is DefaultDiskWarn.
	DiskWarn float64
	// contains filtered or unexported fields
}

type WebhookPayload struct {
	Event string `json:"event"`
	// Kind is "board" or "site".
	Kind           string    `json:"kind,omitempty"`
	PK             string    `json:"pk,omitempty"`
	Hostname       string    `json:"hostname,omitempty"`
	PublicIP       string    `json:"public_ip,omitempty"`
	LocalIP        string    `json:"local_ip,omitempty"`
	LastSeen       time.Time `json:"last_seen,omitzero"`
	OfflineSince   time.Time `json:"offline_since,omitzero"`
	At             time.Time `json:"at"`
	Diagnosis      string    `json:"diagnosis,omitempty"`
	RecoveryReason string    `json:"recovery_reason,omitempty"`
	Warnings       []string  `json:"warnings,omitempty"`
	// Members are the visors of a site event.
	Members []Target `json:"members,omitempty"`
	Watcher string   `json:"watcher"`
	Text    string   `json:"text"`
}