status

type CountInfo ¶

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

CountInfo records a simple count

func NewCountInfo(key string) *CountInfo

func (c *CountInfo) Add(v int32)

func (c *CountInfo) Info() []string

func (c *CountInfo) InfoKey() string

type InfoProvider ¶

type InfoProvider interface {
	InfoKey() string
	Info() []string
}

InfoProvider is a general interface to provide info about a log source. It is used in the agent status page. The expected usage is for a piece of code that wants to surface something on the status page register an info provider with the source with a unique key/name. This file contains useful base implementations, but InfoProvider can be extended/implemented for more complex data.

When implementing InfoProvider - be aware of the 2 ways it is used by the status page:

1. when a single message is returned, the statuspage will display a single line: InfoKey(): Info()[0]

2. when multiple messages are returned, the status page will display an indented list: InfoKey(): Info()[0] Info()[1] Info()[n]

InfoKey only needs to be unique per source, and should be human readable.

type LogStatus ¶

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

LogStatus tracks errors and success.

func NewLogStatus() *LogStatus

func (s *LogStatus) Dump() string

func (s *LogStatus) Error(err error)

func (s *LogStatus) GetError() string

func (s *LogStatus) IsError() bool

func (s *LogStatus) IsPending() bool

func (s *LogStatus) IsSuccess() bool

func (s *LogStatus) Success()

type MappedInfo ¶

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

MappedInfo collects multiple info messages with a unique key

func NewMappedInfo(key string) *MappedInfo

func (m *MappedInfo) Info() []string

func (m *MappedInfo) InfoKey() string

func (m *MappedInfo) RemoveMessage(key string)

func (m *MappedInfo) SetMessage(key string, message string)