telemetry

Documentation

Index

• Constants
• Variables
• func AnonymizeHost(host string) string
• func GetMachineID() string
• func GoogleAnalyticsSender(client *http.Client, payload Payload) (out string, err error)
• func SegmentioSender(client *http.Client, payload Payload) (out string, err error)
• func SendCmdEvent(cmd *cobra.Command, version string) (string, error)
• func SendCmdInitEvent(cmd *cobra.Command, version string) (string, error)
• func SendHeartbeatEvent(host, version, clusterId string) (string, error)
• func SendServerStartEvent(clusterId, version string) (string, error)
• func TestkubeAnalyticsSender(client *http.Client, payload Payload) (out string, err error)
• type Event
• type Params
• type Payload
  • func NewAPIPayload(clusterId, name, version, host string) Payload
  • func NewCLIPayload(id, name, version, category string) Payload
• type Sender

Constants

const (
	APIHostLocal            = "local"
	APIHostExternal         = "external"
	APIHostTestkubeInternal = "testkube-internal"
)

const SegmentioEnvVariableName = "TESTKUBE_SEGMENTIO_KEY"

Variables

var (
	TestkubeMeasurementID     = "" //this is default but it can be set using ldflag -X github.com/kubeshop/testkube/pkg/telemetry.TestkubeMeasurementID=G-B6KY2SF30K
	TestkubeMeasurementSecret = ""
)

var SegmentioKey = "iL0p6r5C9i35F7tRxnB0k3gB2nGh7VTK"

Brew builds can't be parametrized so we are embedding this one

Functions

func AnonymizeHost

func AnonymizeHost(host string) string

func GetMachineID

func GetMachineID() string

GetMachineID returns unique user machine ID

func GoogleAnalyticsSender

func GoogleAnalyticsSender(client *http.Client, payload Payload) (out string, err error)

func SegmentioSender

func SegmentioSender(client *http.Client, payload Payload) (out string, err error)

SegmentioSender sends ananymous telemetry data to segment.io TODO refactor Sender func as out is not needed (use debug loggers to log output)

func SendCmdEvent

func SendCmdEvent(cmd *cobra.Command, version string) (string, error)

SendCmdEvent will send CLI event to GA

func SendCmdInitEvent

func SendCmdInitEvent(cmd *cobra.Command, version string) (string, error)

SendCmdInitEvent will send CLI event to GA

func SendHeartbeatEvent

func SendHeartbeatEvent(host, version, clusterId string) (string, error)

SendHeartbeatEvent will send CLI event to GA

func SendServerStartEvent

func SendServerStartEvent(clusterId, version string) (string, error)

SendServerStartEvent will send event to GA

func TestkubeAnalyticsSender

func TestkubeAnalyticsSender(client *http.Client, payload Payload) (out string, err error)

Types

type Event

type Event struct {
	Name   string `json:"name"`
	Params Params `json:"params,omitempty"`
}

type Params

type Params struct {
	EventCount       int64  `json:"event_count,omitempty"`
	EventCategory    string `json:"event_category,omitempty"`
	AppVersion       string `json:"app_version,omitempty"`
	AppName          string `json:"app_name,omitempty"`
	CustomDimensions string `json:"custom_dimensions,omitempty"`
	DataSource       string `json:"data_source,omitempty"`
	Host             string `json:"host,omitempty"`
	MachineID        string `json:"machine_id,omitempty"`
	ClusterID        string `json:"cluster_id,omitempty"`
	OperatingSystem  string `json:"operating_system,omitempty"`
	Architecture     string `json:"architecture,omitempty"`
}

type Payload

type Payload struct {
	UserID   string  `json:"user_id,omitempty"`
	ClientID string  `json:"client_id,omitempty"`
	Events   []Event `json:"events,omitempty"`
}

func NewAPIPayload

func NewAPIPayload(clusterId, name, version, host string) Payload

func NewCLIPayload

func NewCLIPayload(id, name, version, category string) Payload

type Sender

type Sender func(client *http.Client, payload Payload) (out string, err error)