bundle

Documentation

Index

• Constants
• Variables
• type API
• type Bundle
  • func New(client API) (*Bundle, error)
  • func (cb *Bundle) CID() (string, error)
  • func (cb *Bundle) CheckCID(idx uint) (string, error)
  • func (cb *Bundle) EnableNewMetrics(m *cgm.Metrics) error
  • func (cb *Bundle) Info() (*Info, error)
  • func (cb *Bundle) Period() (uint, error)
  • func (cb *Bundle) Refresh() error
• type ErrNotActive
  • func (e *ErrNotActive) Error() string
• type Info

Constants

const (
	StatusActive = "active"
)

Variables

var ErrUninitialized = errors.New("uninitialized check bundle")

Types

type API

type API interface {
	CreateCheckBundle(cfg *apiclient.CheckBundle) (*apiclient.CheckBundle, error)
	FetchBroker(cid apiclient.CIDType) (*apiclient.Broker, error)
	FetchBrokers() (*[]apiclient.Broker, error)
	FetchCheck(cid apiclient.CIDType) (*apiclient.Check, error)
	FetchCheckBundle(cid apiclient.CIDType) (*apiclient.CheckBundle, error)
	FetchCheckBundleMetrics(cid apiclient.CIDType) (*apiclient.CheckBundleMetrics, error)
	Get(url string) ([]byte, error)
	SearchCheckBundles(searchCriteria *apiclient.SearchQueryType, filterCriteria *apiclient.SearchFilterType) (*[]apiclient.CheckBundle, error)
	UpdateCheckBundle(cfg *apiclient.CheckBundle) (*apiclient.CheckBundle, error)
	UpdateCheckBundleMetrics(cfg *apiclient.CheckBundleMetrics) (*apiclient.CheckBundleMetrics, error)
}

API interface abstraction of circonus api (for mocking)

type Bundle

type Bundle struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Bundle exposes the check bundle management interface

func New

func New(client API) (*Bundle, error)

func (*Bundle) CID

func (cb *Bundle) CID() (string, error)

CID returns the check bundle cid

func (*Bundle) CheckCID

func (cb *Bundle) CheckCID(idx uint) (string, error)

CheckCID returns the check cid at the passed index within the check bundle's checks array or an error if bundle not initialized

func (*Bundle) EnableNewMetrics

func (cb *Bundle) EnableNewMetrics(m *cgm.Metrics) error

EnableNewMetrics updates the check bundle enabling any new metrics

func (*Bundle) Info

func (cb *Bundle) Info() (*Info, error)

Info returns information about the check bundle (the check bundle cid and list of check cids)

func (*Bundle) Period

func (cb *Bundle) Period() (uint, error)

Period returns check bundle period (intetrval between when broker should make requests)

func (*Bundle) Refresh

func (cb *Bundle) Refresh() error

Refresh re-loads the check bundle using the API (sets metric states if check bundle is managed)

type ErrNotActive

type ErrNotActive struct {
	Err      string
	Checks   string
	BundleID string
	Status   string
}

func (*ErrNotActive) Error

func (e *ErrNotActive) Error() string

type Info

type Info struct {
	CID    string
	Checks []string
	UUIDs  []string
}