telemetry

Documentation

Index

• Variables
• type Action
• type Telemetry
  • func New(ver config.Version) *Telemetry
  • func (t *Telemetry) Emit(action Action)
  • func (t *Telemetry) Flush(ctx context.Context) error
  • func (t *Telemetry) WithUserID(userID string)

Variables

var ErrRillIntake = errors.New("failed to fire telemetry")

Types

type Action

type Action string

Action represents a type of telemetry event. Error actions are not needed. Will be inferred from missing events.

const (
	ActionInstallSuccess         Action = "install-success"
	ActionDeployStart            Action = "deploy-start"
	ActionDeploySuccess          Action = "deploy-success"
	ActionGithubConnectedStart   Action = "ghconnected-start"
	ActionGithubConnectedSuccess Action = "ghconnected-success"
	ActionDataAccessStart        Action = "dataaccess-start"
	ActionDataAccessSuccess      Action = "dataaccess-success"
	ActionLoginStart             Action = "login-start"
	ActionLoginSuccess           Action = "login-success"
)

type Telemetry

type Telemetry struct {
	Enabled   bool
	InstallID string
	Version   config.Version
	UserID    string
	// contains filtered or unexported fields
}

func New

func New(ver config.Version) *Telemetry

func (*Telemetry) Emit

func (t *Telemetry) Emit(action Action)

func (*Telemetry) Flush

func (t *Telemetry) Flush(ctx context.Context) error

func (*Telemetry) WithUserID

func (t *Telemetry) WithUserID(userID string)