telemetry

Documentation

Index

• Variables
• func GetMachineID(log log.Logger) string
• func GetPlatformInstanceID(self *managementv1.Self) string
• func GetPlatformUserID(self *managementv1.Self) string
• func Start(isCli bool)
• type ChartInfo
• type Config
• type DefaultCollector
  • func NewDefaultCollector(config Config, isCli bool) (*DefaultCollector, error)
  • func (d *DefaultCollector) Flush()
  • func (d *DefaultCollector) Init(currentNamespaceConfig *rest.Config, currentNamespace string, ...)
  • func (d *DefaultCollector) RecordCLI(self *managementv1.Self, err error)
  • func (d *DefaultCollector) RecordError(ctx context.Context, severity ErrorSeverityType, err error)
  • func (d *DefaultCollector) RecordStart(ctx context.Context)
  • func (d *DefaultCollector) RecordStatus(ctx context.Context)
  • func (d *DefaultCollector) SetVirtualClient(virtualClient *kubernetes.Clientset)
• type ErrorSeverityType
• type EventCollector
• type KubernetesVersion
• type StrBool
  • func (f *StrBool) UnmarshalJSON(data []byte) error

Variables

var (
	// ErrUnsupportedType is returned if the type is not implemented
	ErrUnsupportedType = errors.New("unsupported type")
)

var (
	SyncerVersion = "dev"
)

Functions

func GetMachineID

func GetMachineID(log log.Logger) 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(self *managementv1.Self) string

GetPlatformInstanceID returns the loft instance id

func GetPlatformUserID

func GetPlatformUserID(self *managementv1.Self) string

GetPlatformUserID returns the loft instance id

func Start

func Start(isCli bool)

Start starts collecting events and sending them to the backend

Types

type ChartInfo

type ChartInfo struct {
	Name    string
	Version string

	Values map[string]interface{}
}

type Config

type Config struct {
	Disabled           StrBool `json:"disabled,omitempty"`
	InstanceCreator    string  `json:"instanceCreator,omitempty"`
	PlatformUserID     string  `json:"platformUserID,omitempty"`
	PlatformInstanceID string  `json:"platformInstanceID,omitempty"`
	MachineID          string  `json:"machineID,omitempty"`
}

type DefaultCollector

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

func NewDefaultCollector

func NewDefaultCollector(config Config, isCli bool) (*DefaultCollector, error)

func (*DefaultCollector) Flush

func (d *DefaultCollector) Flush()

func (*DefaultCollector) Init

func (d *DefaultCollector) Init(currentNamespaceConfig *rest.Config, currentNamespace string, options *options.VirtualClusterOptions)

func (*DefaultCollector) RecordCLI

func (d *DefaultCollector) RecordCLI(self *managementv1.Self, err error)

func (*DefaultCollector) RecordError

func (d *DefaultCollector) RecordError(ctx context.Context, severity ErrorSeverityType, err error)

func (*DefaultCollector) RecordStart

func (d *DefaultCollector) RecordStart(ctx context.Context)

func (*DefaultCollector) RecordStatus

func (d *DefaultCollector) RecordStatus(ctx context.Context)

func (*DefaultCollector) SetVirtualClient

func (d *DefaultCollector) SetVirtualClient(virtualClient *kubernetes.Clientset)

type ErrorSeverityType

type ErrorSeverityType string

const (
	ConfigEnvVar = "VCLUSTER_TELEMETRY_CONFIG"

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

type EventCollector

type EventCollector interface {
	RecordStart(ctx context.Context)
	RecordError(ctx context.Context, severity ErrorSeverityType, err error)
	RecordCLI(self *managementv1.Self, err error)

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

	Init(currentNamespaceConfig *rest.Config, currentNamespace string, options *options.VirtualClusterOptions)
	SetVirtualClient(virtualClient *kubernetes.Clientset)
}

var (
	Collector EventCollector = &noopCollector{}
)

type KubernetesVersion

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

type StrBool

type StrBool string

func (*StrBool) UnmarshalJSON

func (f *StrBool) UnmarshalJSON(data []byte) error

UnmarshalJSON parses fields that may be numbers or booleans.