analytics

Documentation

Index

• Constants
• func HashMD5(s string) string
• func IsAnalyticsDisabledFromEnv() bool
• func WithAnalytics(ctx context.Context, a *TiltAnalytics) context.Context
• type AnalyticsOpter
• type FakeOpter
  • func DefaultFakeOpter() *FakeOpter
  • func NewFakeOpter(initialOpt analytics.Opt) *FakeOpter
  • func (to *FakeOpter) Calls() []analytics.Opt
  • func (to *FakeOpter) ReadUserOpt() (analytics.Opt, error)
  • func (to *FakeOpter) SetUserOpt(opt analytics.Opt) error
  • func (to *FakeOpter) WaitUntilCount(t *testing.T, expectedCount int)
• type TiltAnalytics
  • func Get(ctx context.Context) *TiltAnalytics
  • func NewMemoryTiltAnalyticsForTest(opter AnalyticsOpter) (*analytics.MemoryAnalytics, *TiltAnalytics)
  • func NewTiltAnalytics(opter AnalyticsOpter, analytics analytics.Analytics, tiltVersion string) (*TiltAnalytics, error)
  • func (ta *TiltAnalytics) Count(name string, tags map[string]string, n int)
  • func (ta *TiltAnalytics) EffectiveOpt() analytics.Opt
  • func (ta *TiltAnalytics) Flush(timeout time.Duration)
  • func (ta *TiltAnalytics) GitRepoHash() string
  • func (ta *TiltAnalytics) GlobalTag(name string) (string, bool)
  • func (ta *TiltAnalytics) Incr(name string, tags map[string]string)
  • func (ta *TiltAnalytics) IncrAnonymous(name string, tags map[string]string)
  • func (ta *TiltAnalytics) IncrIfUnopted(name string)
  • func (ta *TiltAnalytics) MachineHash() string
  • func (ta *TiltAnalytics) SetTiltfileOpt(opt analytics.Opt)
  • func (ta *TiltAnalytics) SetUserOpt(opt analytics.Opt) error
  • func (ta *TiltAnalytics) TiltfileOpt() analytics.Opt
  • func (ta *TiltAnalytics) Timer(name string, dur time.Duration, tags map[string]string)
  • func (ta *TiltAnalytics) UserOpt() analytics.Opt

Constants

const TagGitRepoHash = "git.origin"

const TagOS = "os"

const TagVersion = "version"

Functions

func HashMD5

func HashMD5(s string) string

func IsAnalyticsDisabledFromEnv

func IsAnalyticsDisabledFromEnv() bool

func WithAnalytics

func WithAnalytics(ctx context.Context, a *TiltAnalytics) context.Context

Types

type AnalyticsOpter

type AnalyticsOpter interface {
	SetUserOpt(opt analytics.Opt) error
	ReadUserOpt() (analytics.Opt, error)
}

An AnalyticsOpter can record a user's choice (opt-in or opt-out) in re: Tilt recording analytics.

type FakeOpter

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

func DefaultFakeOpter

func DefaultFakeOpter() *FakeOpter

func NewFakeOpter

func NewFakeOpter(initialOpt analytics.Opt) *FakeOpter

func (*FakeOpter) Calls

func (to *FakeOpter) Calls() []analytics.Opt

func (*FakeOpter) ReadUserOpt

func (to *FakeOpter) ReadUserOpt() (analytics.Opt, error)

func (*FakeOpter) SetUserOpt

func (to *FakeOpter) SetUserOpt(opt analytics.Opt) error

func (*FakeOpter) WaitUntilCount

func (to *FakeOpter) WaitUntilCount(t *testing.T, expectedCount int)

type TiltAnalytics

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

An Analytics that:

1. Has `IncrIfUnopted` to report anonymous metrics only for users who have not opted in/out (or the choice that they did opt in/out).
2. Ignores all other calls from users who have not opted in.
3. Allows opting in/out at runtime.

func Get

func Get(ctx context.Context) *TiltAnalytics

func NewMemoryTiltAnalyticsForTest

func NewMemoryTiltAnalyticsForTest(opter AnalyticsOpter) (*analytics.MemoryAnalytics, *TiltAnalytics)

NOTE: if you need a ctx as well, use testutils.CtxAndAnalyticsForTest so that you get a ctx with the correct analytics baked in.

func NewTiltAnalytics

func NewTiltAnalytics(opter AnalyticsOpter, analytics analytics.Analytics, tiltVersion string) (*TiltAnalytics, error)

func (*TiltAnalytics) Count

func (ta *TiltAnalytics) Count(name string, tags map[string]string, n int)

func (*TiltAnalytics) EffectiveOpt

func (ta *TiltAnalytics) EffectiveOpt() analytics.Opt

func (*TiltAnalytics) Flush

func (ta *TiltAnalytics) Flush(timeout time.Duration)

func (*TiltAnalytics) GitRepoHash

func (ta *TiltAnalytics) GitRepoHash() string

func (*TiltAnalytics) GlobalTag

func (ta *TiltAnalytics) GlobalTag(name string) (string, bool)

func (*TiltAnalytics) Incr

func (ta *TiltAnalytics) Incr(name string, tags map[string]string)

func (*TiltAnalytics) IncrAnonymous

func (ta *TiltAnalytics) IncrAnonymous(name string, tags map[string]string)

func (*TiltAnalytics) IncrIfUnopted

func (ta *TiltAnalytics) IncrIfUnopted(name string)

func (*TiltAnalytics) MachineHash

func (ta *TiltAnalytics) MachineHash() string

func (*TiltAnalytics) SetTiltfileOpt

func (ta *TiltAnalytics) SetTiltfileOpt(opt analytics.Opt)

func (*TiltAnalytics) SetUserOpt

func (ta *TiltAnalytics) SetUserOpt(opt analytics.Opt) error

func (*TiltAnalytics) TiltfileOpt

func (ta *TiltAnalytics) TiltfileOpt() analytics.Opt

func (*TiltAnalytics) Timer

func (ta *TiltAnalytics) Timer(name string, dur time.Duration, tags map[string]string)

func (*TiltAnalytics) UserOpt

func (ta *TiltAnalytics) UserOpt() analytics.Opt