report

Documentation

Index

• Constants
• type Message
  • func (m Message) MarshalJSON() ([]byte, error)
  • func (m Message) String() string
• type MessageType
• type PerformanceStats
  • func (p PerformanceStats) Log()
  • func (p *PerformanceStats) MarshalJSON() ([]byte, error)
• type Report
  • func NewReport() *Report
  • func (r *Report) ToJSON() ([]byte, error)
  • func (r *Report) Watch(messageChan <-chan Message)
• type Repository
  • func NewRepository() Repository
  • func (r *Repository) GetLastCompleteJSON() ([]byte, error)
  • func (r *Repository) GetLastJSON() ([]byte, error)
  • func (r *Repository) GetLastSuccessfulJSON() ([]byte, error)
  • func (r *Repository) MarkAsComplete()
  • func (r *Repository) MarkAsSuccessful()
  • func (r *Repository) StartNewReport()
  • func (r *Repository) UpdatePerformanceStats(stats PerformanceStats)
  • func (r *Repository) UpdateStatus(status jobStatus)
  • func (r *Repository) Watch(messageChan <-chan Message)
• type Severity

Constants

const (
	Pending    jobStatus = "pending"
	InProgress jobStatus = "build in progress"
	Success    jobStatus = "build successful"
	Failed     jobStatus = "build failed"
)

Types

type Message

type Message struct {
	Type     MessageType
	Severity Severity
	Text     string
}

func (Message) MarshalJSON

func (m Message) MarshalJSON() ([]byte, error)

func (Message) String

func (m Message) String() string

type MessageType

type MessageType string

const (
	GlobalMessage     MessageType = "global"
	IngestorMessage   MessageType = "ingestor"
	PrecomputeMessage MessageType = "precompute"
	ComputeMessage    MessageType = "compute"
)

type PerformanceStats

type PerformanceStats struct {
	DataFetchingDuration time.Duration `json:"data_fetching_duration"`
	PrecomputeDuration   time.Duration `json:"precomputeduration"`
	ComputeDuration      time.Duration `json:"compute_duration"`
	BuildDuration        time.Duration `json:"build_duration"`
}

PerformanceStats contains durations of each step of the build pipeline.

func (PerformanceStats) Log

func (p PerformanceStats) Log()

Log print stats to terminal.

func (*PerformanceStats) MarshalJSON

func (p *PerformanceStats) MarshalJSON() ([]byte, error)

MarshalJSON overrides PerformanceStats JSON to pretty print the duration.

type Report

type Report struct {
	StartTime time.Time `json:"start_time"`
	EndTime   time.Time `json:"end_time"`

	Logs        map[MessageType][]Message `json:"logs"`
	Status      jobStatus                 `json:"status"`
	Performance PerformanceStats          `json:"performance"`
	// contains filtered or unexported fields
}

func NewReport

func NewReport() *Report

NewReport creates and initializes a new Report.

func (*Report) ToJSON

func (r *Report) ToJSON() ([]byte, error)

func (*Report) Watch

func (r *Report) Watch(messageChan <-chan Message)

Watch watches for log messages coming from the different workers. It ends when the channel is closed. This function is concurrent-safe.

type Repository

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

func NewRepository

func NewRepository() Repository

func (*Repository) GetLastCompleteJSON

func (r *Repository) GetLastCompleteJSON() ([]byte, error)

func (*Repository) GetLastJSON

func (r *Repository) GetLastJSON() ([]byte, error)

func (*Repository) GetLastSuccessfulJSON

func (r *Repository) GetLastSuccessfulJSON() ([]byte, error)

func (*Repository) MarkAsComplete

func (r *Repository) MarkAsComplete()

func (*Repository) MarkAsSuccessful

func (r *Repository) MarkAsSuccessful()

func (*Repository) StartNewReport

func (r *Repository) StartNewReport()

func (*Repository) UpdatePerformanceStats

func (r *Repository) UpdatePerformanceStats(stats PerformanceStats)

func (*Repository) UpdateStatus

func (r *Repository) UpdateStatus(status jobStatus)

func (*Repository) Watch

func (r *Repository) Watch(messageChan <-chan Message)

type Severity

type Severity string

const (
	Info    Severity = "info"
	Warning Severity = "warn"
	Error   Severity = "error"
)