telemetry

Documentation

Index

• type Client
  • func NewClient(sdkClient *dotenv.Client, analyticsID string) *Client
  • func (c *Client) Close() error
  • func (c *Client) IsEnabled() bool
  • func (c *Client) SetEnabled(enabled bool)
  • func (c *Client) Track(name string, properties map[string]interface{}) error
  • func (c *Client) TrackCommand(command string, duration time.Duration, success bool)
  • func (c *Client) TrackError(command string, err error)
• type Collector
• type Context
• type Event

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client handles telemetry data collection and submission

func NewClient

func NewClient(sdkClient *dotenv.Client, analyticsID string) *Client

NewClient creates a new telemetry client

func (*Client) Close

func (c *Client) Close() error

Close shuts down the telemetry client

func (*Client) IsEnabled

func (c *Client) IsEnabled() bool

IsEnabled returns whether telemetry is enabled

func (*Client) SetEnabled

func (c *Client) SetEnabled(enabled bool)

SetEnabled enables or disables telemetry collection

func (*Client) Track

func (c *Client) Track(name string, properties map[string]interface{}) error

Track records a telemetry event

func (*Client) TrackCommand

func (c *Client) TrackCommand(command string, duration time.Duration, success bool)

TrackCommand tracks a command execution

func (*Client) TrackError

func (c *Client) TrackError(command string, err error)

TrackError tracks an error event with sanitized information

type Collector

type Collector interface {
	Track(event string, properties map[string]interface{}) error
	SetEnabled(enabled bool)
	IsEnabled() bool
}

Collector handles telemetry data collection

type Context

type Context struct {
	OS          string `json:"os"`
	Arch        string `json:"arch"`
	Version     string `json:"version"`
	CI          bool   `json:"ci"`
	SessionID   string `json:"session_id"`
	AnalyticsID string `json:"analytics_id,omitempty"`
}

Context contains telemetry context information

type Event

type Event struct {
	ID         string                 `json:"id"`
	Name       string                 `json:"name"`
	Properties map[string]interface{} `json:"properties"`
	Context    Context                `json:"context"`
	Timestamp  time.Time              `json:"timestamp"`
}

Event represents a telemetry event