historian

Documentation

Index

• Constants
• Variables
• type Filter
• type Historian
  • func Open(path string, readOnly bool) (*Historian, error)
  • func (h *Historian) Close() error
  • func (h *Historian) Each(filter *Filter, cb func(item *Item) error) error
  • func (h *Historian) EachItem(filter *Filter, exampleItem interface{}, cb func(item interface{}) error) error
  • func (h *Historian) Get(id uint64) (*Item, error)
  • func (h *Historian) Len() uint
  • func (h *Historian) Put(item *Item) error
• type Item
  • func (item *Item) String() string
  • func (item *Item) StringWithOpts(showWorkingDir bool) string

Constants

const DefaultTTL = 30 * 24 * time.Hour

Variables

var ErrStop = errors.New("stop")

Indiate when Each should stop executing and return cleanly.

Types

type Filter

type Filter struct {
	Start   *time.Time
	Stop    *time.Time
	Reverse bool
}

type Historian

type Historian struct {
	Path string
	TTL  time.Duration
	// contains filtered or unexported fields
}

func Open

func Open(path string, readOnly bool) (*Historian, error)

func (*Historian) Close

func (h *Historian) Close() error

func (*Historian) Each

func (h *Historian) Each(filter *Filter, cb func(item *Item) error) error

func (*Historian) EachItem

func (h *Historian) EachItem(filter *Filter, exampleItem interface{}, cb func(item interface{}) error) error

func (*Historian) Get

func (h *Historian) Get(id uint64) (*Item, error)

func (*Historian) Len

func (h *Historian) Len() uint

func (*Historian) Put

func (h *Historian) Put(item *Item) error

type Item

type Item struct {
	ID          uint64        `json:"id"`
	RecordedAt  time.Time     `json:"recorded_at"`
	WorkingDir  string        `json:"working_dir"`
	CommandLine string        `json:"command_line,omitempty"`
	ParentPID   *int          `json:"parent_pid,omitempty"`
	ExitStatus  *int          `json:"exit_status,omitempty"`
	Duration    time.Duration `json:"duration,omitempty"`
}

TODO: add current working directory for each item (and pass along to slurp)

func (*Item) String

func (item *Item) String() string

func (*Item) StringWithOpts

func (item *Item) StringWithOpts(showWorkingDir bool) string