analytics

Documentation

Index

• Variables
• type Client
  • func NewClient(parent context.Context, sink Sink, logger hclog.Logger) Client
• type EventPayload
• type Events
• type Recorder
• type Sink

Variables

var NullSink = &nullSink{}

NullSink is an analytics sink to use in the event that we don't want to send analytics

Types

type Client

type Client interface {
	Recorder
	Close()
	CloseWithTimeout(timeout time.Duration)
}

func NewClient

func NewClient(parent context.Context, sink Sink, logger hclog.Logger) Client

type EventPayload

type EventPayload = interface{}

type Events

type Events = []map[string]interface{}

type Recorder

type Recorder interface {
	LogEvent(payload EventPayload)
}

type Sink

type Sink interface {
	RecordAnalyticsEvents(ctx context.Context, events Events) error
}