analytics

Documentation

Index

• func WithAnalytics(ctx context.Context, a *TiltAnalytics) context.Context
• type AnalyticsOpter
• type NullOpter
  • func (NullOpter) SetOpt(opt analytics.Opt) error
• type TiltAnalytics
  • func Get(ctx context.Context) *TiltAnalytics
  • func NewMemoryTiltAnalyticsForTest(opter AnalyticsOpter) (*analytics.MemoryAnalytics, *TiltAnalytics)
  • func NewTiltAnalytics(opt analytics.Opt, opter AnalyticsOpter, analytics analytics.Analytics, ...) *TiltAnalytics
  • func (ta *TiltAnalytics) Count(name string, tags map[string]string, n int)
  • func (ta *TiltAnalytics) Flush(timeout time.Duration)
  • 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) Opt() analytics.Opt
  • func (ta *TiltAnalytics) SetOpt(opt analytics.Opt) error
  • func (ta *TiltAnalytics) Timer(name string, dur time.Duration, tags map[string]string)

Functions

func WithAnalytics

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

Types

type AnalyticsOpter

type AnalyticsOpter interface {
	SetOpt(opt analytics.Opt) error
}

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

type NullOpter

type NullOpter struct{}

func (NullOpter) SetOpt

func (NullOpter) SetOpt(opt analytics.Opt) error

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(opt analytics.Opt, opter AnalyticsOpter, analytics analytics.Analytics, tiltVersion string) *TiltAnalytics

func (*TiltAnalytics) Count

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

func (*TiltAnalytics) Flush

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

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) Opt

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

func (*TiltAnalytics) SetOpt

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

func (*TiltAnalytics) Timer

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