Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Registry is the global mapping of all `Configurer` types. Types // are added to this mapping on import by including a call to // `Register` in their `init` function. Registry = make(map[string]Configurer) )
Functions ¶
func Register ¶
func Register(c Configurer)
Register is called by the `init` function of every `Configurer` to add the caller to the global `Registry` map. If the caller attempts to add a `Configurer` to the registry using the same name as a prior `Configurer` Observer will exit after logging an error.
Types ¶
type Configurer ¶
type Configurer interface {
// Kind returns a name that uniquely identifies the `Kind` of
// `Configurer`.
Kind() string
// UnmarshalSettings unmarshals YAML as bytes to a `Configurer`
// object.
UnmarshalSettings([]byte) (Configurer, error)
// MakeProber constructs a `Prober` object from the contents of the
// bound `Configurer` object. If the `Configurer` cannot be
// validated, an error appropriate for end-user consumption is
// returned instead. The map of `prometheus.Collector` objects passed to
// MakeProber should be the same as the return value from Instrument()
MakeProber(map[string]prometheus.Collector) (Prober, error)
// Instrument constructs any `prometheus.Collector` objects that a prober of
// the configured type will need to report its own metrics. A map is
// returned containing the constructed objects, indexed by the name of the
// prometheus metric. If no objects were constructed, nil is returned.
Instrument() map[string]prometheus.Collector
}
Configurer is the interface for `Configurer` types.
func GetConfigurer ¶
func GetConfigurer(kind string) (Configurer, error)
GetConfigurer returns the probe configurer specified by name from `Registry`.
type Prober ¶
type Prober interface {
// Name returns a name that uniquely identifies the monitor that
// configured this `Prober`.
Name() string
// Kind returns a name that uniquely identifies the `Kind` of
// `Prober`.
Kind() string
// Probe attempts the configured request or query, Each `Prober`
// must treat the duration passed to it as a timeout.
Probe(time.Duration) (bool, time.Duration)
}
Prober is the interface for `Prober` types.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.