event

Documentation

Index

• type Custom
  • func (c *Custom) MarshalZerologObject(e *zerolog.Event)
• type PageView
  • func (pv *PageView) MarshalZerologObject(e *zerolog.Event)
• type ReferrerUri
  • func ParseReferrerUri(rawUri []byte) (ReferrerUri, error)
  • func (ru *ReferrerUri) HostOrDirect() string
  • func (ru ReferrerUri) MarshalJSON() ([]byte, error)
  • func (ru ReferrerUri) String() string
• type Session
  • func (s *Session) MarshalZerologObject(e *zerolog.Event)
  • func (s *Session) SessionTime() time.Time
• type UtmParams
  • func (up *UtmParams) MarshalZerologObject(e *zerolog.Event)

Types

type Custom

type Custom struct {
	Timestamp time.Time
	PageUri   uri.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.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.Uri
}

ReferrerUri wraps an uri.Uri to represent referrer URIs (absolute URI with no query args and fragment/hash). An empty referrer uri is considered as "direct".

func ParseReferrerUri

func ParseReferrerUri(rawUri []byte) (ReferrerUri, error)

ParseReferrerUri parses a referrer uri.

func (*ReferrerUri) HostOrDirect

func (ru *ReferrerUri) HostOrDirect() string

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

func (ReferrerUri) MarshalJSON

func (ru ReferrerUri) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (ReferrerUri) String

func (ru ReferrerUri) String() string

String implements fmt.Stringer.

type Session

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

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

func (*Session) MarshalZerologObject

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

MarshalZerologObject implements zerolog.LogObjectMarshaler.

func (*Session) SessionTime

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

SessionTime returns session creation date time.

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.