Netstat

Complexity

Total Complexity

14

Size/Duplication

Total Lines	111
Duplicated Lines	54.95 %

Importance

Changes	3
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	poll()	0	6	1
A	__init__()	0	14	1
F	check()	60	61	12

# -*- coding: utf-8 -*-
"""Reader for netstat metrics from /proc on Linux."""

import time
from collections import deque

import plumd
from plumd.util import Differential

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


class Netstat(plumd.Reader):
    """Plugin to measure various kernel metrics from /proc."""

    defaults = {
        'poll.interval': 10,
        'proc_path': '/proc',
        'proc_netstat_gauges': {
            'TcpExt': ["SyncookiesSent", "SyncookiesRecv",
                       "SyncookiesFailed", "OutOfWindowIcmps", "TW", "TWRecycled",
                       "TWKilled", "DelayedACKLost", "ListenOverflows",
                       "ListenDrops", "TCPLostRetransmit", "TCPRenoFailures",
                       "TCPSackFailures", "TCPLossFailures", "TCPFastRetrans",
                       "TCPForwardRetrans", "TCPSlowStartRetrans", "TCPTimeouts",
                       "TCPLossProbes", "TCPLossProbeRecovery", "TCPAbortOnData",
                       "TCPAbortOnClose", "TCPAbortOnMemory", "TCPAbortOnTimeout",
                       "TCPAbortOnLinger", "TCPAbortFailed", "TCPMemoryPressures",
                       "TCPBacklogDrop", "TCPMinTTLDrop", "TCPTimeWaitOverflow",
                       "TCPFastOpenActive", "TCPFastOpenActiveFail",
                       "TCPFastOpenPassive", "TCPFastOpenPassiveFail",
                       "TCPFastOpenListenOverflow", "TCPSynRetrans"],
            'IpExt': ["InNoRoutes", "InTruncatedPkts", "InBcastPkts",
                      "OutBcastPkts", "InOctets", "OutOctets", "InBcastOctets",
                      "OutBcastOctets", "InCsumErrors", "InNoECTPkts", "InECT1Pkts",
                      "InECT0Pkts", "InCEPkts"]
        },
        'proc_netstat_rates': {}
    }

    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(Netstat, self).__init__(log, config)
        self.config.defaults(Netstat.defaults)
        self.calc = Differential()
        self.proc_file = "{0}/net/netstat".format(config.get('proc_path'))
        self.gauges = self.config.get('proc_netstat_gauges')
        self.rates = self.config.get('proc_netstat_rates')

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

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

    def check(self):
        """Return detailed network statitistics proc file net/netstat.

        Note: ECT1Pkts and ECT0Pkts relate to ECT congestion notifications.

        :rtype: plumd.Result
        """
        # what metrics do we want to record?
        result = plumd.Result("netstat")

        # read the proc file
        dat = None
        with open(self.proc_file, 'r') as f:
            dat = f.read().strip().split("\n")

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

        # split values into lists
        dlist = deque([entry.split() for entry in dat])

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

        # record gauges
        for ext, mnames in self.gauges.items():
            if ext not in metrics:
                self.log.warn("netstat: unknown extension: {0}".format(ext))
                del self.gauges[ext]
                continue
            values = metrics[ext]
            for mname in mnames:
                if mname in values:
                    mstr = "{0}.{1}".format(ext, mname)
                    result.add(plumd.Int(mstr, values[mname]))
                else:
                    self.log.warn("netstat: unknown metric {0}".format(mname))
                    self.gauges[ext].remove(mname)

        # record rates
        for ext, mnames in self.rates.items():
            if ext not in metrics:
                self.log.warn("netstat: unknown extension: {0}".format(ext))
                del self.rates[ext]
                continue
            values = metrics[ext]
            for mname in mnames:
                if mname in values:
                    mstr = "{0}.{1}".format(ext, mname)
                    mval = self.calc.per_second(mstr, float(values[mname]), ts)
                    result.add(plumd.Float(mstr, mval))
                else:
                    self.log.warn("netstat: unknown metric {0}".format(mname))
                    self.rates[ext].remove(mname)

        return [result]