observer

Documentation

Overview

observer package contains Reporting implementations that capture annealing events and log them to various destinations in potentially very different formats (as dictated by loggers passed to a logger at build-time)

Index

• Constants
• type AnnealingAttributeObserver
  • func (aao *AnnealingAttributeObserver) ObserveEvent(event observer.Event)
  • func (aao *AnnealingAttributeObserver) WithFilter(Filter filters.Filter) *AnnealingAttributeObserver
  • func (aao *AnnealingAttributeObserver) WithLogHandler(handler logging.Logger) *AnnealingAttributeObserver
• type AnnealingInvariantObserver
  • func (amo *AnnealingInvariantObserver) ObserveEvent(event observer.Event)
  • func (amo *AnnealingInvariantObserver) WithFilter(filter filters.Filter) *AnnealingInvariantObserver
  • func (amo *AnnealingInvariantObserver) WithLogHandler(handler logging.Logger) *AnnealingInvariantObserver
• type AnnealingMessageObserver
  • func (amo *AnnealingMessageObserver) ObserveEvent(event observer.Event)
  • func (amo *AnnealingMessageObserver) WithFilter(filter filters.Filter) *AnnealingMessageObserver
  • func (amo *AnnealingMessageObserver) WithLogHandler(handler logging.Logger) *AnnealingMessageObserver
  • func (amo *AnnealingMessageObserver) WithLoopInvariantObserver(watchLoopInvariant bool) *AnnealingMessageObserver
• type AnnealingObserver
  • func (l *AnnealingObserver) ObserveAnnealingEvent(event observer.Event)

Constants

const AnnealingLogLevel logging.Level = "Annealing"

Types

type AnnealingAttributeObserver

type AnnealingAttributeObserver struct {
	AnnealingObserver
}

AnnealingAttributeObserver produces a relevant set of Attributes to match any AnnealingEvents received and passes those events to its Logger for whatever observer is appropriate.

func (*AnnealingAttributeObserver) ObserveEvent

func (aao *AnnealingAttributeObserver) ObserveEvent(event observer.Event)

ObserveEvent captures and converts Event instances into a Attributes instance that captures key attributes associated with the event, and passes them to the Logger for processing.

func (*AnnealingAttributeObserver) WithFilter

func (aao *AnnealingAttributeObserver) WithFilter(Filter filters.Filter) *AnnealingAttributeObserver

func (*AnnealingAttributeObserver) WithLogHandler

func (aao *AnnealingAttributeObserver) WithLogHandler(handler logging.Logger) *AnnealingAttributeObserver

type AnnealingInvariantObserver

type AnnealingInvariantObserver struct {
	AnnealingObserver
	// contains filtered or unexported fields
}

func (*AnnealingInvariantObserver) ObserveEvent

func (amo *AnnealingInvariantObserver) ObserveEvent(event observer.Event)

func (*AnnealingInvariantObserver) WithFilter

func (amo *AnnealingInvariantObserver) WithFilter(filter filters.Filter) *AnnealingInvariantObserver

func (*AnnealingInvariantObserver) WithLogHandler

func (amo *AnnealingInvariantObserver) WithLogHandler(handler logging.Logger) *AnnealingInvariantObserver

type AnnealingMessageObserver

type AnnealingMessageObserver struct {
	AnnealingObserver
	// contains filtered or unexported fields
}

AnnealingMessageObserver produces a stream of human-friendly, free-form text log entries from any observed Event instances received.

func (*AnnealingMessageObserver) ObserveEvent

func (amo *AnnealingMessageObserver) ObserveEvent(event observer.Event)

ObserveEvent captures and converts Event instances into free-form text strings that it then passes onto its relevant Logger as an Info call.

func (*AnnealingMessageObserver) WithFilter

func (amo *AnnealingMessageObserver) WithFilter(filter filters.Filter) *AnnealingMessageObserver

func (*AnnealingMessageObserver) WithLogHandler

func (amo *AnnealingMessageObserver) WithLogHandler(handler logging.Logger) *AnnealingMessageObserver

func (*AnnealingMessageObserver) WithLoopInvariantObserver

func (amo *AnnealingMessageObserver) WithLoopInvariantObserver(watchLoopInvariant bool) *AnnealingMessageObserver

type AnnealingObserver

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

AnnealingObserver is a base-implementation of an annealing logger. It has a logHandler, but deliberately drops any AnnealingEvents received.

func (*AnnealingObserver) ObserveAnnealingEvent

func (l *AnnealingObserver) ObserveAnnealingEvent(event observer.Event)

Allows for the receipt of Event instances, but deliberately takes no action in observer those events.