Added nova objects for intance diagnostics

Following objects were added:

* CpuDiagnostics
* NicDiagnostics
* DiskDiagnostics
* MemoryDiagnostics
* Diagnostics

These objects will be used to transmit data via RPC.
They are based on same objects from nova.virt.diagnostics.
But old objects were used only for storing data.
During RPC transmission they are transform into dictionaries.
It is not right approach.  We will have some problems
in case of adding new diagnostics fields.

New nova objects will allow us to have a good control of objects
versioning. It will force contributors to dump objects
version in case of any changes.

Also some new fields were added/modified to be in accordance with
updated diagnostic spec Ibcc2b98ae5b3731a9e5a1a3f28fc7ce4655c8ea6

blueprint: restore-vm-diagnostics

Change-Id: I6b15001e6f4e649df983071464ec8642bfc89b61
This commit is contained in:
Sergey Nikitin 2017-02-16 12:13:27 +04:00
parent d25185b199
commit 2cf846e1e7
6 changed files with 380 additions and 0 deletions

View File

@ -31,6 +31,7 @@ def register_all():
__import__('nova.objects.build_request')
__import__('nova.objects.cell_mapping')
__import__('nova.objects.compute_node')
__import__('nova.objects.diagnostics')
__import__('nova.objects.dns_domain')
__import__('nova.objects.ec2')
__import__('nova.objects.external_event')

172
nova/objects/diagnostics.py Normal file
View File

@ -0,0 +1,172 @@
# Copyright (c) 2014 VMware, Inc.
# All Rights Reserved.
#
# 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.
from nova.objects import base
from nova.objects import fields
@base.NovaObjectRegistry.register
class CpuDiagnostics(base.NovaObject):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'id': fields.IntegerField(nullable=True),
'time': fields.IntegerField(nullable=True),
'utilisation': fields.IntegerField(nullable=True),
}
@base.NovaObjectRegistry.register
class NicDiagnostics(base.NovaObject):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'mac_address': fields.MACAddressField(nullable=True),
'rx_octets': fields.IntegerField(nullable=True),
'rx_errors': fields.IntegerField(nullable=True),
'rx_drop': fields.IntegerField(nullable=True),
'rx_packets': fields.IntegerField(nullable=True),
'rx_rate': fields.IntegerField(nullable=True),
'tx_octets': fields.IntegerField(nullable=True),
'tx_errors': fields.IntegerField(nullable=True),
'tx_drop': fields.IntegerField(nullable=True),
'tx_packets': fields.IntegerField(nullable=True),
'tx_rate': fields.IntegerField(nullable=True)
}
@base.NovaObjectRegistry.register
class DiskDiagnostics(base.NovaObject):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'read_bytes': fields.IntegerField(nullable=True),
'read_requests': fields.IntegerField(nullable=True),
'write_bytes': fields.IntegerField(nullable=True),
'write_requests': fields.IntegerField(nullable=True),
'errors_count': fields.IntegerField(nullable=True)
}
@base.NovaObjectRegistry.register
class MemoryDiagnostics(base.NovaObject):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'maximum': fields.IntegerField(nullable=True),
'used': fields.IntegerField(nullable=True)
}
@base.NovaObjectRegistry.register
class Diagnostics(base.NovaObject):
# Version 1.0: Initial version
VERSION = '1.0'
fields = {
'state': fields.InstancePowerStateField(),
'driver': fields.HypervisorDriverField(),
'hypervisor': fields.StringField(nullable=True),
'hypervisor_os': fields.StringField(nullable=True),
'uptime': fields.IntegerField(nullable=True),
'config_drive': fields.BooleanField(),
'memory_details': fields.ObjectField('MemoryDiagnostics',
default=MemoryDiagnostics()),
'cpu_details': fields.ListOfObjectsField('CpuDiagnostics', default=[]),
'nic_details': fields.ListOfObjectsField('NicDiagnostics', default=[]),
'disk_details': fields.ListOfObjectsField('DiskDiagnostics',
default=[]),
'num_cpus': fields.IntegerField(),
'num_nics': fields.IntegerField(),
'num_disks': fields.IntegerField()
}
def __init__(self, *args, **kwargs):
super(Diagnostics, self).__init__(*args, **kwargs)
self.obj_set_defaults()
self.num_cpus = len(self.cpu_details)
self.num_nics = len(self.nic_details)
self.num_disks = len(self.disk_details)
def add_cpu(self, id=None, time=None, utilisation=None):
"""Add a new CpuDiagnostics object
:param id: The virtual cpu number (Integer)
:param time: CPU Time in nano seconds (Integer)
:param utilisation: CPU utilisation in percentages (Integer)
"""
self.num_cpus += 1
self.cpu_details.append(
CpuDiagnostics(id=id, time=time, utilisation=utilisation))
def add_nic(self, mac_address=None, rx_octets=None, rx_errors=None,
rx_drop=None, rx_packets=None, rx_rate=None, tx_octets=None,
tx_errors=None, tx_drop=None, tx_packets=None, tx_rate=None):
"""Add a new NicDiagnostics object
:param mac_address: Mac address of the interface (String)
:param rx_octets: Received octets (Integer)
:param rx_errors: Received errors (Integer)
:param rx_drop: Received packets dropped (Integer)
:param rx_packets: Received packets (Integer)
:param rx_rate: Receive rate (Integer)
:param tx_octets: Transmitted Octets (Integer)
:param tx_errors: Transmit errors (Integer)
:param tx_drop: Transmit dropped packets (Integer)
:param tx_packets: Transmit packets (Integer)
:param tx_rate: Transmit rate (Integer)
"""
self.num_nics += 1
self.nic_details.append(NicDiagnostics(mac_address=mac_address,
rx_octets=rx_octets,
rx_errors=rx_errors,
rx_drop=rx_drop,
rx_packets=rx_packets,
rx_rate=rx_rate,
tx_octets=tx_octets,
tx_errors=tx_errors,
tx_drop=tx_drop,
tx_packets=tx_packets,
tx_rate=tx_rate))
def add_disk(self, read_bytes=None, read_requests=None, write_bytes=None,
write_requests=None, errors_count=None):
"""Create a new DiskDiagnostics object
:param read_bytes: Disk reads in bytes(Integer)
:param read_requests: Read requests (Integer)
:param write_bytes: Disk writes in bytes (Integer)
:param write_requests: Write requests (Integer)
:param errors_count: Disk errors (Integer)
"""
self.num_disks += 1
self.disk_details.append(DiskDiagnostics(read_bytes=read_bytes,
read_requests=read_requests,
write_bytes=write_bytes,
write_requests=write_requests,
errors_count=errors_count))

