check

Documentation

Overview

Package check handles check and broker management

Index

• Constants
• type API
• type Check
  • func New(apiClient API) (*Check, error)
  • func (c *Check) CheckMeta() (*Meta, error)
  • func (c *Check) CheckPeriod() (uint, error)
  • func (c *Check) EnableNewMetrics(m *cgm.Metrics) error
  • func (c *Check) FetchBrokerConfig() error
  • func (c *Check) FetchCheckConfig() error
  • func (c *Check) FindPrimaryBrokerInstance(cfgs *ReverseConfigs) (string, error)
  • func (c *Check) GetReverseConfigs() (*ReverseConfigs, error)
  • func (c *Check) RefreshReverseConfig() error
• type ErrInvalidOwner
  • func (e *ErrInvalidOwner) Error() string
• type ErrNoOwnerFound
  • func (e *ErrNoOwnerFound) Error() string
• type ErrNotActive
  • func (e *ErrNotActive) Error() string
• type Meta
• type ReverseConfig
• type ReverseConfigs

Constants

const (
	StatusActive      = "active"
	PrimaryCheckIndex = 0
)

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 Check

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

Check exposes the check bundle management interface

func New

func New(apiClient API) (*Check, error)

New returns a new check instance

func (*Check) CheckMeta

func (c *Check) CheckMeta() (*Meta, error)

CheckMeta returns check id, check bundle id, and check uuid

func (*Check) CheckPeriod

func (c *Check) CheckPeriod() (uint, error)

CheckPeriod returns check bundle period (intetrval between when broker should make request)

func (*Check) EnableNewMetrics

func (c *Check) EnableNewMetrics(m *cgm.Metrics) error

EnableNewMetrics updates the check bundle enabling any new metrics

func (*Check) FetchBrokerConfig

func (c *Check) FetchBrokerConfig() error

FetchBrokerConfig re-loads the broker using the API

func (*Check) FetchCheckConfig

func (c *Check) FetchCheckConfig() error

FetchCheckConfig re-loads the check using the API

func (*Check) FindPrimaryBrokerInstance

func (c *Check) FindPrimaryBrokerInstance(cfgs *ReverseConfigs) (string, error)

FindPrimaryBrokerInstance will walk through reverse urls to locate the instance in a broker cluster which is the current check owner. Returns the instance cn or error.

func (*Check) GetReverseConfigs

func (c *Check) GetReverseConfigs() (*ReverseConfigs, error)

GetReverseConfigs returns the reverse connection configuration(s) to use for the check

func (*Check) RefreshReverseConfig

func (c *Check) RefreshReverseConfig() error

RefreshReverseConfig refreshes the check, broker and broker tls configurations

type ErrInvalidOwner

type ErrInvalidOwner struct {
	Err      string
	CheckID  string
	BrokerCN string
}

func (*ErrInvalidOwner) Error

func (e *ErrInvalidOwner) Error() string

type ErrNoOwnerFound

type ErrNoOwnerFound struct {
	Err     string
	CheckID string
}

func (*ErrNoOwnerFound) Error

func (e *ErrNoOwnerFound) Error() string

type ErrNotActive

type ErrNotActive struct {
	Err      string
	CheckID  string
	BundleID string
}

func (*ErrNotActive) Error

func (e *ErrNotActive) Error() string

type Meta

type Meta struct {
	BundleID  string
	CheckUUID string
	CheckID   string
}

Meta contains check id meta data

type ReverseConfig

type ReverseConfig struct {
	CN         string
	BrokerAddr *net.TCPAddr
	BrokerID   string
	ReverseURL *url.URL
	TLSConfig  *tls.Config
}

ReverseConfig contains the reverse configuration for the check

type ReverseConfigs

type ReverseConfigs map[string]ReverseConfig