deb-ceilometer/ceilometer/hardware/inspector/base.py
Ladislav Smola 9f0cfce9a6 Allow to pass dict from resource discovery
Allowing to pass dict from resource discovery and storing it
as metadata. Before it was only possible to pass IP address,
which is not enough.
For TripleO case, important metadata like image name and flavor
from Nova are passed and stored in resource, allowing to make
aggregate queries according to them.

Change-Id: I4dabf79f248842398e1126d310d110b1fe95fad5
Closes-Bug: #1366871
2014-09-10 10:54:19 +02:00

40 lines
1.4 KiB
Python

#
# Copyright 2014 ZHAW SoE
#
# Authors: Lucas Graf <graflu0@students.zhaw.ch>
# Toni Zehnder <zehndton@students.zhaw.ch>
#
# 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.
"""Inspector abstraction for read-only access to hardware components"""
import abc
import six
@six.add_metaclass(abc.ABCMeta)
class Inspector(object):
@abc.abstractmethod
def inspect_generic(self, host, identifier, cache, extra_metadata=None):
"""A generic inspect function.
:param host: the target host
:param identifier: the identifier of the metric
:param cache: cache passed from the pollster
:param extra_metadata: extra dict to be used as metadata
:return: an iterator of (value, metadata, extra)
:return value: the sample value
:return metadata: dict to construct sample's metadata
:return extra: dict of extra metadata to help constructing sample
"""