history

Documentation

Overview

Package history provides an append only, size limited log of recent actions that Tide has taken for each subpool.

Index

• type History
  • func New(maxRecordsPerKey int, opener io.Opener, path string) (*History, error)
  • func (h *History) AllRecords() map[string][]*Record
  • func (h *History) Flush()
  • func (h *History) Merge(other *History)
  • func (h *History) Record(poolKey, action, baseSHA, err string, targets []plumber.Pull)
  • func (h *History) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Record

Types

type History

type History struct {
	sync.Mutex
	// contains filtered or unexported fields
}

History uses a `*recordLog` per pool to store a record of recent actions that Tide has taken. Using a log per pool ensure that history is retained for inactive pools even if other pools are very active.

func New

func New(maxRecordsPerKey int, opener io.Opener, path string) (*History, error)

New creates a new History struct with the specificed recordLog size limit.

func (*History) AllRecords

func (h *History) AllRecords() map[string][]*Record

AllRecords generates a map from pool key -> sorted records for the pool.

func (*History) Flush

func (h *History) Flush()

Flush writes the action history to persistent storage if configured to do so.

func (*History) Merge

func (h *History) Merge(other *History)

Merge combines the logs from the other history

func (*History) Record

func (h *History) Record(poolKey, action, baseSHA, err string, targets []plumber.Pull)

Record appends an entry to the recordlog specified by the poolKey.

func (*History) ServeHTTP

func (h *History) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves a JSON mapping from pool key -> sorted records for the pool.

type Record

type Record struct {
	Time    time.Time      `json:"time"`
	Action  string         `json:"action"`
	BaseSHA string         `json:"baseSHA,omitempty"`
	Target  []plumber.Pull `json:"target,omitempty"`
	Err     string         `json:"err,omitempty"`
}

Record is an entry describing one action that Tide has taken (e.g. TRIGGER or MERGE).