telemetry

package

v1.2.42 Latest Latest Go to latest Published: Jun 30, 2022 License: MIT Imports: 18 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubeshop/testkube

Links

Open Source Insights

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() (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 ¶

View Source

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

View Source

const SegmentioEnvVariableName = "TESTKUBE_SEGMENTIO_KEY"

Variables ¶

View Source

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

View Source

var SegmentioKey = "iL0p6r5C9i35F7tRxnB0k3gB2nGh7VTK"

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

Functions ¶

func AnonymizeHost ¶ added in v1.2.34

func AnonymizeHost(host string) string

func GetMachineID ¶ added in v1.2.34

func GetMachineID() string

GetMachineID returns unique user machine ID

func GoogleAnalyticsSender ¶ added in v1.2.34

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

func SegmentioSender ¶ added in v1.2.38

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 ¶ added in v1.2.34

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

SendCmdEvent will send CLI event to GA

func SendCmdInitEvent ¶ added in v1.2.34

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

SendCmdInitEvent will send CLI event to GA

func SendHeartbeatEvent ¶ added in v1.2.34

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

SendHeartbeatEvent will send CLI event to GA

func SendServerStartEvent ¶ added in v1.2.34

func SendServerStartEvent() (string, error)

SendServerStartEvent will send event to GA

func TestkubeAnalyticsSender ¶ added in v1.2.34

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

Types ¶

type Event ¶ added in v1.2.34

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

type Params ¶ added in v1.2.34

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 ¶ added in v1.2.34

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

func NewAPIPayload ¶ added in v1.2.34

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

func NewCLIPayload ¶ added in v1.2.34

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

type Sender ¶ added in v1.2.34

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL