events

Documentation

Index

• type Event
  • func NewEvent(name string, sinks ...EventSink) *Event
  • func (event *Event) AddDynamicField(key string, fn func() interface{})
  • func (event *Event) AddField(key string, value interface{})
  • func (event *Event) Send()
  • func (event *Event) SendTo(sink EventSink)
• type EventSink
• type HoneycombSink
  • func NewHoneycombSink(builder *libhoney.Builder) *HoneycombSink
  • func (sink *HoneycombSink) SendEvent(eventName string, fields map[string]interface{})
• type LogEventSink
  • func NewLogEventSink(logger log.Logger) *LogEventSink
  • func (sink *LogEventSink) SendEvent(eventName string, fields map[string]interface{})

Types

type Event

type Event struct {
	*sync.RWMutex
	Name string
	// contains filtered or unexported fields
}

Event wraps some data and some sinks to send it to.

func NewEvent

func NewEvent(name string, sinks ...EventSink) *Event

func (*Event) AddDynamicField

func (event *Event) AddDynamicField(key string, fn func() interface{})

Add a dynamic field to this event; this will be evaluated each time Send() or SendTo() is called.

func (*Event) AddField

func (event *Event) AddField(key string, value interface{})

Add a field to this event

func (*Event) Send

func (event *Event) Send()

Send event to all sinks asynchronously

func (*Event) SendTo

func (event *Event) SendTo(sink EventSink)

Send to a particular event sink asynchronously, won't send to other sinks defined on the event prior

type EventSink

type EventSink interface {
	SendEvent(eventName string, fields map[string]interface{})
}

EventSink defines an interface for accepting data for an event

type HoneycombSink

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

HoneycombSink will send the event to HoneyComb.io, with fields added.

func NewHoneycombSink

func NewHoneycombSink(builder *libhoney.Builder) *HoneycombSink

func (*HoneycombSink) SendEvent

func (sink *HoneycombSink) SendEvent(eventName string, fields map[string]interface{})

type LogEventSink

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

LogEventSink will log the event with level "info" to the logger passed in, using the event fields.

func NewLogEventSink

func NewLogEventSink(logger log.Logger) *LogEventSink

func (*LogEventSink) SendEvent

func (sink *LogEventSink) SendEvent(eventName string, fields map[string]interface{})