telemetry

Documentation

Index

• Constants
• func CobraFullCommandPathMetricName(cmd *cobra.Command) string
• func DurationMetricSuffix(cmdName string) string
• func UsageMetricSuffix(cmdName string) string
• type Client
  • func NewClient(address string, clientInfo MetricClientInfo, opts ...ClientOption) Client
• type 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 NewUsageMetric(name string) Metric
• type MetricClientInfo
• type MetricRequest

Constants

const (
	DefaultTimeout = 5
)

Functions

func CobraFullCommandPathMetricName

func CobraFullCommandPathMetricName(cmd *cobra.Command) string

func DurationMetricSuffix

func DurationMetricSuffix(cmdName string) string

func UsageMetricSuffix

func UsageMetricSuffix(cmdName string) string

Types

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 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"`
}

func NewUsageMetric

func NewUsageMetric(name string) Metric

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

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"`
}

type MetricRequest

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