Nginx

Complexity

Total Complexity

6

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	1

2 Methods

Rating	Name	Duplication	Size	Complexity
B	poll()	0	29	5
A	__init__()	0	18	1

# -*- coding: utf-8 -*-
"""Nginx reader plugin for stub status url."""

import sys
from collections import deque

PY3 = sys.version_info > (3,)
if PY3:
    import urllib.request as urllib
else:
    import urllib2 as urllib

The import urllib2 could not be resolved.

import plumd

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


class Nginx(plumd.Reader):
    """Plugin to record nginx stub_status metrics."""

    # default config values
    defaults = {
        'poll.interval': 10,
        'url': "/status",    # url nginx stub_status is configured for
        'proto': 'http',     # http/https
        'host': '127.0.0.1',  # Nginx server hostname/ip
        'port': 80,          # Nginx server port
        'timeout': 10
    }

    def __init__(self, log, config):
        """Plugin to record nginx stub_status metrics.

        :param log: A logger
        :type log: logging.RootLogger
        :param config: a plumd.config.Conf configuration helper instance.
        :type config: plumd.config.Conf
        """
        super(Nginx, self).__init__(log, config)
        self.config.defaults(Nginx.defaults)

        # Nginx connection
        proto = self.config.get('proto')
        host = self.config.get('host')
        port = self.config.get('port')
        url = self.config.get('url')
        self.url = "{0}://{1}:{2}{3}".format(proto, host, port, url)
        self.timeout = config.get('timeout')

    def poll(self):
        """Query Nginx for metrics.

        :rtype: ResultSet
        """
        result = plumd.Result("nginx")
        name = self.name
        try:
            ret = urllib.urlopen(self.url, timeout=self.timeout).read()
            if PY3:
                dat = deque(ret.decode('utf8').split("\n"))
            else:
                dat = deque(ret.split("\n"))
            ncons = dat.popleft().split()[-1]
            dat.popleft()
            hnames = ["accepts", "handled", "requests"]
            hmetrics = dict(zip(hnames, dat.popleft().split()))
            rwnames = ["reading", "writing", "waiting"]
            rwmetrics = dict(zip(rwnames, dat.popleft().split()[1::2]))
            mfmt = "{0}.{1}"
            result.add(plumd.Int(mfmt.format(name, "connections"), ncons))
            for key, val in hmetrics.items():
                result.add(plumd.Int(mfmt.format(name, key), val))
            for key, val in rwmetrics.items():
                result.add(plumd.Int(mfmt.format(name, key), val))
        except Exception as exc:

Catching very general exceptions such as Exception is usually not recommended.

            msg = "Nginx: check failed: {0} : {1}".format(self.url, exc)
            self.log.error(msg)
        return plumd.ResultSet([result])