nova/nova/compute/monitors/base.py

83 lines
3.0 KiB
Python

# 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.
import abc
import six
from nova import objects
from nova.objects import fields
@six.add_metaclass(abc.ABCMeta)
class MonitorBase(object):
"""Base class for all resource monitor plugins."""
def __init__(self, compute_manager):
self.compute_manager = compute_manager
self.source = None
@abc.abstractmethod
def get_metric(self, name):
"""Return a (value, timestamp) tuple for the supplied metric name.
:param name: The name/key for the metric to grab the value for.
"""
raise NotImplementedError('get_metric')
@abc.abstractmethod
def get_metric_names(self):
"""Get available metric names.
Get available metric names, which are represented by a set of keys
that can be used to check conflicts and duplications
:returns: set containing one or more values from
nova.objects.fields.MonitorMetricType.ALL constants
"""
raise NotImplementedError('get_metric_names')
def add_metrics_to_list(self, metrics_list):
"""Adds metric objects to a supplied list object.
:param metric_list: nova.objects.MonitorMetricList that the monitor
plugin should append nova.objects.MonitorMetric
objects to.
"""
metric_names = self.get_metric_names()
metrics = []
for name in metric_names:
value, timestamp = self.get_metric(name)
metric = objects.MonitorMetric(name=name,
value=value,
timestamp=timestamp,
source=self.source)
metrics.append(metric)
metrics_list.objects.extend(metrics)
class CPUMonitorBase(MonitorBase):
"""Base class for all monitors that return CPU-related metrics."""
def get_metric_names(self):
return set([
fields.MonitorMetricType.CPU_FREQUENCY,
fields.MonitorMetricType.CPU_USER_TIME,
fields.MonitorMetricType.CPU_KERNEL_TIME,
fields.MonitorMetricType.CPU_IDLE_TIME,
fields.MonitorMetricType.CPU_IOWAIT_TIME,
fields.MonitorMetricType.CPU_USER_PERCENT,
fields.MonitorMetricType.CPU_KERNEL_PERCENT,
fields.MonitorMetricType.CPU_IDLE_PERCENT,
fields.MonitorMetricType.CPU_IOWAIT_PERCENT,
fields.MonitorMetricType.CPU_PERCENT,
])