analytics

README

analytics

This is a stub for what will one day be a distributed analytics package.

Getting Involved

We would love involvement from more people! If you notice any errors or would like to submit changes, please see our Contributing Guidelines.

Developing

We've set up a separate document for developer guildlines!

Documentation

Index

• type Analytics
• type Event
• type Memstore
  • func (ms Memstore) Query(q query.Query) (query.Results, error)
  • func (ms *Memstore) Track(event string, props map[string]interface{}) error

Types

type Analytics

type Analytics interface {
	Query(query.Query) (query.Results, error)
	Track(event string, props map[string]interface{}) error
}

Analytics is the interface for collecting and storing analytics events

type Event

type Event struct {
	Name    string
	Created time.Time
	Props   map[string]interface{}
}

Event is a tracked analytics event

type Memstore

type Memstore []*Event

Memstore is a basic implementation of the Analytics interface

func (Memstore) Query

func (ms Memstore) Query(q query.Query) (query.Results, error)

Query makes the memstore Queryable

func (*Memstore) Track

func (ms *Memstore) Track(event string, props map[string]interface{}) error

Track records an event