ceilometer.agent.plugin_base
Module¶Base class for plugins.
ceilometer.agent.plugin_base.
DiscoveryBase
(conf)[source]¶Bases: object
discover
(manager, param=None)[source]¶Discover resources to monitor.
The most fine-grained discovery should be preferred, so the work is the most evenly distributed among multiple agents (if they exist).
For example: if the pollster can separately poll individual resources, it should have its own discovery implementation to discover those resources. If it can only poll per-tenant, then the TenantDiscovery should be used. If even that is not possible, use EndpointDiscovery (see their respective docstrings).
Parameters: |
|
---|
ceilometer.agent.plugin_base.
ExchangeTopics
(exchange, topics)¶Bases: tuple
ceilometer.agent.plugin_base.
ExtensionLoadError
[source]¶Bases: exceptions.Exception
Error of loading pollster plugin.
PollsterBase provides a hook, setup_environment, called in pollster loading to setup required HW/SW dependency. Any exception from it would be propagated as ExtensionLoadError, then skip loading this pollster.
ceilometer.agent.plugin_base.
NotificationBase
(manager)[source]¶Bases: ceilometer.agent.plugin_base.PluginBase
Base class for plugins that support the notification API.
audit
(notifications)¶RPC endpoint for useless notification level
critical
(notifications)¶RPC endpoint for useless notification level
debug
(notifications)¶RPC endpoint for useless notification level
error
(notifications)¶RPC endpoint for useless notification level
get_targets
(conf)[source]¶Return a sequence of oslo.messaging.Target.
Sequence is defining the exchange and topics to be connected for this plugin. :param conf: Configuration.
info
(notifications)[source]¶RPC endpoint for notification messages at info level
When another service sends a notification over the message bus, this method receives it.
Parameters: | notifications – list of notifications |
---|
process_notification
(message)[source]¶Return a sequence of Counter instances for the given message.
Parameters: | message – Message to process. |
---|
sample
(notifications)[source]¶RPC endpoint for notification messages at sample level
When another service sends a notification over the message bus at sample priority, this method receives it.
Parameters: | notifications – list of notifications |
---|
to_samples_and_publish
(notification)[source]¶Return samples produced by process_notification.
Samples produced for the given notification. :param context: Execution context from the service or RPC call :param notification: The notification to process.
warn
(notifications)¶RPC endpoint for useless notification level
ceilometer.agent.plugin_base.
PollsterBase
(conf)[source]¶Bases: ceilometer.agent.plugin_base.PluginBase
Base class for plugins that support the polling API.
build_pollsters
(conf)[source]¶Return a list of tuple (name, pollster).
The name is the meter name which the pollster would return, the pollster is a pollster object instance. The pollster which implements this method should be registered in the namespace of ceilometer.builder.xxx instead of ceilometer.poll.xxx.
get_pollsters_extensions
(conf)[source]¶Return a list of stevedore extensions.
The returned stevedore extensions wrap the pollster object instances returned by build_pollsters.
get_samples
(manager, cache, resources)[source]¶Return a sequence of Counter instances from polling the resources.
Parameters: |
|
---|
ceilometer.agent.plugin_base.
PollsterPermanentError
(resources)[source]¶Bases: exceptions.Exception
Permanent error when polling.
When unrecoverable error happened in polling, pollster can raise this exception with failed resource to prevent itself from polling any more. Resource is one of parameter resources from get_samples that cause polling error.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.