scout

Documentation

Index

• func GetInstallMechanism(ctx context.Context, execPath string) string
• type Scout
  • func NewScout(ctx context.Context, mode string) (s *Scout)
  • func (s *Scout) Report(ctx context.Context, action string, meta ...ScoutMeta)
  • func (s *Scout) SetMetadatum(key string, value interface{})
• type ScoutMeta
• type ScoutReport

Functions

func GetInstallMechanism

func GetInstallMechanism(ctx context.Context, execPath string) string

GetInstallMechanism returns how the binary was installed based on its location.

Types

type Scout

type Scout struct {
	Reporter *metriton.Reporter
	// contains filtered or unexported fields
}

Scout is a Metriton reported

func NewScout

func NewScout(ctx context.Context, mode string) (s *Scout)

NewScout creates a new initialized Scout instance that can be used to send telepresence reports to Metriton

func (*Scout) Report

func (s *Scout) Report(ctx context.Context, action string, meta ...ScoutMeta)

Report constructs and sends a report. It includes the fixed (growing) set of metadata in the Scout structure and the pairs passed as arguments to this call. It also includes and increments the index, which can be used to determine the correct order of reported events for this installation attempt (correlated by the trace_id set at the start).

func (*Scout) SetMetadatum

func (s *Scout) SetMetadatum(key string, value interface{})

SetMetadatum associates the given key with the given value in the metadata of this instance. It's an error if the key already exists.

type ScoutMeta

type ScoutMeta struct {
	Key   string
	Value interface{}
}

ScoutMeta is a key/value association used when reporting

type ScoutReport

type ScoutReport struct {
	Action             string
	Metadata           map[string]interface{}
	PersistentMetadata map[string]interface{}
}