telemetry

Documentation

Index

• Variables
• func GetMachineID(cliConfig *config.CLI) string
• func GetPlatformInstanceID(cliConfig *config.CLI, self *managementv1.Self) string
• func GetPlatformUserID(cliConfig *config.CLI, self *managementv1.Self) string
• func StartCLI(cliConfig *config.CLI)
• func StartControlPlane(config *config.VirtualClusterConfig)
• type CLICollector
• type ChartInfo
• type ControlPlaneCollector
• type ErrorSeverityType
• type KubernetesVersion

Variables

var (
	SyncerVersion = "dev"
)

Functions

func GetMachineID

func GetMachineID(cliConfig *config.CLI) string

GetMachineID retrieves machine ID and encodes it together with users $HOME path and extra key to protect privacy. Returns a hex-encoded string.

func GetPlatformInstanceID

func GetPlatformInstanceID(cliConfig *config.CLI, self *managementv1.Self) string

GetPlatformInstanceID returns the loft instance id

func GetPlatformUserID

func GetPlatformUserID(cliConfig *config.CLI, self *managementv1.Self) string

GetPlatformUserID returns the loft instance id

func StartCLI

func StartCLI(cliConfig *config.CLI)

StartCLI starts collecting events and sending them to the backend from the CLI

func StartControlPlane

func StartControlPlane(config *config.VirtualClusterConfig)

Types

type CLICollector

type CLICollector interface {
	RecordCLI(cliConfig *config.CLI, self *managementv1.Self, err error)

	// Flush makes sure all events are sent to the backend
	Flush()
}

var CollectorCLI CLICollector = &noopCollector{}

type ChartInfo

type ChartInfo struct {
	Values  *config.VirtualClusterConfig
	Name    string
	Version string
}

type ControlPlaneCollector

type ControlPlaneCollector interface {
	RecordStart(ctx context.Context, config *config.VirtualClusterConfig)
	RecordError(ctx context.Context, config *config.VirtualClusterConfig, severity ErrorSeverityType, err error)

	// Flush makes sure all events are sent to the backend
	Flush()

	SetVirtualClient(virtualClient kubernetes.Interface)
}

var CollectorControlPlane ControlPlaneCollector = &noopCollector{}

type ErrorSeverityType

type ErrorSeverityType string

const (
	WarningSeverity ErrorSeverityType = "warning"
	ErrorSeverity   ErrorSeverityType = "error"
	FatalSeverity   ErrorSeverityType = "fatal"
	PanicSeverity   ErrorSeverityType = "panic"
)

type KubernetesVersion

type KubernetesVersion struct {
	Major      string `json:"major"`
	Minor      string `json:"minor"`
	GitVersion string `json:"gitVersion"`
}