metrics

Documentation

Index

• Constants
• func GetCommand(args []string, flags *flag.FlagSet) string
• func Track(context string, args []string, flags *flag.FlagSet, status string)
• type Client
  • func NewClient() Client
• type Command

Constants

const (
	// CLISource is sent for cli metrics
	CLISource = "cli"
	// APISource is sent for API metrics
	APISource = "api"
	// SuccessStatus is sent for API metrics
	SuccessStatus = "success"
	// FailureStatus is sent for API metrics
	FailureStatus = "failure"
	// CanceledStatus is sent for API metrics
	CanceledStatus = "canceled"
)

Functions

func GetCommand

func GetCommand(args []string, flags *flag.FlagSet) string

GetCommand get the invoked command

func Track

func Track(context string, args []string, flags *flag.FlagSet, status string)

Track sends the tracking analytics to Docker Desktop

Types

type Client

type Client interface {
	// Send sends the command to Docker Desktop. Note that the function doesn't
	// return anything, not even an error, this is because we don't really care
	// if the metrics were sent or not. We only fire and forget.
	Send(Command)
}

Client sends metrics to Docker Desktopn

func NewClient

func NewClient() Client

NewClient returns a new metrics client

type Command

type Command struct {
	Command string `json:"command"`
	Context string `json:"context"`
	Source  string `json:"source"`
	Status  string `json:"status"`
}

Command is a command