a10773e413
Add a dictionary as a data cache for the pollsters, creating it outside of the loop where they are invoked and passing it to them. Future changesets will include changes to the pollsters to put data in the cache. blueprint one-meter-per-plugin Change-Id: Ie65526dfe65a8880ad8683b62fae62f8e7f9e69b Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
101 lines
3.1 KiB
Python
101 lines
3.1 KiB
Python
# -*- encoding: utf-8 -*-
|
|
#
|
|
# Copyright © 2012 New Dream Network, LLC (DreamHost)
|
|
#
|
|
# Author: Doug Hellmann <doug.hellmann@dreamhost.com>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
"""Base class for plugins.
|
|
"""
|
|
|
|
import abc
|
|
import collections
|
|
from oslo.config import cfg
|
|
|
|
# Import this option so every Notification plugin can use it freely.
|
|
cfg.CONF.import_opt('notification_topics',
|
|
'ceilometer.openstack.common.notifier.rpc_notifier')
|
|
|
|
|
|
ExchangeTopics = collections.namedtuple('ExchangeTopics',
|
|
['exchange', 'topics'])
|
|
|
|
|
|
class PluginBase(object):
|
|
"""Base class for all plugins.
|
|
"""
|
|
|
|
@staticmethod
|
|
def is_enabled():
|
|
"""Return boolean indicating whether this plugin should
|
|
be enabled and used by the caller.
|
|
"""
|
|
return True
|
|
|
|
|
|
class NotificationBase(PluginBase):
|
|
"""Base class for plugins that support the notification API."""
|
|
|
|
__metaclass__ = abc.ABCMeta
|
|
|
|
@abc.abstractmethod
|
|
def get_event_types(self):
|
|
"""Return a sequence of strings defining the event types to be
|
|
given to this plugin.
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def get_exchange_topics(self, conf):
|
|
"""Return a sequence of ExchangeTopics defining the exchange and
|
|
topics to be connected for this plugin.
|
|
|
|
:param conf: Configuration.
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def process_notification(self, message):
|
|
"""Return a sequence of Counter instances for the given message.
|
|
|
|
:param message: Message to process.
|
|
"""
|
|
|
|
def notification_to_metadata(self, event):
|
|
"""Transform a payload dict to a metadata dict."""
|
|
metadata = dict([(k, event['payload'].get(k))
|
|
for k in self.metadata_keys])
|
|
metadata['event_type'] = event['event_type']
|
|
metadata['host'] = event['publisher_id']
|
|
return metadata
|
|
|
|
|
|
class PollsterBase(PluginBase):
|
|
"""Base class for plugins that support the polling API."""
|
|
|
|
__metaclass__ = abc.ABCMeta
|
|
|
|
@abc.abstractmethod
|
|
def get_counter_names(self):
|
|
"""Return a sequence of Counter names supported by the pollster."""
|
|
|
|
@abc.abstractmethod
|
|
def get_counters(self, manager, cache):
|
|
"""Return a sequence of Counter instances from polling the resources.
|
|
|
|
:param manager: The service manager class invoking the plugin.
|
|
:param cache: A dictionary to allow pollsters to pass data
|
|
between themselves when recomputing it would be
|
|
expensive (e.g., asking another service for a
|
|
list of objects).
|
|
|
|
"""
|