cli

Documentation

Overview

Package cli contains telemetry functions regarding the collection of data in the CLI. Should be imported as cli_telemetry.

Index

• type Option
  • func WithCLITarget(s string) Option
• type Task
  • func NewCLITelemetry(opts ...Option) Task

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is an option for the CLI telemetry.

func WithCLITarget

func WithCLITarget(s string) Option

WithCLITarget defines the URL to which the CLI data will be sent.

type Task

type Task interface {
	Run(context.Context)
}

Task is a small task that sends telemetry data once a day.

func NewCLITelemetry

func NewCLITelemetry(opts ...Option) Task

NewCLITelemetry returns a wrapper that contains the necessary methods to collect and send telemetry data regarding CLI usage.