usage

Documentation

Index

• Variables
• type Client
  • func NewClient(enabled bool) *Client
  • func (c *Client) Close() error
  • func (c *Client) Collect(subject string, opts ...Option)
• type Option
  • func Artifacts(art config.Artifacts) Option
  • func Flags(flags *pflag.FlagSet) Option
  • func Framework(name, version string) Option
  • func NPM(npm config.Npm) Option
  • func Node(version string) Option
  • func NumSuites(n int) Option
  • func Reporters(reporters config.Reporters) Option
  • func SauceConfig(c config.SauceConfig) Option
  • func Sharding(shardTypes []string, shardOpts map[string]bool) Option
  • func SmartRetry(isSmartRetried bool) Option
• type Properties

Variables

var DefaultClient = NewClient(true)

DefaultClient is the default preconfigured instance of Client.

Types

type Client

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

Client is a thin wrapper around analytics.Client.

func NewClient

func NewClient(enabled bool) *Client

NewClient creates a new instance of Client.

func (*Client) Close

func (c *Client) Close() error

Close closes the underlying client.

func (*Client) Collect

func (c *Client) Collect(subject string, opts ...Option)

Collect reports the usage of subject along with its attached metadata that is props.

type Option

type Option func(Properties)

Option is a function that configures a Properties instance.

func Artifacts

func Artifacts(art config.Artifacts) Option

func Flags

func Flags(flags *pflag.FlagSet) Option

func Framework

func Framework(name, version string) Option

func NPM

func NPM(npm config.Npm) Option

func Node

func Node(version string) Option

func NumSuites

func NumSuites(n int) Option

func Reporters

func Reporters(reporters config.Reporters) Option

func SauceConfig

func SauceConfig(c config.SauceConfig) Option

func Sharding

func Sharding(shardTypes []string, shardOpts map[string]bool) Option

func SmartRetry

func SmartRetry(isSmartRetried bool) Option

type Properties

type Properties = analytics.Properties

Properties is a scoped data transfer object for usage reporting and contains usage event related data.