analytics

Documentation

Index

• func AddCLIProject(org, project string)
• func AddEarthfileProject(org, project string)
• func CollectAnalytics(ctx context.Context, cloudClient *cloud.Client, displayErrors bool, meta Meta, ...)
• func Count(subsystem, key string)
• func DetectCI(isEarthlyCIRunner bool) (string, bool)
• func ProjectDetails() (string, string)
• type Counters
  • func (c *Counters) Count(subsystem, key string)
• type Meta
• type ProjectTracker
  • func (pt *ProjectTracker) AddCLIProject(org, project string)
  • func (pt *ProjectTracker) AddEarthfileProject(org, project string)
  • func (pt *ProjectTracker) ProjectDetails() (string, string)

Functions

func AddCLIProject

func AddCLIProject(org, project string)

func AddEarthfileProject

func AddEarthfileProject(org, project string)

func CollectAnalytics

func CollectAnalytics(ctx context.Context, cloudClient *cloud.Client, displayErrors bool, meta Meta, installationName string)

CollectAnalytics sends analytics to api.earthly.dev

func Count

func Count(subsystem, key string)

Count increases the global count of (subsystem, key) which then gets reported when CollectAnalytics is called.

func DetectCI

func DetectCI(isEarthlyCIRunner bool) (string, bool)

DetectCI determines if Earthly is being run from a CI environment. It returns the name of the CI tool and true if we detect one.

func ProjectDetails

func ProjectDetails() (string, string)

Types

type Counters

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

Counters is a threadsafe collection of counters

func (*Counters) Count

func (c *Counters) Count(subsystem, key string)

Count increases the global count of (subsystem, key) which then gets reported when CollectAnalytics is called.

type Meta

type Meta struct {
	Version          string
	Platform         string
	BuildkitPlatform string
	UserPlatform     string
	GitSHA           string
	CommandName      string
	ExitCode         int
	Target           domain.Target
	IsSatellite      bool
	SatelliteVersion string
	IsRemoteBuildkit bool
	Realtime         time.Duration
	OrgName          string
	ProjectName      string
	EarthlyCIRunner  bool
}

Meta holds metadata about the current run of the program.

type ProjectTracker

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

func (*ProjectTracker) AddCLIProject

func (pt *ProjectTracker) AddCLIProject(org, project string)

func (*ProjectTracker) AddEarthfileProject

func (pt *ProjectTracker) AddEarthfileProject(org, project string)

func (*ProjectTracker) ProjectDetails

func (pt *ProjectTracker) ProjectDetails() (string, string)