journal

type DisabledEvents ¶ added in v0.7.1

type DisabledEvents []EventType

DisabledEvents is the set of event types whose journaling is suppressed.

func EnvDisabledEvents() DisabledEvents

func ParseDisabledEvents(s string) (DisabledEvents, error)

type Event ¶ added in v0.7.1

type Event struct {
	EventType

	Timestamp time.Time
	Data      interface{}
}

Event represents a journal entry.

See godocs on Journal for more information.

type EventType ¶ added in v0.7.1

type EventType struct {
	System string
	Event  string
	// contains filtered or unexported fields
}

EventType represents the signature of an event.

func (et EventType) Enabled() bool

func (et EventType) String() string

type EventTypeRegistry ¶ added in v0.7.1

type EventTypeRegistry interface {

	// RegisterEventType introduces a new event type to a journal, and
	// returns an EventType token that components can later use to check whether
	// journalling for that type is enabled/suppressed, and to tag journal
	// entries appropriately.
	RegisterEventType(system, event string) EventType
}

EventTypeRegistry is a component that constructs tracked EventType tokens, for usage with a Journal.

func NewEventTypeRegistry(disabled DisabledEvents) EventTypeRegistry

type Journal ¶

type Journal interface {
	EventTypeRegistry

	// RecordEvent records this event to the journal, if and only if the
	// EventType is enabled. If so, it calls the supplier function to obtain
	// the payload to record.
	//
	// Implementations MUST recover from panics raised by the supplier function.
	RecordEvent(evtType EventType, supplier func() interface{})

	// Close closes this journal for further writing.
	Close() error
}

Journal represents an audit trail of system actions.

Every entry is tagged with a timestamp, a system name, and an event name. The supplied data can be any type, as long as it is JSON serializable, including structs, map[string]interface{}, or primitive types.

For cleanliness and type safety, we recommend to use typed events. See the *Evt struct types in this package for more info.

func NilJournal() Journal