agent

Documentation

Overview

Package agent contains code for pushing metric indicators to reliably entity api

Index

• func LabelsFromPairs(selector string) ([]entities.Labels, error)
• func SelectorFromPairs(selector string) (string, error)
• func SetLogger(l Logger)
• func ValidateBase64Selector(selector string) (string, error)
• type Error
  • func (e *Error) Error() string
• type ErrorHandler
• type ExitSignal
• type IndicatorHandler
• type Job
  • func NewJob(interval int64, objectives []*entities.Objective) *Job
  • func (j *Job) Do()
  • func (j *Job) ErrorFunc(f ErrorHandler) *Job
  • func (j *Job) IndicatorFunc(f IndicatorHandler) *Job
• type Labels
  • func (l Labels) String() string
• type Logger

Functions

func LabelsFromPairs

func LabelsFromPairs(selector string) ([]entities.Labels, error)

func SelectorFromPairs

func SelectorFromPairs(selector string) (string, error)

func SetLogger

func SetLogger(l Logger)

Logger - set Logger for the agent

func ValidateBase64Selector

func ValidateBase64Selector(selector string) (string, error)

checks for and validates base64 encoded selectors

Types

type Error

type Error struct {
	Objective *entities.Objective
	// contains filtered or unexported fields
}

Error - agent error type used to associate failed objectives with its given error

func (*Error) Error

func (e *Error) Error() string

Error - impl error interface

type ErrorHandler

type ErrorHandler func(*Error)

ErrorHandler - type used to handle errors in Job

type ExitSignal

type ExitSignal struct{}

ExitSignal - empty struct type used to trigger agent Job close

type IndicatorHandler

type IndicatorHandler func(*entities.Indicator) error

IndicatorHandler - type used to handle indicators after they are generated

type Job

type Job struct {
	// The number of seconds between indicator calculations and pushing
	Interval int64

	// Objectives - The objectives to create indicators from
	Objectives []*entities.Objective
	// contains filtered or unexported fields
}

Job - an Agent job defines the objectives and handlers for generating indicators.

func NewJob

func NewJob(interval int64, objectives []*entities.Objective) *Job

NewJob - creates a new agent job If the interval is set to 0, the Job will run a single iteration

func (*Job) Do

func (j *Job) Do()

Do - run job

func (*Job) ErrorFunc

func (j *Job) ErrorFunc(f ErrorHandler) *Job

ErrorFunc - set the job ErrorHandler value

func (*Job) IndicatorFunc

func (j *Job) IndicatorFunc(f IndicatorHandler) *Job

IndicatorFunc - set the job IndicatorHandler value

type Labels

type Labels entities.Labels

func (Labels) String

func (l Labels) String() string

type Logger

type Logger interface {
	Infof(format string, args ...interface{})
	Info(args ...interface{})

	Debugf(format string, args ...interface{})
	Debug(args ...interface{})

	Warnf(format string, args ...interface{})
	Warn(args ...interface{})

	Errorf(format string, args ...interface{})
	Error(args ...interface{})
}

Logger - interface used to fascilitate logging within the agent