checkmgr

type BrokerCNType string

type BrokerConfig struct {
	// TLS configuration to use when communicating within broker
	TLSConfig *tls.Config
	// a specific broker id (numeric portion of cid)
	ID string
	// one or more tags used to select 1-n brokers from which to select
	// when creating a new check (e.g. datacenter:abc or loc:dfw,dc:abc)
	SelectTag string
	// for a broker to be considered viable it must respond to a
	// connection attempt within this amount of time e.g. 200ms, 2s, 1m
	MaxResponseTime string
}

type CACert struct {
	Contents string `json:"contents"`
}

type CheckConfig struct {
	// a specific submission url
	SubmissionURL string
	// a specific check id (not check bundle id)
	ID string
	// unique instance id string
	// used to search for a check to use
	// used as check.target when creating a check
	InstanceID string
	// explicitly set check.target (default: instance id)
	TargetHost string
	// a custom display name for the check (as viewed in UI Checks)
	// default: instance id
	DisplayName string
	// unique check searching tag (or tags)
	// used to search for a check to use (combined with instanceid)
	// used as a regular tag when creating a check
	SearchTag string
	// httptrap check secret (for creating a check)
	Secret string
	// additional tags to add to a check (when creating a check)
	// these tags will not be added to an existing check
	Tags string
	// max amount of time to to hold on to a submission url
	// when a given submission fails (due to retries) if the
	// time the url was last updated is > than this, the trap
	// url will be refreshed (e.g. if the broker is changed
	// in the UI) **only relevant when check management is enabled**
	// e.g. 5m, 30m, 1h, etc.
	MaxURLAge string
	// Type of check to use (default: httptrap)
	Type string
	// force metric activation - if a metric has been disabled via the UI
	// the default behavior is to *not* re-activate the metric; this setting
	// overrides the behavior and will re-activate the metric when it is
	// encountered. "(true|false)", default "false"
	// NOTE: ONLY applies to checks without metric_filters
	ForceMetricActivation string
	// Custom check config fields (default: none)
	CustomConfigFields map[string]string
	// MetricFilters list of regular expression filters defining what metrics
	// will be automatically enabled. These are evaluated in order and the first
	// match stops evaluation. Default []MetricFilter{{"deny","^$",""},{"allow","^.+$",""}}
	MetricFilters []MetricFilter
}

type CheckDisplayNameType string

type CheckInstanceIDType string

type CheckManager struct {
	Log Logger // general

	Debug bool // general
	// contains filtered or unexported fields
}

type CheckSecretType string

type CheckTagsType string

type CheckTargetType string

type CheckTypeType string

type Config struct {
	Log        Logger
	Broker     BrokerConfig     // Broker specific configuration options
	Check      CheckConfig      // Check specific configuration options
	API        apiclient.Config // Circonus API config
	SerialInit bool             // serial initialization (not background)
	Debug      bool
}

type Logger interface {
	Printf(string, ...interface{})
}

type MetricFilter struct {
	// Type of rule 'allow' or 'deny'
	Type string
	// Filter is a valid PCRE regular expression matching 1-n metrics
	Filter string
	// Comment for the rule
	Comment string
}

type Trap struct {
	URL           *url.URL
	TLS           *tls.Config
	SockTransport *httpunix.Transport
	IsSocket      bool
}