The ceilometer.plugin Module

Base class for plugins.

class ceilometer.plugin.ExchangeTopics

Bases: tuple

ExchangeTopics(exchange, topics)

class ceilometer.plugin.NotificationBase

Bases: ceilometer.plugin.PluginBase

Base class for plugins that support the notification API.

get_event_types()

Return a sequence of strings defining the event types to be given to this plugin.

get_exchange_topics(conf)

Return a sequence of ExchangeTopics defining the exchange and topics to be connected for this plugin.

Parameters:conf – Configuration.

is_enabled()

notification_to_metadata(event)

Transform a payload dict to a metadata dict.

process_notification(message)

Return a sequence of Counter instances for the given message.

Parameters:message – Message to process.

class ceilometer.plugin.PluginBase

Bases: object

Base class for all plugins.

is_enabled()

Return boolean indicating whether this plugin should be enabled and used by the caller.

class ceilometer.plugin.PollsterBase

Bases: ceilometer.plugin.PluginBase

Base class for plugins that support the polling API.

get_counter_names()

Return a sequence of Counter names supported by the pollster.

get_counters(manager, instance)

Return a sequence of Counter instances from polling the resources.

class ceilometer.plugin.PublisherBase

Bases: ceilometer.plugin.PluginBase

Base class for plugins that publish the sampler.

publish_counters(context, counters, source)

Publish counters into final conduit.

class ceilometer.plugin.TransformerBase(**kwargs)

Bases: ceilometer.plugin.PluginBase

Base class for plugins that transform the counter.

flush(context, source)

Flush counters cached previously.

Parameters:

• context – Passed from the data collector.
• source – Source of counters that are being published.

handle_sample(context, counter, source)

Transform a counter.

Parameters:

• context – Passed from the data collector.
• counter – A counter.
• source – Passed from data collector.