store

Documentation

Overview

Package store implements how to output the log, and how to restore from the log file.

Index

• Constants
• Variables
• type PathPattern
  • func ParsePathPattern(s string) PathPattern
  • func (p PathPattern) Build(t time.Time) string
  • func (p PathPattern) Glob() string
  • func (p PathPattern) IsEmpty() bool
  • func (p PathPattern) ListAll() []string
  • func (p PathPattern) ListBetween(since, until time.Time) []string
  • func (p PathPattern) Match(filename string, since, until time.Time) bool
  • func (p PathPattern) String() string
• type RecordHandler
• type Store
  • func New(path string, console io.Writer) (*Store, error)
  • func (s *Store) ActivateTarget(source, target *api.URL)
  • func (s *Store) Close() error
  • func (s *Store) CurrentIncidents() []*api.Incident
  • func (s *Store) DeactivateTarget(source *api.URL, targets ...*api.URL)
  • func (s *Store) Errors() (healthy bool, messages []string)
  • func (s *Store) IncidentCount() int
  • func (s *Store) IncidentHistory() []*api.Incident
  • func (s *Store) MakeReport(probeHistoryLength int) api.Report
  • func (s *Store) OpenLog(since, until time.Time) (api.LogScanner, error)
  • func (s *Store) Pathes() []string
  • func (s *Store) ProbeHistory() []api.ProbeHistory
  • func (s *Store) Report(source *api.URL, r api.Record)
  • func (s *Store) ReportInternalError(scope, message string)
  • func (s *Store) Restore() error
  • func (s *Store) Targets() []string

Constants

const (
	PROBE_HISTORY_LEN    = 60
	INCIDENT_HISTORY_LEN = 20
)

Variables

var (
	LogRestoreBytes = int64(10 * 1024 * 1024)
)

Types

type PathPattern

type PathPattern struct {
	// contains filtered or unexported fields
}

func ParsePathPattern

func ParsePathPattern(s string) PathPattern

func (PathPattern) Build

func (p PathPattern) Build(t time.Time) string

func (PathPattern) Glob

func (p PathPattern) Glob() string

func (PathPattern) IsEmpty

func (p PathPattern) IsEmpty() bool

func (PathPattern) ListAll

func (p PathPattern) ListAll() []string

ListAll returns all log file pathes. The result is sorted by time order.

func (PathPattern) ListBetween

func (p PathPattern) ListBetween(since, until time.Time) []string

ListBetween returns log file pathes. The result is filtered by since and until query, but not sorted.

func (PathPattern) Match

func (p PathPattern) Match(filename string, since, until time.Time) bool

func (PathPattern) String

func (p PathPattern) String() string

type RecordHandler

type RecordHandler func(api.Record)

type Store

type Store struct {
	Console io.Writer

	OnStatusChanged []RecordHandler
	// contains filtered or unexported fields
}

Store is the log handler of Ayd, and it also the database of Ayd.

func New

func New(path string, console io.Writer) (*Store, error)

func (*Store) ActivateTarget

func (s *Store) ActivateTarget(source, target *api.URL)

ActivateTarget marks the target will reported via specified source. This method prepares a probeHistory, and mark it as active.

func (*Store) Close

func (s *Store) Close() error

func (*Store) CurrentIncidents

func (s *Store) CurrentIncidents() []*api.Incident

func (*Store) DeactivateTarget

func (s *Store) DeactivateTarget(source *api.URL, targets ...*api.URL)

DeactivateTarget marks the target is no longer reported via specified source.

func (*Store) Errors

func (s *Store) Errors() (healthy bool, messages []string)

Errors returns store status and error logs.

func (*Store) IncidentCount

func (s *Store) IncidentCount() int

IncidentCount returns the count of incident causes.

func (*Store) IncidentHistory

func (s *Store) IncidentHistory() []*api.Incident

func (*Store) MakeReport

func (s *Store) MakeReport(probeHistoryLength int) api.Report

MakeReport creates ayd.Report for exporting for endpoint. The result includes only information about active targets.

func (*Store) OpenLog

func (s *Store) OpenLog(since, until time.Time) (api.LogScanner, error)

func (*Store) Pathes

func (s *Store) Pathes() []string

Path returns pathes to log files.

func (*Store) ProbeHistory

func (s *Store) ProbeHistory() []api.ProbeHistory

ProbeHistory returns a slice of lib-ayd.ProbeHistory. This method only returns active target's ProbeHistory.

func (*Store) Report

func (s *Store) Report(source *api.URL, r api.Record)

Report reports a Record to this Store.

See also probeHistoryMap.Append about the arguments.

func (*Store) ReportInternalError

func (s *Store) ReportInternalError(scope, message string)

func (*Store) Restore

func (s *Store) Restore() error

func (*Store) Targets

func (s *Store) Targets() []string

Targets returns target URLs as a string slice. The result is includes inactive target, sorted in dictionary order.