telemetry

Documentation

Index

• Variables
• func AppendOption(opt EventOpt)
• func FinishTrackingCommand(opt TrackOptions)
• func NewContext() context.Context
• func StartTrackingCommand(cmd *cobra.Command, args []string)
• func StartedTrackingCommand() bool
• func TrackAsk(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error
• func TrackAskOne(p survey.Prompt, response interface{}, opts ...survey.AskOpt) error
• type Authenticator
• type CmdFlags
• type CmdName
• type ConfigNameGetter
• type Event
• type EventOpt
  • func WithDeploymentType(t string) EventOpt
• type OrgIDGetter
• type Printer
• type ProjectIDGetter
• type ServiceGetter
• type SkipUpdateGetter
• type TrackOptions

Variables

var (
	ErrNotMapOrStruct = errors.New("invalid response: expected a struct or map[string]interface{}")
	ErrFieldNotFound  = errors.New("field not found")
)

Functions

func AppendOption

func AppendOption(opt EventOpt)

func FinishTrackingCommand

func FinishTrackingCommand(opt TrackOptions)

func NewContext

func NewContext() context.Context

func StartTrackingCommand

func StartTrackingCommand(cmd *cobra.Command, args []string)

func StartedTrackingCommand

func StartedTrackingCommand() bool

func TrackAsk

func TrackAsk(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error

func TrackAskOne

func TrackAskOne(p survey.Prompt, response interface{}, opts ...survey.AskOpt) error

Types

type Authenticator

type Authenticator interface {
	PublicAPIKey() string
	PrivateAPIKey() string
	AccessToken() string
}

type CmdFlags

type CmdFlags interface {
	Flags() *pflag.FlagSet
}

type CmdName

type CmdName interface {
	CommandPath() string
	CalledAs() string
}

type ConfigNameGetter

type ConfigNameGetter interface {
	Name() string
}

type Event

type Event struct {
	Timestamp  time.Time              `json:"timestamp"`
	Source     string                 `json:"source"`
	Properties map[string]interface{} `json:"properties"`
}

type EventOpt

type EventOpt func(Event)

func WithDeploymentType

func WithDeploymentType(t string) EventOpt

type OrgIDGetter

type OrgIDGetter interface {
	OrgID() string
}

type Printer

type Printer interface {
	OutOrStdout() io.Writer
}

type ProjectIDGetter

type ProjectIDGetter interface {
	ProjectID() string
}

type ServiceGetter

type ServiceGetter interface {
	Service() string
	OpsManagerURL() string
}

type SkipUpdateGetter

type SkipUpdateGetter interface {
	SkipUpdateCheck() bool
}

type TrackOptions

type TrackOptions struct {
	Err    error
	Signal string
}