openstack/aodh
Code Issues Proposed changes
f7392e4757
aodh/ceilometer/hardware/inspector/snmp.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

419 lines
16 KiB
Python
Raw Blame History

#
# Copyright 2014 ZHAW SoE
# Copyright 2014 Intel Corp
#
# Authors: Lucas Graf <graflu0@students.zhaw.ch>
# Toni Zehnder <zehndton@students.zhaw.ch>
# Lianhao Lu <lianhao.lu@intel.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.
"""Inspector for collecting data over SNMP"""
from pysnmp.entity.rfc3413.oneliner import cmdgen
from ceilometer.hardware.inspector import base
class SNMPException(Exception):
pass
def parse_snmp_return(ret, is_bulk=False):
"""Check the return value of snmp operations
:param ret: a tuple of (errorIndication, errorStatus, errorIndex, data)
returned by pysnmp
:param is_bulk: True if the ret value is from GetBulkRequest
:return: a tuple of (err, data)
err: True if error found, or False if no error found
data: a string of error description if error found, or the
actual return data of the snmp operation
"""
err = True
(errIndication, errStatus, errIdx, varBinds) = ret
if errIndication:
data = errIndication
elif errStatus:
if is_bulk:
varBinds = varBinds[-1]
data = "%s at %s" % (errStatus.prettyPrint(),
errIdx and varBinds[int(errIdx) - 1] or "?")
else:
err = False
data = varBinds
return err, data
EXACT = 'type_exact'
PREFIX = 'type_prefix'
class SNMPInspector(base.Inspector):
# CPU OIDs
_cpu_1_min_load_oid = "1.3.6.1.4.1.2021.10.1.3.1"
_cpu_5_min_load_oid = "1.3.6.1.4.1.2021.10.1.3.2"
_cpu_15_min_load_oid = "1.3.6.1.4.1.2021.10.1.3.3"
# Memory OIDs
_memory_total_oid = "1.3.6.1.4.1.2021.4.5.0"
_memory_used_oid = "1.3.6.1.4.1.2021.4.6.0"
_memory_total_swap_oid = "1.3.6.1.4.1.2021.4.3.0"
_memory_avail_swap_oid = "1.3.6.1.4.1.2021.4.4.0"
# Disk OIDs
_disk_index_oid = "1.3.6.1.4.1.2021.9.1.1"
_disk_path_oid = "1.3.6.1.4.1.2021.9.1.2"
_disk_device_oid = "1.3.6.1.4.1.2021.9.1.3"
_disk_size_oid = "1.3.6.1.4.1.2021.9.1.6"
_disk_used_oid = "1.3.6.1.4.1.2021.9.1.8"
# Network Interface OIDs
_interface_index_oid = "1.3.6.1.2.1.2.2.1.1"
_interface_name_oid = "1.3.6.1.2.1.2.2.1.2"
_interface_speed_oid = "1.3.6.1.2.1.2.2.1.5"
_interface_mac_oid = "1.3.6.1.2.1.2.2.1.6"
_interface_ip_oid = "1.3.6.1.2.1.4.20.1.2"
_interface_received_oid = "1.3.6.1.2.1.2.2.1.10"
_interface_transmitted_oid = "1.3.6.1.2.1.2.2.1.16"
_interface_error_oid = "1.3.6.1.2.1.2.2.1.20"
# System stats
_system_stats_cpu_idle_oid = "1.3.6.1.4.1.2021.11.11.0"
_system_stats_io_raw_sent_oid = "1.3.6.1.4.1.2021.11.57.0"
_system_stats_io_raw_received_oid = "1.3.6.1.4.1.2021.11.58.0"
# Network stats
_network_ip_out_requests_oid = "1.3.6.1.2.1.4.10.0"
_network_ip_in_receives_oid = "1.3.6.1.2.1.4.3.0"
# Default port
_port = 161
_disk_metadata = {
'path': (_disk_path_oid, str),
'device': (_disk_device_oid, str),
}
_net_metadata = {
'name': (_interface_name_oid, str),
'speed': (_interface_speed_oid, lambda x: int(x) / 8),
'mac': (_interface_mac_oid,
lambda x: x.prettyPrint().replace('0x', '')),
}
_CACHE_KEY_OID = "snmp_cached_oid"
'''
The following mapping define how to construct
(value, metadata, extra) returned by inspect_generic
MAPPING = {
'identifier: {
'matching_type': EXACT or PREFIX,
'metric_oid': (oid, value_converter)
'metadata': {
metadata_name1: (oid1, value_converter),
metadata_name2: (oid2, value_converter),
},
'post_op': special func to modify the return data,
},
}
For matching_type of EXACT, each item in the above mapping will
return exact one (value, metadata, extra) tuple. The value would be
returned from SNMP request GetRequest for oid of 'metric_oid', the
metadata dict would be constructed based on the returning from SNMP
GetRequest for oids of 'metadata'.
For matching_type of PREFIX, SNMP request GetBulkRequest
would be send to get values for oids of 'metric_oid' and
'metadata' of each item in the above mapping. And each item might
return multiple (value, metadata, extra) tuple, e.g.
Suppose we have the following mapping:
MAPPING = {
'disk.size.total': {
'matching_type': PREFIX,
'metric_oid': ("1.3.6.1.4.1.2021.9.1.6", int)
'metadata': {
'device': ("1.3.6.1.4.1.2021.9.1.3", str),
'path': ("1.3.6.1.4.1.2021.9.1.2", str),
},
'post_op': None,
},
and the SNMP have the following oid/value(s):
{
'1.3.6.1.4.1.2021.9.1.6.1': 19222656,
'1.3.6.1.4.1.2021.9.1.3.1': "/dev/sda2",
'1.3.6.1.4.1.2021.9.1.2.1': "/"
'1.3.6.1.4.1.2021.9.1.6.2': 808112,
'1.3.6.1.4.1.2021.9.1.3.2': "tmpfs",
'1.3.6.1.4.1.2021.9.1.2.2': "/run",
}
So here we'll return 2 instances of (value, metadata, extra):
(19222656, {'device': "/dev/sda2", 'path': "/"}, None)
(808112, {'device': "tmpfs", 'path': "/run"}, None)
The post_op is assumed to be implemented by new metric developer. It
could be used to add additional special metadata(e.g. ip address), or
it could be used to add information into extra dict to be returned
to construct the pollster how to build final sample, e.g.
extra.update('project_id': xy, 'user_id': zw)
'''
MAPPING = {
'cpu.load.1min': {
'matching_type': EXACT,
'metric_oid': (_cpu_1_min_load_oid, lambda x: float(str(x))),
'metadata': {},
'post_op': None
},
'cpu.load.5min': {
'matching_type': EXACT,
'metric_oid': (_cpu_5_min_load_oid, lambda x: float(str(x))),
'metadata': {},
'post_op': None,
},
'cpu.load.15min': {
'matching_type': EXACT,
'metric_oid': (_cpu_15_min_load_oid, lambda x: float(str(x))),
'metadata': {},
'post_op': None,
},
'memory.total': {
'matching_type': EXACT,
'metric_oid': (_memory_total_oid, int),
'metadata': {},
'post_op': None,
},
'memory.used': {
'matching_type': EXACT,
'metric_oid': (_memory_used_oid, int),
'metadata': {},
'post_op': None,
},
'memory.swap.total': {
'matching_type': EXACT,
'metric_oid': (_memory_total_swap_oid, int),
'metadata': {},
'post_op': None,
},
'memory.swap.avail': {
'matching_type': EXACT,
'metric_oid': (_memory_avail_swap_oid, int),
'metadata': {},
'post_op': None,
},
'disk.size.total': {
'matching_type': PREFIX,
'metric_oid': (_disk_size_oid, int),
'metadata': _disk_metadata,
'post_op': None,
},
'disk.size.used': {
'matching_type': PREFIX,
'metric_oid': (_disk_used_oid, int),
'metadata': _disk_metadata,
'post_op': None,
},
'network.incoming.bytes': {
'matching_type': PREFIX,
'metric_oid': (_interface_received_oid, int),
'metadata': _net_metadata,
'post_op': "_post_op_net",
},
'network.outgoing.bytes': {
'matching_type': PREFIX,
'metric_oid': (_interface_transmitted_oid, int),
'metadata': _net_metadata,
'post_op': "_post_op_net",
},
'network.outgoing.errors': {
'matching_type': PREFIX,
'metric_oid': (_interface_error_oid, int),
'metadata': _net_metadata,
'post_op': "_post_op_net",
},
'network.ip.outgoing.datagrams': {
'matching_type': EXACT,
'metric_oid': (_network_ip_out_requests_oid, int),
'metadata': {},
'post_op': None,
},
'network.ip.incoming.datagrams': {
'matching_type': EXACT,
'metric_oid': (_network_ip_in_receives_oid, int),
'metadata': {},
'post_op': None,
},
'system_stats.cpu.idle': {
'matching_type': EXACT,
'metric_oid': (_system_stats_cpu_idle_oid, int),
'metadata': {},
'post_op': None,
},
'system_stats.io.outgoing.blocks': {
'matching_type': EXACT,
'metric_oid': (_system_stats_io_raw_sent_oid, int),
'metadata': {},
'post_op': None,
},
'system_stats.io.incoming.blocks': {
'matching_type': EXACT,
'metric_oid': (_system_stats_io_raw_received_oid, int),
'metadata': {},
'post_op': None,
},
}
def __init__(self):
super(SNMPInspector, self).__init__()
self._cmdGen = cmdgen.CommandGenerator()
def _query_oids(self, host, oids, cache, is_bulk):
# send GetRequest or GetBulkRequest to get oid values and
# populate the values into cache
authData = self._get_auth_strategy(host)
transport = cmdgen.UdpTransportTarget((host.hostname,
host.port or self._port))
oid_cache = cache.setdefault(self._CACHE_KEY_OID, {})
if is_bulk:
ret = self._cmdGen.bulkCmd(authData,
transport,
0, 100,
*oids,
lookupValues=True)
else:
ret = self._cmdGen.getCmd(authData,
transport,
*oids,
lookupValues=True)
(error, data) = parse_snmp_return(ret, is_bulk)
if error:
raise SNMPException("An error occurred, oids %(oid)s, "
"host %(host)s, %(err)s" %
dict(oid=oids,
host=host.hostname,
err=data))
# save result into cache
if is_bulk:
for var_bind_table_row in data:
for name, val in var_bind_table_row:
oid_cache[name.prettyPrint()] = val
else:
for name, val in data:
oid_cache[name.prettyPrint()] = val
@staticmethod
def find_matching_oids(oid_cache, oid, match_type, find_one=True):
matched = []
if match_type == PREFIX:
for key in oid_cache.keys():
if key.startswith(oid):
matched.append(key)
if find_one:
break
else:
if oid in oid_cache:
matched.append(oid)
return matched
@staticmethod
def get_oid_value(oid_cache, oid_def, suffix=''):
oid, converter = oid_def
value = oid_cache[oid + suffix]
if converter:
value = converter(value)
return value
@classmethod
def construct_metadata(cls, oid_cache, meta_defs, suffix=''):
metadata = {}
for key, oid_def in meta_defs.iteritems():
metadata[key] = cls.get_oid_value(oid_cache, oid_def, suffix)
return metadata
@classmethod
def _find_missing_oids(cls, meter_def, cache):
# find oids have not been queried and cached
new_oids = []
oid_cache = cache.setdefault(cls._CACHE_KEY_OID, {})
# check metric_oid
if not cls.find_matching_oids(oid_cache,
meter_def['metric_oid'][0],
meter_def['matching_type']):
new_oids.append(meter_def['metric_oid'][0])
for metadata in meter_def['metadata'].values():
if not cls.find_matching_oids(oid_cache,
metadata[0],
meter_def['matching_type']):
new_oids.append(metadata[0])
return new_oids
def inspect_generic(self, host, identifier, cache, extra_metadata=None):
# the snmp definition for the corresponding meter
meter_def = self.MAPPING[identifier]
# collect oids that needs to be queried
oids_to_query = self._find_missing_oids(meter_def, cache)
# query oids and populate into caches
if oids_to_query:
self._query_oids(host, oids_to_query, cache,
meter_def['matching_type'] == PREFIX)
# construct (value, metadata, extra)
oid_cache = cache[self._CACHE_KEY_OID]
# find all oids which needed to construct final sample values
# for matching type of EXACT, only 1 sample would be generated
# for matching type of PREFIX, multiple samples could be generated
oids_for_sample_values = self.find_matching_oids(
oid_cache,
meter_def['metric_oid'][0],
meter_def['matching_type'],
False)
extra_metadata = extra_metadata or {}
for oid in oids_for_sample_values:
suffix = oid[len(meter_def['metric_oid'][0]):]
value = self.get_oid_value(oid_cache,
meter_def['metric_oid'],
suffix)
# get the metadata for this sample value
metadata = self.construct_metadata(oid_cache,
meter_def['metadata'],
suffix)
# call post_op for special cases
if meter_def['post_op']:
func = getattr(self, meter_def['post_op'], None)
if func:
value = func(host, cache, meter_def,
value, metadata, extra_metadata,
suffix)
yield (value, metadata, extra_metadata)
def _post_op_net(self, host, cache, meter_def,
value, metadata, extra, suffix):
# add ip address into metadata
oid_cache = cache.setdefault(self._CACHE_KEY_OID, {})
if not self.find_matching_oids(oid_cache,
self._interface_ip_oid,
PREFIX):
# populate the oid into cache
self._query_oids(host, [self._interface_ip_oid], cache, True)
ip_addr = ''
for k, v in oid_cache.iteritems():
if k.startswith(self._interface_ip_oid) and v == int(suffix[1:]):
ip_addr = k.replace(self._interface_ip_oid + ".", "")
metadata.update(ip=ip_addr)
return value
def _get_auth_strategy(self, host):
if host.password:
auth_strategy = cmdgen.UsmUserData(host.username,
authKey=host.password)
else:
auth_strategy = cmdgen.CommunityData(host.username or 'public')
return auth_strategy
View Git Blame Copy Permalink