entry

Documentation

Index

• Variables
• type Entry
  • func NewEntry() *Entry
  • func (e *Entry) Clone() *Entry
  • func (e *Entry) Release()
  • func (e *Entry) Session()
  • func (s *Entry) Update(e *Entry)
• type Request
  • func NewRequest() *Request
  • func (r *Request) Parse(body io.Reader) error
  • func (r *Request) Release()

Variables

var ErrBadJSON = errors.New("api: invalid json ")

Types

type Entry

type Entry struct {
	UID, SID               uint64
	UtmMedium              string
	Referrer               string
	Domain                 string
	ExitPage               string
	EntryPage              string
	Hostname               string
	Pathname               string
	UtmSource              string
	ReferrerSource         string
	Country                string
	Region                 string
	TransferredFrom        string
	UtmCampaign            string
	OperatingSystem        string
	Browser                string
	UtmTerm                string
	Name                   string
	ScreenSize             string
	BrowserVersion         string
	OperatingSystemVersion string
	UtmContent             string
	UserId                 uint64
	Timestamp              int64
	Duration               time.Duration
	Start                  int64
	City                   string
	PageViews              uint16
	Events                 uint16
	IsBounce               bool
}

func NewEntry

func NewEntry() *Entry

func (*Entry) Clone

func (e *Entry) Clone() *Entry

func (*Entry) Release

func (e *Entry) Release()

func (*Entry) Session

func (e *Entry) Session()

Session creates a new session from entry

func (*Entry) Update

func (s *Entry) Update(e *Entry)

type Request

type Request struct {
	EventName   string `json:"n"`
	URI         string `json:"url"`
	Referrer    string `json:"r"`
	Domain      string `json:"d"`
	ScreenWidth int    `json:"w"`
	HashMode    bool   `json:"h"`

	// Used in tests
	IP        string `json:"ip,omitempty"`
	UserAgent string `json:"ua,omitempty"`
	// contains filtered or unexported fields
}

Request is sent by the vince script embedded in client websites

func NewRequest

func NewRequest() *Request

func (*Request) Parse

func (r *Request) Parse(body io.Reader) error

Parse opportunistic parses request body to r object. This is crucial method any gains here translates to smooth events ingestion pipeline.

A hard size limitation of 32kb is imposed. This is arbitrary value, any change to it must be be supported with statistics.

func (*Request) Release

func (r *Request) Release()