View File

@ -742,6 +742,16 @@ class DiskFormat(BaseNovaEnum):
ALL = (RBD, LVM, QCOW2, RAW, PLOOP, VHD, VMDK, VDI, ISO)
class HypervisorDriver(BaseNovaEnum):
LIBVIRT = "libvirt"
XENAPI = "xenapi"
VMWAREAPI = "vmwareapi"
IRONIC = "ironic"
HYPERV = "hyperv"
ALL = (LIBVIRT, XENAPI, VMWAREAPI, IRONIC, HYPERV)
class PointerModelType(BaseNovaEnum):
USBTABLET = "usbtablet"
@ -1158,6 +1168,10 @@ class DiskFormatField(BaseEnumField):
AUTO_TYPE = DiskFormat()
class HypervisorDriverField(BaseEnumField):
AUTO_TYPE = HypervisorDriver()
class PointerModelField(BaseEnumField):
AUTO_TYPE = PointerModelType()

View File

@ -0,0 +1,42 @@
# Copyright (c) 2017 Mirantis Inc.
# All Rights Reserved.
#
# 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.
from nova import objects
def fake_diagnostics_obj(**updates):
diag = objects.Diagnostics()
cpu_details = updates.pop('cpu_details', [])
nic_details = updates.pop('nic_details', [])
disk_details = updates.pop('disk_details', [])
memory_details = updates.pop('memory_details', {})
for field in objects.Diagnostics.fields:
if field in updates:
setattr(diag, field, updates[field])
for cpu in cpu_details:
diag.add_cpu(**cpu)
for nic in nic_details:
diag.add_nic(**nic)
for disk in disk_details:
diag.add_disk(**disk)
for k, v in memory_details.items():
setattr(diag.memory_details, k, v)
return diag

View File

