telemetry

Documentation

Index

• Constants
• func Annotations(annotations Annotation) map[string]string
• func CobraFullCommandPathMetricName(cmd *cobra.Command) string
• func DurationMetricSuffix(cmdName string) string
• func HasAnnotations(annotations Annotation, values map[string]string) bool
• func Hash(value string) (string, error)
• func UsageMetricSuffix(cmdName string) string
• type Annotation
• type Client
  • func NewClient(address string, clientInfo *MetricClientInfo, opts ...ClientOption) Client
• type ClientOption
  • func WithAuthToken(token string) ClientOption
  • func WithDebug(debug bool) ClientOption
  • func WithLogger(logger *zap.Logger) ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption
• type DurationMetric
  • func NewDurationMetric(name string) DurationMetric
• type GraphQLError
• type GraphQLResponse
• type Metric
  • func DataSourceMetrics(wunderGraphDir string) ([]*Metric, error)
  • func NewDataSourceMetric(dataSourceName string) *Metric
  • func NewUsageMetric(name string) *Metric
  • func (m *Metric) AddTag(name string, value string) error
  • func (m *Metric) Equal(other *Metric) bool
• type MetricClientInfo
• type MetricRequest
• type MetricTag
  • func (m MetricTag) Equal(other MetricTag) bool

Constants

const (
	DATASOURCE_USAGE_METRIC_NAME = "WG_DATASOURCE_USAGE"
)

const (
	DefaultTimeout = 5
)

Functions

func Annotations

func Annotations(annotations Annotation) map[string]string

func CobraFullCommandPathMetricName

func CobraFullCommandPathMetricName(cmd *cobra.Command) string

func DurationMetricSuffix

func DurationMetricSuffix(cmdName string) string

func HasAnnotations

func HasAnnotations(annotations Annotation, values map[string]string) bool

func Hash

func Hash(value string) (string, error)

Hash hashes a telemetry value to anonymize it. Always use this function to ensure the hashing algorithm stays consistent

func UsageMetricSuffix

func UsageMetricSuffix(cmdName string) string

Types

type Annotation

type Annotation int

Annotation indicates which data should be reported as telemetry when a wunderctl command is ran

const (
	// AnnotationCommand indicates the annotated command usage and duration should be reported as telemetry
	AnnotationCommand Annotation = 1 << iota
	// AnnotationDataSources indicates the data sources should be reported as telemetry
	AnnotationDataSources
)

type Client

type Client interface {
	Send(metrics []*Metric) error
}

func NewClient

func NewClient(address string, clientInfo *MetricClientInfo, opts ...ClientOption) Client

type ClientOption

type ClientOption func(*client)

func WithAuthToken

func WithAuthToken(token string) ClientOption

func WithDebug

func WithDebug(debug bool) ClientOption

func WithLogger

func WithLogger(logger *zap.Logger) ClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption

type DurationMetric

type DurationMetric func() *Metric

func NewDurationMetric

func NewDurationMetric(name string) DurationMetric

NewDurationMetric starts a duration metric. The duration will be stop when PrepareBatch is called.

type GraphQLError

type GraphQLError struct {
	Message string `json:"message"`
}

type GraphQLResponse

type GraphQLResponse struct {
	Data   interface{} `json:"data"`
	Errors []GraphQLError
}

type Metric

type Metric struct {
	Name  string      `json:"name"`
	Value float64     `json:"value"`
	Tags  []MetricTag `json:"tags,omitempty"`
}

func DataSourceMetrics

func DataSourceMetrics(wunderGraphDir string) ([]*Metric, error)

func NewDataSourceMetric

func NewDataSourceMetric(dataSourceName string) *Metric

NewDataSourceMetric creates a data metric from the data source name

func NewUsageMetric

func NewUsageMetric(name string) *Metric

NewUsageMetric creates a simple metric. The value will be 1.

func (*Metric) AddTag

func (m *Metric) AddTag(name string, value string) error

AddTag adds a tag to the Metric, validating its name and ensuring there are no duplicates.

func (*Metric) Equal

func (m *Metric) Equal(other *Metric) bool

Equal returns true iff both Metric instances contain the same data (tags might be in different order)

type MetricClientInfo

type MetricClientInfo struct {
	OsName           string `json:"osName,omitempty"`
	CpuCount         int    `json:"cpuCount,omitempty"`
	IsCI             bool   `json:"isCI"`
	WunderctlVersion string `json:"wunderctlVersion,omitempty"`
	AnonymousID      string `json:"anonymousID,omitempty"`
	GitRepoURLHash   string `json:"gitRepoURLHash,omitempty"`
}

type MetricRequest

type MetricRequest struct {
	Metrics    []*Metric        `json:"metrics"`
	ClientInfo MetricClientInfo `json:"clientInfo"`
}

type MetricTag

type MetricTag struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

func (MetricTag) Equal

func (m MetricTag) Equal(other MetricTag) bool

Equal returns true iff both Name and Value are Equal