Documentation
¶
Overview ¶
Package prometheusbee is a bee designed to expose metrics for scraping by Prometheus.
Index ¶
- type PrometheusBee
- type PrometheusBeeFactory
- func (factory *PrometheusBeeFactory) Actions() []bees.ActionDescriptor
- func (factory *PrometheusBeeFactory) Description() string
- func (factory *PrometheusBeeFactory) ID() string
- func (factory *PrometheusBeeFactory) Image() string
- func (factory *PrometheusBeeFactory) LogoColor() string
- func (factory *PrometheusBeeFactory) Name() string
- func (factory *PrometheusBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
- func (factory *PrometheusBeeFactory) Options() []bees.BeeOptionDescriptor
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PrometheusBee ¶
PrometheusBee is a bee designed to expose metrics for scraping by Prometheus.
func (*PrometheusBee) Action ¶
func (mod *PrometheusBee) Action(action bees.Action) []bees.Placeholder
Action triggers the action passed to it.
func (*PrometheusBee) ReloadOptions ¶
func (mod *PrometheusBee) ReloadOptions(options bees.BeeOptions)
ReloadOptions parses the config options and initializes the Bee.
func (*PrometheusBee) Run ¶
func (mod *PrometheusBee) Run(eventChan chan bees.Event)
Run executes the Bee's event loop.
type PrometheusBeeFactory ¶
type PrometheusBeeFactory struct {
bees.BeeFactory
}
PrometheusBeeFactory is a factory for PrometheusBees.
func (*PrometheusBeeFactory) Actions ¶
func (factory *PrometheusBeeFactory) Actions() []bees.ActionDescriptor
Actions describes the available actions provided by this Bee.
func (*PrometheusBeeFactory) Description ¶
func (factory *PrometheusBeeFactory) Description() string
Description returns the description of this Bee.
func (*PrometheusBeeFactory) ID ¶
func (factory *PrometheusBeeFactory) ID() string
ID returns the ID of this Bee.
func (*PrometheusBeeFactory) Image ¶
func (factory *PrometheusBeeFactory) Image() string
Image returns the filename of an image for this Bee.
func (*PrometheusBeeFactory) LogoColor ¶
func (factory *PrometheusBeeFactory) LogoColor() string
LogoColor returns the preferred logo background color (used by the admin interface).
func (*PrometheusBeeFactory) Name ¶
func (factory *PrometheusBeeFactory) Name() string
Name returns the name of this Bee.
func (*PrometheusBeeFactory) New ¶
func (factory *PrometheusBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface
New returns a new Bee instance configured with the supplied options.
func (*PrometheusBeeFactory) Options ¶
func (factory *PrometheusBeeFactory) Options() []bees.BeeOptionDescriptor
Options returns the options available to configure this Bee.
Source Files