event

Documentation

Index

• Variables
• type Custom
  • func (c *Custom) MarshalZerologObject(e *zerolog.Event)
• type PageView
  • func (pv *PageView) MarshalZerologObject(e *zerolog.Event)
• type ReferrerUri
  • func (ru *ReferrerUri) HostOrDirect() []byte
  • func (ru *ReferrerUri) Parse(uri []byte) error
• type Session
  • func (s *Session) MarshalZerologObject(e *zerolog.Event)
  • func (s *Session) SessionTime() time.Time
  • func (s *Session) Version() uint16
• type Uri
  • func (u *Uri) IsEmpty() bool
  • func (u *Uri) Parse(uri []byte) error
  • func (u *Uri) Path() []byte
• type UtmParams
  • func (up *UtmParams) MarshalZerologObject(e *zerolog.Event)

Variables

var (
	ErrUriIsRelative = errors.New("uri is relative")
)

Types

type Custom

type Custom struct {
	Timestamp time.Time
	PageUri   Uri
	Session   Session
	Name      string
	Keys      []string
	Values    []string
}

Custom define a user defined event with custom properties.

func (*Custom) MarshalZerologObject

func (c *Custom) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog.LogObjectMarshaler.

type PageView

type PageView struct {
	Session   Session
	Timestamp time.Time
	PageUri   Uri
}

PageView define a page view event.

func (*PageView) MarshalZerologObject

func (pv *PageView) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog.LogObjectMarshaler.

type ReferrerUri

type ReferrerUri struct {
	Uri
}

ReferrerUri wraps an URI to represent referrer URIs. An empty referrer uri is considered as "direct".

func (*ReferrerUri) HostOrDirect

func (ru *ReferrerUri) HostOrDirect() []byte

HostOrDirect returns uri host or "direct" if uri is empty.

func (*ReferrerUri) Parse

func (ru *ReferrerUri) Parse(uri []byte) error

Parse initializes URI from the given absolute uri. If given uri is nil or if this method is never called, ReferrerUri is considered as direct.

type Session

type Session struct {
	PageUri     *Uri
	ReferrerUri *ReferrerUri
	Client      uaparser.Client
	CountryCode ipgeolocator.CountryCode
	VisitorId   string
	SessionUuid uuid.UUID
	Utm         UtmParams
	Pageviews   uint16
}

Session holds data about visitor's/user's session/visit.

func (*Session) MarshalZerologObject

func (s *Session) MarshalZerologObject(e *zerolog.Event)

func (*Session) SessionTime

func (s *Session) SessionTime() time.Time

SessionTime returns session creation date time.

func (*Session) Version

func (s *Session) Version() uint16

Version returns session version number. Higher version number means more recent session.

type Uri

type Uri struct {
	fasthttp.URI
}

Uri wraps a fasthttp.URI to implements Uri.

func (*Uri) IsEmpty

func (u *Uri) IsEmpty() bool

IsEmpty returns whether Uri contains actual data or is empty.

func (*Uri) Parse

func (u *Uri) Parse(uri []byte) error

Parse initializes URI from the given absolute uri.

func (*Uri) Path

func (u *Uri) Path() []byte

Path returns URI path, i.e. /foo/bar of [http://aaa.com/foo/bar?baz=123#qwe](http://aaa.com/foo/bar?baz=123#qwe) .

The returned path is always urldecoded and normalized, i.e. '//f%20obar/baz/../zzz' becomes '/f obar/zzz'.

The returned bytes are valid until the next URI method call.

type UtmParams

type UtmParams struct {
	Source   string
	Medium   string
	Campaign string
	Term     string
	Content  string
}

UtmParams holds Urchin Tracking Module (UTM) URL parameters. See https://en.wikipedia.org/wiki/UTM_parameters.

func (*UtmParams) MarshalZerologObject

func (up *UtmParams) MarshalZerologObject(e *zerolog.Event)

MarshalZerologObject implements zerolog.LogObjectMarshaler.