@ -0,0 +1,146 @@
# Copyright (c) 2014 VMware, Inc.
#
# 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.
from nova.objects import diagnostics
from nova import test
class DiagnosticsComparisonMixin(object):
def assertDiagnosticsEqual(self, expected, actual):
expected.obj_reset_changes(recursive=True)
actual.obj_reset_changes(recursive=True)
# NOTE(snikitin): Fields 'cpu_details', 'disk_details' and
# 'nic_details' are list objects. They wouldn't be marked as 'changed'
# if new item will be added by 'append()' method
# (like # Diagnostics.add_*** methods do). So we have to reset these
# objects manually.
for obj in [expected, actual]:
for field in ['cpu_details', 'disk_details', 'nic_details']:
for item in getattr(obj, field):
item.obj_reset_changes()
self.assertEqual(expected.obj_to_primitive(),
actual.obj_to_primitive())
class DiagnosticsTests(test.NoDBTestCase):
def test_cpu_diagnostics(self):
cpu = diagnostics.CpuDiagnostics(id=1, time=7, utilisation=15)
self.assertEqual(1, cpu.id)
self.assertEqual(7, cpu.time)
self.assertEqual(15, cpu.utilisation)
def test_nic_diagnostics(self):
nic = diagnostics.NicDiagnostics(
mac_address='00:00:ca:fe:00:00',
rx_octets=1, rx_errors=2, rx_drop=3, rx_packets=4, rx_rate=5,
tx_octets=6, tx_errors=7, tx_drop=8, tx_packets=9, tx_rate=10)
self.assertEqual('00:00:ca:fe:00:00', nic.mac_address)
self.assertEqual(1, nic.rx_octets)
self.assertEqual(2, nic.rx_errors)
self.assertEqual(3, nic.rx_drop)
self.assertEqual(4, nic.rx_packets)
self.assertEqual(5, nic.rx_rate)
self.assertEqual(6, nic.tx_octets)
self.assertEqual(7, nic.tx_errors)
self.assertEqual(8, nic.tx_drop)
self.assertEqual(9, nic.tx_packets)
self.assertEqual(10, nic.tx_rate)
def test_disk_diagnostics(self):
disk = diagnostics.DiskDiagnostics(
read_bytes=1, read_requests=2,
write_bytes=3, write_requests=4,
errors_count=5)
self.assertEqual(1, disk.read_bytes)
self.assertEqual(2, disk.read_requests)
self.assertEqual(3, disk.write_bytes)
self.assertEqual(4, disk.write_requests)
self.assertEqual(5, disk.errors_count)
def test_memory_diagnostics(self):
memory = diagnostics.MemoryDiagnostics(maximum=1, used=2)
self.assertEqual(1, memory.maximum)
self.assertEqual(2, memory.used)
def test_diagnostics(self):
cpu_details = [diagnostics.CpuDiagnostics()]
nic_details = [diagnostics.NicDiagnostics()]
disk_details = [diagnostics.DiskDiagnostics()]
memory_details = diagnostics.MemoryDiagnostics(maximum=1, used=1)
diags = diagnostics.Diagnostics(
state='running', driver='libvirt', hypervisor_os='fake-os',
uptime=1, cpu_details=cpu_details, nic_details=nic_details,
disk_details=disk_details, config_drive=True,
memory_details=memory_details)
self.assertEqual('running', diags.state)
self.assertEqual('libvirt', diags.driver)
self.assertEqual('fake-os', diags.hypervisor_os)
self.assertEqual(1, diags.uptime)
self.assertTrue(diags.config_drive)
self.assertEqual(1, len(diags.cpu_details))
self.assertEqual(1, len(diags.nic_details))
self.assertEqual(1, len(diags.disk_details))
self.assertEqual(1, diags.num_cpus)
self.assertEqual(1, diags.num_disks)
self.assertEqual(1, diags.num_nics)
self.assertEqual(1, diags.memory_details.maximum)
self.assertEqual(1, diags.memory_details.used)
self.assertEqual('1.0', diags.VERSION)
def test_add_cpu(self):
diags = diagnostics.Diagnostics()
self.assertEqual([], diags.cpu_details)
diags.add_cpu(id=1, time=7, utilisation=15)
self.assertEqual(1, len(diags.cpu_details))
self.assertEqual(7, diags.cpu_details[0].time)
self.assertEqual(1, diags.cpu_details[0].id)
self.assertEqual(15, diags.cpu_details[0].utilisation)
self.assertEqual(1, diags.num_cpus)
def test_add_nic(self):
diags = diagnostics.Diagnostics()
self.assertEqual([], diags.nic_details)
diags.add_nic(mac_address='00:00:ca:fe:00:00',
rx_octets=1, rx_errors=2, rx_drop=3, rx_packets=4, rx_rate=5,
tx_octets=6, tx_errors=7, tx_drop=8, tx_packets=9, tx_rate=10)
self.assertEqual(1, len(diags.nic_details))
self.assertEqual('00:00:ca:fe:00:00', diags.nic_details[0].mac_address)
self.assertEqual(1, diags.nic_details[0].rx_octets)
self.assertEqual(2, diags.nic_details[0].rx_errors)
self.assertEqual(3, diags.nic_details[0].rx_drop)
self.assertEqual(4, diags.nic_details[0].rx_packets)
self.assertEqual(5, diags.nic_details[0].rx_rate)
self.assertEqual(6, diags.nic_details[0].tx_octets)
self.assertEqual(7, diags.nic_details[0].tx_errors)
self.assertEqual(8, diags.nic_details[0].tx_drop)
self.assertEqual(9, diags.nic_details[0].tx_packets)
self.assertEqual(10, diags.nic_details[0].tx_rate)
self.assertEqual(1, diags.num_nics)
def test_add_disk(self):
diags = diagnostics.Diagnostics()
self.assertEqual([], diags.disk_details)
diags.add_disk(read_bytes=1, read_requests=2,
write_bytes=3, write_requests=4,
errors_count=5)
self.assertEqual(1, len(diags.disk_details))
self.assertEqual(1, diags.disk_details[0].read_bytes)
self.assertEqual(2, diags.disk_details[0].read_requests)
self.assertEqual(3, diags.disk_details[0].write_bytes)
self.assertEqual(4, diags.disk_details[0].write_requests)
self.assertEqual(5, diags.disk_details[0].errors_count)
self.assertEqual(1, diags.num_disks)

