telemetry

Documentation

Index

• func Record(ctx context.Context, client metadata.MDSClientInterface, d Data) error
• type Data
• type Job
  • func New(client metadata.MDSClientInterface, programName, agentVersion string) *Job
  • func (j *Job) ID() string
  • func (j *Job) Interval() (time.Duration, bool)
  • func (j *Job) Run(ctx context.Context) (bool, error)
  • func (j *Job) ShouldEnable(ctx context.Context) bool

Functions

func Record

func Record(ctx context.Context, client metadata.MDSClientInterface, d Data) error

Record records telemetry data.

Types

type Data

type Data struct {
	// Name of the agent.
	AgentName string
	// Version of the Agent.
	AgentVersion string
	// Architecture of the Agent.
	AgentArch string

	// OS name.
	OS string
	// The name the OS uses to fully describe itself.
	LongName string
	// OS name in short form (aka distro name).
	ShortName string
	// Version of the OS.
	Version string
	// Kernel Release.
	KernelRelease string
	// Kernel Version.
	KernelVersion string
}

Data is telemetry data on the current agent and OS.

type Job

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

Job implements job scheduler interface for recording telemetry.

func New

func New(client metadata.MDSClientInterface, programName, agentVersion string) *Job

New initializes a new TelemetryJob.

func (*Job) ID

func (j *Job) ID() string

ID returns the ID for this job.

func (*Job) Interval

func (j *Job) Interval() (time.Duration, bool)

Interval returns the interval at which job is executed.

func (*Job) Run

func (j *Job) Run(ctx context.Context) (bool, error)

Run records telemetry data.

func (*Job) ShouldEnable

func (j *Job) ShouldEnable(ctx context.Context) bool

ShouldEnable returns true as long as DisableTelemetry is not set in metadata.