log

Documentation

Index

• Variables
• type ExecState
• type LogIndexType
• type ResultLog
• type ResultLogEntry
  • func NewResultLogEntry(executionID, nodeID, blockID, requestID, executedBy, content string) *ResultLogEntry
  • func (e *ResultLogEntry) SetError(err error)
• type ResultLogIndex
  • func NewResultLogIndex(typ LogIndexType) (ResultLogIndex, error)

Variables

var (
	ErrResultLogEntryNotFound = errors.New("result Log Entry not found")
	ErrResultLogNotFound      = errors.New("result log not found")
)

var ResultLogDir = tools.MyPathTo("result_log")

Types

type ExecState

type ExecState string

const (
	ExecStateUnknown   ExecState = "Unknown"
	ExecStateQueued    ExecState = "Queued"
	ExecStateStarted   ExecState = "Started"
	ExecStateCanceled  ExecState = "Cancel-Requested"
	ExecStateCompleted ExecState = "Completed"
	ExecStateFailed    ExecState = "Failed"
)

type LogIndexType

type LogIndexType int

const (
	IndexUnknown    LogIndexType = 0
	IndexInMemory   LogIndexType = 1
	IndexFileSystem LogIndexType = 2
)

type ResultLog

type ResultLog interface {
	// Len returns the number of entries in the log
	Len() (int, error)

	// Each provides a callback fn (intended to be called as an iterator
	Each(cb func(int, *ResultLogEntry) bool) error

	// Find looks up a specific result log entry by ID
	Find(id string) (*ResultLogEntry, error)

	// Append an entry to the ResultLog
	Append(entry *ResultLogEntry) error
}

type ResultLogEntry

type ResultLogEntry struct {
	ID          string     `yaml:"id" json:"id"`
	ExecutionID string     `yaml:"execution_id" json:"execution_id"`
	NodeID      string     `yaml:"node_id" json:"node_id"`
	BlockID     string     `yaml:"block_id" json:"block_id"`
	RequestID   string     `yaml:"request_id" json:"request_id"`
	ExitStatus  string     `yaml:"exit_status" json:"exit_status"`
	Stdout      string     `yaml:"stdout" json:"stdout"`
	Stderr      string     `yaml:"stderr" json:"stderr"`
	ExecutedAt  *time.Time `yaml:"executed_at,omitempty" json:"executed_at,omitempty"`
	ExecutedBy  string     `yaml:"executed_by" json:"executed_by"`
	State       ExecState  `yaml:"state" json:"state"`

	// Err is a string representation of error
	Err string `yaml:"err,omitempty" json:"err,omitempty"`

	// The Content can change (in the referenced block)
	// so persist the original  command alongside
	Content string `yaml:"content" json:"content"`
}

func NewResultLogEntry

func NewResultLogEntry(executionID, nodeID, blockID, requestID, executedBy, content string) *ResultLogEntry

func (*ResultLogEntry) SetError

func (e *ResultLogEntry) SetError(err error)

type ResultLogIndex

type ResultLogIndex interface {
	// Get the ResultLog associated with the nodeID
	Get(nodeID string) (ResultLog, error)

	// Append an entry to the ResultLog associated with the nodeID
	Append(*ResultLogEntry) error
}

ResultLogIndex provides an interface to provide Results primarily by nodeID

func NewResultLogIndex

func NewResultLogIndex(typ LogIndexType) (ResultLogIndex, error)