View File

@ -1074,11 +1074,14 @@ object_data = {
'CellMappingList': '1.0-4ee0d9efdfd681fed822da88376e04d2',
'ComputeNode': '1.18-431fafd8ac4a5f3559bd9b1f1332cc22',
'ComputeNodeList': '1.17-52f3b0962b1c86b98590144463ebb192',
'CpuDiagnostics': '1.0-d256f2e442d1b837735fd17dfe8e3d47',
'DNSDomain': '1.0-7b0b2dab778454b6a7b6c66afe163a1a',
'DNSDomainList': '1.0-4ee0d9efdfd681fed822da88376e04d2',
'Destination': '1.1-fff0853f3acec6b04ddc03158ded11ba',
'DeviceBus': '1.0-77509ea1ea0dd750d5864b9bd87d3f9d',
'DeviceMetadata': '1.0-04eb8fd218a49cbc3b1e54b774d179f7',
'Diagnostics': '1.0-38ad3e9b1a59306253fc03f97936db95',
'DiskDiagnostics': '1.0-dfd0892b5924af1a585f3fed8c9899ca',
'DiskMetadata': '1.0-e7a0f1ccccf10d26a76b28e7492f3788',
'EC2Ids': '1.0-474ee1094c7ec16f8ce657595d8c49d9',
'EC2InstanceMapping': '1.0-a4556eb5c5e94c045fe84f49cf71644f',
@ -1122,11 +1125,13 @@ object_data = {
'LibvirtLiveMigrateData': '1.3-2795e5646ee21e8c7f1c3e64fb6c80a3',
'KeyPair': '1.4-1244e8d1b103cc69d038ed78ab3a8cc6',
'KeyPairList': '1.3-94aad3ac5c938eef4b5e83da0212f506',
'MemoryDiagnostics': '1.0-2c995ae0f2223bb0f8e523c5cc0b83da',
'Migration': '1.4-17979b9f2ae7f28d97043a220b2a8350',
'MigrationContext': '1.1-9fb17b0b521370957a884636499df52d',
'MigrationList': '1.3-55595bfc1a299a5962614d0821a3567e',
'MonitorMetric': '1.1-53b1db7c4ae2c531db79761e7acc52ba',
'MonitorMetricList': '1.1-15ecf022a68ddbb8c2a6739cfc9f8f5e',
'NicDiagnostics': '1.0-895e9ad50e0f56d5258585e3e066aea5',
'NUMACell': '1.2-74fc993ac5c83005e76e34e8487f1c05',
'NUMAPagesTopology': '1.1-edab9fa2dc43c117a38d600be54b4542',
'NUMATopology': '1.2-c63fad38be73b6afd04715c9c1b29220',