NetSnmp

Complexity

Total Complexity

9

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
C	check()	0	39	7
A	poll()	0	6	1
A	__init__()	0	13	1

# -*- coding: utf-8 -*-

__author__ = 'Kenny Freeman'
__email__ = 'kenny.freeman@gmail.com'
__license__ = "ISCL"
__docformat__ = 'reStructuredText'

import time
import traceback
from collections import deque

import plumd
import plumd.plugins
from plumd.calc import Differential
from plumd.util import get_file_list, Filter


## todo: switch from list with pop(0) to deque
class NetSnmp(plumd.plugins.Reader):
    """Plugin to measure various kernel metrics from /proc."""
    defaults = {
        'poll.interval': 10,
        'proc_path': '/proc',
        'skip_proc_net_snmp': ["Icmp.InAddrMaskReps","Icmp.InAddrMasks",
            "Icmp.InTimestampReps","Icmp.InTimestamps","Icmp.OutAddrMaskReps",
            "Icmp.OutAddrMasks","Icmp.OutTimestampReps","Icmp.OutTimestamps",
            "Ip.DefaultTTL","Ip.Forwarding","Tcp.MaxConn","Tcp.RtoAlgorithm",
            "Tcp.RtoMax","Tcp.RtoMin"]
    }

    def __init__(self, log, config):
        """Plugin to measure various kernel metrics from /proc.

        :param log: A logger
        :type log: logging.RootLogger
        :param config: a plumd.config.Conf configuration helper instance.
        :type config: plumd.config.Conf
        """
        super(NetSnmp, self).__init__(log, config)
        self.config.defaults(NetSnmp.defaults)
        self.calc = Differential()
        self.proc_file = "{0}/net/snmp".format(config.get('proc_path'))
        self.filter = Filter()



    def poll(self):
        """Poll for kernel metrics under /proc.

        :rtype: ResultSet
        """
        return plumd.ResultSet(self.check())


    def check(self):
        """Return network protocol metrics from proc file net/snmp.

        Add entries to the configuration value 'skip_proc_net_snmp' to skip
        metrics.

        Add entries to the configuration value 'net_snmp_items' to match the
        format/order of the proc file net/snmp entries on the system.

        :rtype: plumd.Result
        """
        skip = self.config.get('skip_proc_net_snmp')
        result = plumd.Result("net_snmp")
        dat = {}
        # read and process - dat is a list of lines from fname
        dat = get_file_list(self.proc_file)
        ts = time.time()
        vals = True
        # process each pair of lines
        while dat and vals:
            try:
                # first line is a list of: metric: header values
                header = deque(dat.popleft().split())
                # second line is a list of: <metric>: metric values
                vals = deque([ int(i) for i in dat.popleft().split()[1:] ])
            except Exception as e:
                tb = traceback.format_exc()
                self.log.error("proc_net_snmp: exception: {0}: {1}".format(e, tb))
                continue
            # first value is the name of the metric eg. Ip, Icmp, etc
            mheader = self.filter.process(header.popleft())
            for mname in header:
                mval = vals.popleft()
                mstr = "{0}.{1}".format(mheader, mname)
                if mstr in skip:
                    continue
                dval = self.calc.per_second(mstr, mval, ts)
                result.add(plumd.Int(mstr, dval))
        return [result]