monitor

Documentation

Index

• func IsError(err error) bool
• func IsSuccess(err error) bool
• func IsWarning(err error) bool
• type InternalWarning
  • func (w InternalWarning) Error() string
• type OutputAnalysis
• type Receiver
• type Status
• type Summary

Functions

func IsError

func IsError(err error) bool

func IsSuccess

func IsSuccess(err error) bool

func IsWarning

func IsWarning(err error) bool

Types

type InternalWarning

type InternalWarning struct {
}

func (InternalWarning) Error

func (w InternalWarning) Error() string

type OutputAnalysis

type OutputAnalysis interface {
	// ContainsRemoteLockFailure returns true if the output indicates that remote locking failed.
	ContainsRemoteLockFailure() bool

	// GetRemoteLockedSince returns the time duration since the remote lock was created.
	// If no remote lock is held or the time cannot be determined, the second parameter is false.
	GetRemoteLockedSince() (time.Duration, bool)

	// GetRemoteLockedBy returns who locked the remote lock, if available.
	GetRemoteLockedBy() (string, bool)
}

OutputAnalysis of the profile run

type Receiver

type Receiver interface {
	// Start of a command
	Start(command string)
	// Status during the execution
	Status(status Status)
	// Summary at the end of a command
	Summary(command string, summary Summary, stderr string, result error)
}

type Status

type Status struct {
	PercentDone  float64
	TotalFiles   int
	FilesDone    int
	TotalBytes   int64
	BytesDone    int64
	ErrorCount   int
	CurrentFiles []string
}

type Summary

type Summary struct {
	Duration        time.Duration
	FilesNew        int
	FilesChanged    int
	FilesUnmodified int
	DirsNew         int
	DirsChanged     int
	DirsUnmodified  int
	FilesTotal      int
	BytesAdded      uint64
	BytesTotal      uint64
	OutputAnalysis  OutputAnalysis
}

Summary of the profile run