telemetry

Documentation

Index

• Constants
• Variables
• func AnonymizeHost(host string) string
• func GetClusterType() 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 SendCreateEvent(event string, params CreateParams) (string, error)
• func SendHeartbeatEvent(host, version, clusterId string) (string, error)
• func SendRunEvent(event string, params RunParams) (string, error)
• func SendServerStartEvent(clusterId, version string) (string, error)
• func TestkubeAnalyticsSender(client *http.Client, payload Payload) (out string, err error)
• type CreateParams
• type Event
• type Params
• type Payload
  • func NewAPIPayload(clusterId, name, version, host, clusterType string) Payload
  • func NewCLIPayload(context RunContext, id, name, version, category, clusterType string) Payload
  • func NewCreatePayload(name, clusterType string, params CreateParams) Payload
  • func NewRunPayload(name, clusterType string, params RunParams) Payload
• type RunContext
• type RunParams
• type Sender

Constants

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

const CloudEnvVariableName = "TESTKUBE_CLOUD_API_KEY"

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 CloudSegmentioKey = ""

var SegmentioKey = "jELokNFNcLeQhxdpGF47PcxCtOLpwVuu"

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

Functions

func AnonymizeHost

func AnonymizeHost(host string) string

func GetClusterType

func GetClusterType() 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 SendCreateEvent

func SendCreateEvent(event string, params CreateParams) (string, error)

SendCreateEvent will send API create event for Test or Test suite to GA

func SendHeartbeatEvent

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

SendHeartbeatEvent will send CLI event to GA

func SendRunEvent

func SendRunEvent(event string, params RunParams) (string, error)

SendCreateEvent will send API run event for Test or Test suite 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 CreateParams

type CreateParams struct {
	AppVersion     string
	DataSource     string
	Host           string
	ClusterID      string
	TestType       string
	TestSource     string
	TestSuiteSteps int32
}

CreateParams contains Test or Test suite creation parameters

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"`
	TestType         string     `json:"test_type,omitempty"`
	DurationMs       int32      `json:"duration_ms,omitempty"`
	Status           string     `json:"status,omitempty"`
	TestSource       string     `json:"test_source,omitempty"`
	TestSuiteSteps   int32      `json:"test_suite_steps,omitempty"`
	Context          RunContext `json:"context,omitempty"`
	ClusterType      string     `json:"cluster_type,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, clusterType string) Payload

func NewCLIPayload

func NewCLIPayload(context RunContext, id, name, version, category, clusterType string) Payload

func NewCreatePayload

func NewCreatePayload(name, clusterType string, params CreateParams) Payload

NewCreatePayload prepares payload for Test or Test suite creation

func NewRunPayload

func NewRunPayload(name, clusterType string, params RunParams) Payload

NewRunPayload prepares payload for Test or Test suite execution

type RunContext

type RunContext struct {
	Type           string
	OrganizationId string
	EnvironmentId  string
}

type RunParams

type RunParams struct {
	AppVersion string
	DataSource string
	Host       string
	ClusterID  string
	TestType   string
	DurationMs int32
	Status     string
}

RunParams contains Test or Test suite run parameters

type Sender

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