analytics

Documentation

Index

• func DoNotTrack() bool
• func WithContext(ctx context.Context, t Tracker) context.Context
• type CloudTracker
  • func (t *CloudTracker) Capture(ctx context.Context, event string, properties map[string]string)
  • func (t *CloudTracker) Close() error
• type Config
  • func DefaultConfig(labels telemetry.Labels) Config
• type Event
• type Tracker
  • func Ctx(ctx context.Context) Tracker
  • func New(cfg Config) Tracker

Functions

func DoNotTrack

func DoNotTrack() bool

func WithContext

func WithContext(ctx context.Context, t Tracker) context.Context

Types

type CloudTracker

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

func (*CloudTracker) Capture

func (t *CloudTracker) Capture(ctx context.Context, event string, properties map[string]string)

func (*CloudTracker) Close

func (t *CloudTracker) Close() error

type Config

type Config struct {
	DoNotTrack bool
	Labels     telemetry.Labels
	CloudToken string
}

func DefaultConfig

func DefaultConfig(labels telemetry.Labels) Config

type Event

type Event struct {
	Timestamp  time.Time         `json:"ts,omitempty"`
	Type       string            `json:"type,omitempty"`
	Properties map[string]string `json:"properties,omitempty"`

	DeviceID string `json:"device_id,omitempty"`
	ServerID string `json:"server_id,omitempty"`

	ClientVersion string `json:"client_version,omitempty"`
	ClientOS      string `json:"client_os,omitempty"`
	ClientArch    string `json:"client_arch,omitempty"`

	CI       bool   `json:"ci"`
	CIVendor string `json:"ci_vendor,omitempty"`

	GitRemoteEncoded string `json:"git_remote_encoded,omitempty"`
	GitAuthorHashed  string `json:"git_author_hashed,omitempty"`
}

type Tracker

type Tracker interface {
	Capture(ctx context.Context, event string, properties map[string]string)
	io.Closer
}

func Ctx

func Ctx(ctx context.Context) Tracker

func New

func New(cfg Config) Tracker