analytics

Documentation

Index

• type Config
• type Service
  • func NewService(log *zap.Logger, config Config, satelliteName string) *Service
  • func (service *Service) Close() error
  • func (service *Service) TrackAccessGrantCreated(userID uuid.UUID)
  • func (service *Service) TrackAccountVerified(userID uuid.UUID, email string)
  • func (service *Service) TrackCreateUser(fields TrackCreateUserFields)
  • func (service *Service) TrackEvent(eventName string, userID uuid.UUID)
  • func (service *Service) TrackLinkEvent(eventName string, userID uuid.UUID, link string)
  • func (service *Service) TrackProjectCreated(userID, projectID uuid.UUID, currentProjectCount int)
  • func (service *Service) TrackSignedIn(userID uuid.UUID, email string)
• type TrackCreateUserFields
• type UserType

Types

type Config

type Config struct {
	SegmentWriteKey string `help:"segment write key" default:""`
	Enabled         bool   `help:"enable analytics reporting" default:"false"`
}

Config is a configuration struct for analytics Service.

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service for sending analytics.

architecture: Service

func NewService

func NewService(log *zap.Logger, config Config, satelliteName string) *Service

NewService creates new service for creating sending analytics.

func (*Service) Close

func (service *Service) Close() error

Close closes the Segment client.

func (*Service) TrackAccessGrantCreated

func (service *Service) TrackAccessGrantCreated(userID uuid.UUID)

TrackAccessGrantCreated sends an "Access Grant Created" event to Segment.

func (*Service) TrackAccountVerified

func (service *Service) TrackAccountVerified(userID uuid.UUID, email string)

TrackAccountVerified sends an "Account Verified" event to Segment.

func (*Service) TrackCreateUser

func (service *Service) TrackCreateUser(fields TrackCreateUserFields)

TrackCreateUser sends an "Account Created" event to Segment.

func (*Service) TrackEvent

func (service *Service) TrackEvent(eventName string, userID uuid.UUID)

TrackEvent sends an arbitrary event associated with user ID to Segment. It is used for tracking occurrences of client-side events.

func (*Service) TrackLinkEvent

func (service *Service) TrackLinkEvent(eventName string, userID uuid.UUID, link string)

TrackLinkEvent sends an arbitrary event and link associated with user ID to Segment. It is used for tracking occurrences of client-side events.

func (*Service) TrackProjectCreated

func (service *Service) TrackProjectCreated(userID, projectID uuid.UUID, currentProjectCount int)

TrackProjectCreated sends an "Project Created" event to Segment.

func (*Service) TrackSignedIn

func (service *Service) TrackSignedIn(userID uuid.UUID, email string)

TrackSignedIn sends an "Signed In" event to Segment.

type TrackCreateUserFields

type TrackCreateUserFields struct {
	ID            uuid.UUID
	AnonymousID   string
	FullName      string
	Email         string
	Type          UserType
	EmployeeCount string
	CompanyName   string
	JobTitle      string
}

TrackCreateUserFields contains input data for tracking a create user event.

type UserType

type UserType string

UserType is a type for distinguishing personal vs. professional users.

const (
	// Professional defines a "professional" user type.
	Professional UserType = "Professional"
	// Personal defines a "personal" user type.
	Personal UserType = "Personal"
)