analytics

Documentation

Index

• func StringIncludes(check string, shouldInclude []string) bool
• func StructToMap(obj interface{}) (map[string]interface{}, error)
• func WriteSSHEvents(sshMonitor *SSHMonitor, analytics Analytics, userID string, ...) error
• type Analytics
• type EventName
• type Properties
• type SSData
  • func RowStrToSSRow(row string) SSData
• type SSHAnalytics
  • func (s SSHAnalytics) Configure() error
  • func (s *SSHAnalytics) DoOnSSHChange(action func() error) error
  • func (s *SSHAnalytics) WriteSSHEvents() error
• type SSHAnalyticsOnChangeTask
  • func (s SSHAnalyticsOnChangeTask) GetTaskSpec() tasks.TaskSpec
  • func (s *SSHAnalyticsOnChangeTask) Run() error
• type SSHAnalyticsSSHPing
  • func (s SSHAnalyticsSSHPing) GetTaskSpec() tasks.TaskSpec
  • func (s *SSHAnalyticsSSHPing) Run() error
• type SSHAnalyticsStore
• type SSHMonitor
  • func NewSSHMonitor() *SSHMonitor
  • func (c SSHMonitor) GetAllConnections(include ...string) ([]string, error)
  • func (c SSHMonitor) GetSSHConnections() ([]SSData, error)
  • func (c *SSHMonitor) GetSSHSessionEvents() (EventName, error)
• type SegmentClient
  • func NewSegmentClient(writeAPIKey string) SegmentClient
  • func (s SegmentClient) TrackUserEvent(eventName EventName, userID string, properties Properties) error
  • func (s SegmentClient) TrackUserWorkspaceEvent(eventName EventName, userID string, workspace *entity.Workspace, ...) error

Functions

func StringIncludes

func StringIncludes(check string, shouldInclude []string) bool

returns true if empty list provided

func StructToMap

func StructToMap(obj interface{}) (map[string]interface{}, error)

func WriteSSHEvents

func WriteSSHEvents(sshMonitor *SSHMonitor, analytics Analytics, userID string, workspace *entity.Workspace) error

Types

type Analytics

type Analytics interface {
	TrackUserEvent(eventName EventName, userID string, properties Properties) error
	TrackUserWorkspaceEvent(eventName EventName, userID string, workspace *entity.Workspace, extraProps Properties) error
}

type EventName

type EventName string

const (
	SSHConnections  EventName = "SSH Connections"
	StopSSHSession  EventName = "All SSH Session Stop"
	StartSSHSession EventName = "All SSH Session Start"
)

type Properties

type Properties map[string]interface{}

type SSData

type SSData struct {
	NetID            string `json:"netId"`
	State            string `json:"state"`
	RecvQ            string `json:"recvQ"`
	SendQ            string `json:"sendvQ"`
	LocalAddressPort string `json:"localAddressPort"`
	PeerAddressPort  string `json:"peerAddressPort"`
}

func RowStrToSSRow

func RowStrToSSRow(row string) SSData

type SSHAnalytics

type SSHAnalytics struct {
	SSHMonitor *SSHMonitor
	Analytics  Analytics
	Store      SSHAnalyticsStore
	// contains filtered or unexported fields
}

func (SSHAnalytics) Configure

func (s SSHAnalytics) Configure() error

func (*SSHAnalytics) DoOnSSHChange

func (s *SSHAnalytics) DoOnSSHChange(action func() error) error

func (*SSHAnalytics) WriteSSHEvents

func (s *SSHAnalytics) WriteSSHEvents() error

type SSHAnalyticsOnChangeTask

type SSHAnalyticsOnChangeTask struct {
	SSHAnalytics
}

func (SSHAnalyticsOnChangeTask) GetTaskSpec

func (s SSHAnalyticsOnChangeTask) GetTaskSpec() tasks.TaskSpec

func (*SSHAnalyticsOnChangeTask) Run

func (s *SSHAnalyticsOnChangeTask) Run() error

type SSHAnalyticsSSHPing

type SSHAnalyticsSSHPing struct {
	SSHAnalytics
}

func (SSHAnalyticsSSHPing) GetTaskSpec

func (s SSHAnalyticsSSHPing) GetTaskSpec() tasks.TaskSpec

func (*SSHAnalyticsSSHPing) Run

func (s *SSHAnalyticsSSHPing) Run() error

type SSHAnalyticsStore

type SSHAnalyticsStore interface {
	GetCurrentUserID() (string, error)
	GetCurrentWorkspaceID() (string, error)
	GetWorkspace(workspaceID string) (*entity.Workspace, error)
}

type SSHMonitor

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

func NewSSHMonitor

func NewSSHMonitor() *SSHMonitor

func (SSHMonitor) GetAllConnections

func (c SSHMonitor) GetAllConnections(include ...string) ([]string, error)

func (SSHMonitor) GetSSHConnections

func (c SSHMonitor) GetSSHConnections() ([]SSData, error)

func (*SSHMonitor) GetSSHSessionEvents

func (c *SSHMonitor) GetSSHSessionEvents() (EventName, error)

type SegmentClient

type SegmentClient struct {
	Client analytics.Client
}

func NewSegmentClient

func NewSegmentClient(writeAPIKey string) SegmentClient

func (SegmentClient) TrackUserEvent

func (s SegmentClient) TrackUserEvent(eventName EventName, userID string, properties Properties) error

func (SegmentClient) TrackUserWorkspaceEvent

func (s SegmentClient) TrackUserWorkspaceEvent(eventName EventName, userID string, workspace *entity.Workspace, extraProps Properties) error