NetSnmp

Complexity

Total Complexity

12

Size/Duplication

Total Lines	108
Duplicated Lines	53.7 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
D	check()	58	58	10
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
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',
        'proc_netsnmp_record': {
            'Ip': [ 'Forwarding', 'InReceives', 'InHdrErrors', 'InAddrErrors',
                    'ForwDatagrams', 'InUnknownProtos', 'InDiscards',
                    'InDelivers', 'OutRequests', 'OutDiscards',
                    'ReasmTimeout', 'ReasmReqds', 'ReasmOKs', 'ReasmFails',
                    'FragOKs', 'FragFails', 'FragCreates' ],
            'Icmp': [ 'InMsgs','InErrors', 'InCsumErrors', 'InDestUnreachs',
                     'InTimeExcds', 'InParmProbs', 'InSrcQuenchs',
                     'InRedirects', 'InEchos', 'InEchoReps',  'OutMsgs',
                     'OutErrors', 'OutDestUnreachs', 'OutTimeExcds',
                     'OutParmProbs', 'OutSrcQuenchs', 'OutRedirects',
                     'OutEchos', 'OutEchoReps' ],
            'IcmpMsg': [ 'OutType3' ],
            'Tcp': [ 'MaxConn', 'ActiveOpens', 'PassiveOpens', 'AttemptFails',
                    'EstabResets', 'CurrEstab', 'InSegs', 'OutSegs',
                    'RetransSegs', 'InErrs', 'OutRsts', 'InCsumErrors' ],
            'Udp': [ 'InDatagrams', 'NoPorts', 'InErrors', 'OutDatagrams',
                    'RcvbufErrors', 'SndbufErrors', 'InCsumErrors' ]
        }
    }

    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):

This code seems to be duplicated in your project.

        """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
        """
        record = self.config.get('proc_netsnmp_record')
        result = plumd.Result("net_snmp")

        # read the proc file
        dat = None
        with open(self.proc_file, 'r') as f:
            try:
                dat = f.read().strip().split("\n")
            except Exception as e:
                self.log.error("failed to read {0}".format(self.proc_file))
                return result

        # timestamp for Differential calculations
        ts = time.time()

        # should always have a header row and value row, ie. divisible by 2
        if len(dat) % 2 != 0:
            self.log.error("netsnmp: cannot parse {0}".format(self.proc_file))
            return result

        # split values into lists
        dlist = deque()
        for entry in dat:
            dlist.append(entry.split())

        # put lists into key: value dict
        metrics = {}
        while dlist:
            headers = dlist.popleft()
            values = dlist.popleft()
            # { 'IpExt': {'InNoRoutes': 0, ...} } - [:-1] on IpExt: removes :
            metrics[headers[0][:-1]] = dict(zip(headers, values))

        # now, we have a list of items to record, just need to record them
        for proto, mnames in record.items():
            if proto not in metrics:
                self.log.warn("netsnmp: unknown protocol: {0}".format(proto))
                continue
            values = metrics[proto]
            for mname in mnames:
                if mname in values:
                    mstr = "{0}.{1}".format(proto, mname)
                    mval = self.calc.per_second(mstr, int(values[mname]), ts)
                    result.add(plumd.Int(mstr, mval))
                else:
                    self.log.warn("netstat: unknown metric {0}".format(mname))
        return [result]