Issues in glances_network.py - Fixed Issues - Inspection of "version 2.7" - nicolargo/glances - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3dcd25...20576f )

by Nicolas

created 2016-09-10 09:14 UTC

glances/plugins/glances_network.py (2 issues)

Labels

Duplication 2

Severity

Informational 2

# -*- coding: utf-8 -*-
#
# This file is part of Glances.
#
# Copyright (C) 2015 Nicolargo <[email protected]>
#
# Glances is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Glances is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""Network plugin."""

import base64
import operator

from glances.timer import getTimeSinceLastUpdate
from glances.plugins.glances_plugin import GlancesPlugin

import psutil

# SNMP OID
# http://www.net-snmp.org/docs/mibs/interfaces.html
# Dict key = interface_name
snmp_oid = {'default': {'interface_name': '1.3.6.1.2.1.2.2.1.2',
                        'cumulative_rx': '1.3.6.1.2.1.2.2.1.10',
                        'cumulative_tx': '1.3.6.1.2.1.2.2.1.16'}}

# Define the history items list
# All items in this list will be historised if the --enable-history tag is set
# 'color' define the graph color in #RGB format
items_history_list = [{'name': 'rx', 'color': '#00FF00', 'y_unit': 'bit/s'},
                      {'name': 'tx', 'color': '#FF0000', 'y_unit': 'bit/s'}]


class Plugin(GlancesPlugin):

    """Glances network plugin.

    stats is a list
    """

    def __init__(self, args=None):
        """Init the plugin."""
        super(Plugin, self).__init__(args=args, items_history_list=items_history_list)

        # We want to display the stat in the curse interface
        self.display_curse = True

        # Init the stats
        self.reset()

    def get_key(self):
        """Return the key of the list."""
        return 'interface_name'

    def reset(self):
        """Reset/init the stats."""
        self.stats = []

    @GlancesPlugin._log_result_decorator
    def update(self):
        """Update network stats using the input method.

        Stats is a list of dict (one dict per interface)
        """
        # Reset stats
        self.reset()

        if self.input_method == 'local':
            # Update stats using the standard system lib

            # Grab network interface stat using the PsUtil net_io_counter method
            try:
                netiocounters = psutil.net_io_counters(pernic=True)
            except UnicodeDecodeError:
                return self.stats

            # New in PsUtil 3.0: optionaly import the interface's status (issue #765)
            netstatus = {}
            try:
                netstatus = psutil.net_if_stats()
            except AttributeError:
                pass

            # Previous network interface stats are stored in the network_old variable
            if not hasattr(self, 'network_old'):
                # First call, we init the network_old var
                try:
                    self.network_old = netiocounters
                except (IOError, UnboundLocalError):
                    pass
            else:
                # By storing time data we enable Rx/s and Tx/s calculations in the
                # XML/RPC API, which would otherwise be overly difficult work
                # for users of the API
                time_since_update = getTimeSinceLastUpdate('net')

                # Loop over interfaces
                network_new = netiocounters
                for net in network_new:
                    # Do not take hidden interface into account
                    if self.is_hide(net):
                        continue
                    try:
                        cumulative_rx = network_new[net].bytes_recv
                        cumulative_tx = network_new[net].bytes_sent
                        cumulative_cx = cumulative_rx + cumulative_tx
                        rx = cumulative_rx - self.network_old[net].bytes_recv
                        tx = cumulative_tx - self.network_old[net].bytes_sent
                        cx = rx + tx
                        netstat = {
                            'interface_name': net,
                            'time_since_update': time_since_update,
                            'cumulative_rx': cumulative_rx,
                            'rx': rx,
                            'cumulative_tx': cumulative_tx,
                            'tx': tx,
                            'cumulative_cx': cumulative_cx,
                            'cx': cx}
                    except KeyError:
                        continue
                    else:
                        # Optional stats (only compliant with PsUtil 3.0+)
                        try:
                            netstat['is_up'] = netstatus[net].isup
                        except (KeyError, AttributeError):
                            pass
                        # Set the key
                        netstat['key'] = self.get_key()
                        self.stats.append(netstat)

                # Save stats to compute next bitrate
                self.network_old = network_new

        elif self.input_method == 'snmp':
            # Update stats using SNMP

            # SNMP bulk command to get all network interface in one shot
            try:
                netiocounters = self.get_stats_snmp(snmp_oid=snmp_oid[self.short_system_name],
                                                    bulk=True)
            except KeyError:
                netiocounters = self.get_stats_snmp(snmp_oid=snmp_oid['default'],
                                                    bulk=True)

            # Previous network interface stats are stored in the network_old variable
            if not hasattr(self, 'network_old'):
                # First call, we init the network_old var
                try:
                    self.network_old = netiocounters
                except (IOError, UnboundLocalError):
                    pass
            else:
                # See description in the 'local' block
                time_since_update = getTimeSinceLastUpdate('net')

                # Loop over interfaces
                network_new = netiocounters

                for net in network_new:
                    # Do not take hidden interface into account
                    if self.is_hide(net):
                        continue

                    try:
                        # Windows: a tips is needed to convert HEX to TXT
                        # http://blogs.technet.com/b/networking/archive/2009/12/18/how-to-query-the-list-of-network-interfaces-using-snmp-via-the-ifdescr-counter.aspx
                        if self.short_system_name == 'windows':
                            try:
                                interface_name = str(base64.b16decode(net[2:-2].upper()))
                            except TypeError:
                                interface_name = net
                        else:
                            interface_name = net

                        cumulative_rx = float(network_new[net]['cumulative_rx'])
                        cumulative_tx = float(network_new[net]['cumulative_tx'])
                        cumulative_cx = cumulative_rx + cumulative_tx
                        rx = cumulative_rx - float(self.network_old[net]['cumulative_rx'])
                        tx = cumulative_tx - float(self.network_old[net]['cumulative_tx'])
                        cx = rx + tx
                        netstat = {
                            'interface_name': interface_name,
                            'time_since_update': time_since_update,
                            'cumulative_rx': cumulative_rx,
                            'rx': rx,
                            'cumulative_tx': cumulative_tx,
                            'tx': tx,
                            'cumulative_cx': cumulative_cx,
                            'cx': cx}
                    except KeyError:
                        continue
                    else:
                        netstat['key'] = self.get_key()
                        self.stats.append(netstat)

                # Save stats to compute next bitrate
                self.network_old = network_new

        # Update the history list
        self.update_stats_history(self.get_key())

        # Update the view
        self.update_views()

        return self.stats

    def update_views(self):
        """Update stats views."""
        # Call the father's method
        super(Plugin, self).update_views()

        # Add specifics informations
        # Alert
        for i in self.stats:
            ifrealname = i['interface_name'].split(':')[0]
            self.views[i[self.get_key()]]['rx']['decoration'] = self.get_alert(int(i['rx'] // i['time_since_update'] * 8),
                                                                               header=ifrealname + '_rx')
            self.views[i[self.get_key()]]['tx']['decoration'] = self.get_alert(int(i['tx'] // i['time_since_update'] * 8),
                                                                               header=ifrealname + '_tx')

    def msg_curse(self, args=None, max_width=None):
        """Return the dict to display in the curse interface."""
        # Init the return message
        ret = []

        # Only process if stats exist and display plugin enable...
        if not self.stats or args.disable_network:
            return ret

        # Max size for the interface name
        if max_width is not None and max_width >= 23:
            # Interface size name = max_width - space for interfaces bitrate
            ifname_max_width = max_width - 14
        else:
            ifname_max_width = 9

        # Build the string message
        # Header
        msg = '{0:{width}}'.format('NETWORK', width=ifname_max_width)
        ret.append(self.curse_add_line(msg, "TITLE"))
        if args.network_cumul:
            # Cumulative stats
            if args.network_sum:
                # Sum stats
                msg = '{0:>14}'.format('Rx+Tx')
                ret.append(self.curse_add_line(msg))
            else:
                # Rx/Tx stats
                msg = '{0:>7}'.format('Rx')
                ret.append(self.curse_add_line(msg))
                msg = '{0:>7}'.format('Tx')
                ret.append(self.curse_add_line(msg))
        else:
            # Bitrate stats
            if args.network_sum:
                # Sum stats
                msg = '{0:>14}'.format('Rx+Tx/s')
                ret.append(self.curse_add_line(msg))
            else:
                msg = '{0:>7}'.format('Rx/s')
                ret.append(self.curse_add_line(msg))
                msg = '{0:>7}'.format('Tx/s')
                ret.append(self.curse_add_line(msg))
        # Interface list (sorted by name)
        for i in sorted(self.stats, key=operator.itemgetter(self.get_key())):
            # Do not display interface in down state (issue #765)
            if ('is_up' in i) and (i['is_up'] is False):
                continue
            # Format stats
            # Is there an alias for the interface name ?
            ifrealname = i['interface_name'].split(':')[0]
            ifname = self.has_alias(i['interface_name'])
            if ifname is None:
                ifname = ifrealname
            if len(ifname) > ifname_max_width:
                # Cut interface name if it is too long
                ifname = '_' + ifname[-ifname_max_width + 1:]
            if args.byte:
                # Bytes per second (for dummy)
                if args.network_cumul:

                    rx = self.auto_unit(int(i['cumulative_rx']))
                    tx = self.auto_unit(int(i['cumulative_tx']))
                    sx = self.auto_unit(int(i['cumulative_tx']) +
                                        int(i['cumulative_tx']))
                else:
                    rx = self.auto_unit(int(i['rx'] // i['time_since_update']))
                    tx = self.auto_unit(int(i['tx'] // i['time_since_update']))
                    sx = self.auto_unit(int(i['rx'] // i['time_since_update']) +
                                        int(i['tx'] // i['time_since_update']))
            else:
                # Bits per second (for real network administrator | Default)
                if args.network_cumul:

                    rx = self.auto_unit(int(i['cumulative_rx'] * 8)) + "b"
                    tx = self.auto_unit(int(i['cumulative_tx'] * 8)) + "b"
                    sx = self.auto_unit(int(i['cumulative_rx'] * 8) +
                                        int(i['cumulative_tx'] * 8)) + "b"
                else:
                    rx = self.auto_unit(int(i['rx'] // i['time_since_update'] * 8)) + "b"
                    tx = self.auto_unit(int(i['tx'] // i['time_since_update'] * 8)) + "b"
                    sx = self.auto_unit(int(i['rx'] // i['time_since_update'] * 8) +
                                        int(i['tx'] // i['time_since_update'] * 8)) + "b"
            # New line
            ret.append(self.curse_new_line())
            msg = '{0:{width}}'.format(ifname, width=ifname_max_width)
            ret.append(self.curse_add_line(msg))
            if args.network_sum:
                msg = '{0:>14}'.format(sx)
                ret.append(self.curse_add_line(msg))
            else:
                msg = '{0:>7}'.format(rx)
                ret.append(self.curse_add_line(
                    msg, self.get_views(item=i[self.get_key()], key='rx', option='decoration')))
                msg = '{0:>7}'.format(tx)
                ret.append(self.curse_add_line(
                    msg, self.get_views(item=i[self.get_key()], key='tx', option='decoration')))

        return ret


1		# -- coding: utf-8 --
2		#
3		# This file is part of Glances.
4		#
5		# Copyright (C) 2015 Nicolargo <[email protected]>
6		#
7		# Glances is free software; you can redistribute it and/or modify
8		# it under the terms of the GNU Lesser General Public License as published by
9		# the Free Software Foundation, either version 3 of the License, or
10		# (at your option) any later version.
11		#
12		# Glances is distributed in the hope that it will be useful,
13		# but WITHOUT ANY WARRANTY; without even the implied warranty of
14		# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		# GNU Lesser General Public License for more details.
16		#
17		# You should have received a copy of the GNU Lesser General Public License
18		# along with this program. If not, see <http://www.gnu.org/licenses/>.
19
20		"""Network plugin."""
21
22		import base64
23		import operator
24
25		from glances.timer import getTimeSinceLastUpdate
26		from glances.plugins.glances_plugin import GlancesPlugin
27
28		import psutil
29
30		# SNMP OID
31		# http://www.net-snmp.org/docs/mibs/interfaces.html
32		# Dict key = interface_name
33		snmp_oid = {'default': {'interface_name': '1.3.6.1.2.1.2.2.1.2',
34		'cumulative_rx': '1.3.6.1.2.1.2.2.1.10',
35		'cumulative_tx': '1.3.6.1.2.1.2.2.1.16'}}
36
37		# Define the history items list
38		# All items in this list will be historised if the --enable-history tag is set
39		# 'color' define the graph color in #RGB format
40		items_history_list = [{'name': 'rx', 'color': '#00FF00', 'y_unit': 'bit/s'},
41		{'name': 'tx', 'color': '#FF0000', 'y_unit': 'bit/s'}]
42
43
44		class Plugin(GlancesPlugin):
45
46		"""Glances network plugin.
47
48		stats is a list
49		"""
50
51		def __init__(self, args=None):
52		"""Init the plugin."""
53		super(Plugin, self).__init__(args=args, items_history_list=items_history_list)
54
55		# We want to display the stat in the curse interface
56		self.display_curse = True
57
58		# Init the stats
59		self.reset()
60
61		def get_key(self):
62		"""Return the key of the list."""
63		return 'interface_name'
64
65		def reset(self):
66		"""Reset/init the stats."""
67		self.stats = []
68
69		@GlancesPlugin._log_result_decorator
70		def update(self):
71		"""Update network stats using the input method.
72
73		Stats is a list of dict (one dict per interface)
74		"""
75		# Reset stats
76		self.reset()
77
78		if self.input_method == 'local':
79		# Update stats using the standard system lib
80
81		# Grab network interface stat using the PsUtil net_io_counter method
82		try:
83		netiocounters = psutil.net_io_counters(pernic=True)
84		except UnicodeDecodeError:
85		return self.stats
86
87		# New in PsUtil 3.0: optionaly import the interface's status (issue #765)
88		netstatus = {}
89		try:
90		netstatus = psutil.net_if_stats()
91		except AttributeError:
92		pass
93
94		# Previous network interface stats are stored in the network_old variable
95		if not hasattr(self, 'network_old'):
96		# First call, we init the network_old var
97		try:
98		self.network_old = netiocounters
99		except (IOError, UnboundLocalError):
100		pass
101		else:
102		# By storing time data we enable Rx/s and Tx/s calculations in the
103		# XML/RPC API, which would otherwise be overly difficult work
104		# for users of the API
105		time_since_update = getTimeSinceLastUpdate('net')
106
107		# Loop over interfaces
108		network_new = netiocounters
109		for net in network_new:
110		# Do not take hidden interface into account
111		if self.is_hide(net):
112		continue
113		try:
114		cumulative_rx = network_new[net].bytes_recv
115		cumulative_tx = network_new[net].bytes_sent
116		cumulative_cx = cumulative_rx + cumulative_tx
117		rx = cumulative_rx - self.network_old[net].bytes_recv
118		tx = cumulative_tx - self.network_old[net].bytes_sent
119		cx = rx + tx
120		netstat = {
121		'interface_name': net,
122		'time_since_update': time_since_update,
123		'cumulative_rx': cumulative_rx,
124		'rx': rx,
125		'cumulative_tx': cumulative_tx,
126		'tx': tx,
127		'cumulative_cx': cumulative_cx,
128		'cx': cx}
129		except KeyError:
130		continue
131		else:
132		# Optional stats (only compliant with PsUtil 3.0+)
133		try:
134		netstat['is_up'] = netstatus[net].isup
135		except (KeyError, AttributeError):
136		pass
137		# Set the key
138		netstat['key'] = self.get_key()
139		self.stats.append(netstat)
140
141		# Save stats to compute next bitrate
142		self.network_old = network_new
143
144		elif self.input_method == 'snmp':
145		# Update stats using SNMP
146
147		# SNMP bulk command to get all network interface in one shot
148		try:
149		netiocounters = self.get_stats_snmp(snmp_oid=snmp_oid[self.short_system_name],
150		bulk=True)
151		except KeyError:
152		netiocounters = self.get_stats_snmp(snmp_oid=snmp_oid['default'],
153		bulk=True)
154
155		# Previous network interface stats are stored in the network_old variable
156		if not hasattr(self, 'network_old'):
157		# First call, we init the network_old var
158		try:
159		self.network_old = netiocounters
160		except (IOError, UnboundLocalError):
161		pass
162		else:
163		# See description in the 'local' block
164		time_since_update = getTimeSinceLastUpdate('net')
165
166		# Loop over interfaces
167		network_new = netiocounters
168
169		for net in network_new:
170		# Do not take hidden interface into account
171		if self.is_hide(net):
172		continue
173
174		try:
175		# Windows: a tips is needed to convert HEX to TXT
176		# http://blogs.technet.com/b/networking/archive/2009/12/18/how-to-query-the-list-of-network-interfaces-using-snmp-via-the-ifdescr-counter.aspx
177		if self.short_system_name == 'windows':
178		try:
179		interface_name = str(base64.b16decode(net[2:-2].upper()))
180		except TypeError:
181		interface_name = net
182		else:
183		interface_name = net
184
185		cumulative_rx = float(network_new[net]['cumulative_rx'])
186		cumulative_tx = float(network_new[net]['cumulative_tx'])
187		cumulative_cx = cumulative_rx + cumulative_tx
188		rx = cumulative_rx - float(self.network_old[net]['cumulative_rx'])
189		tx = cumulative_tx - float(self.network_old[net]['cumulative_tx'])
190		cx = rx + tx
191		netstat = {
192		'interface_name': interface_name,
193		'time_since_update': time_since_update,
194		'cumulative_rx': cumulative_rx,
195		'rx': rx,
196		'cumulative_tx': cumulative_tx,
197		'tx': tx,
198		'cumulative_cx': cumulative_cx,
199		'cx': cx}
200		except KeyError:
201		continue
202		else:
203		netstat['key'] = self.get_key()
204		self.stats.append(netstat)
205
206		# Save stats to compute next bitrate
207		self.network_old = network_new
208
209		# Update the history list
210		self.update_stats_history(self.get_key())
211
212		# Update the view
213		self.update_views()
214
215		return self.stats
216
217	View Code Duplication	def update_views(self):
218		"""Update stats views."""
219		# Call the father's method
220		super(Plugin, self).update_views()
221
222		# Add specifics informations
223		# Alert
224		for i in self.stats:
225		ifrealname = i['interface_name'].split(':')[0]
226		self.views[i[self.get_key()]]['rx']['decoration'] = self.get_alert(int(i['rx'] // i['time_since_update'] * 8),
227		header=ifrealname + '_rx')
228		self.views[i[self.get_key()]]['tx']['decoration'] = self.get_alert(int(i['tx'] // i['time_since_update'] * 8),
229		header=ifrealname + '_tx')
230
231		def msg_curse(self, args=None, max_width=None):
232		"""Return the dict to display in the curse interface."""
233		# Init the return message
234		ret = []
235
236		# Only process if stats exist and display plugin enable...
237		if not self.stats or args.disable_network:
238		return ret
239
240		# Max size for the interface name
241		if max_width is not None and max_width >= 23:
242		# Interface size name = max_width - space for interfaces bitrate
243		ifname_max_width = max_width - 14
244		else:
245		ifname_max_width = 9
246
247		# Build the string message
248		# Header
249		msg = '{0:{width}}'.format('NETWORK', width=ifname_max_width)
250		ret.append(self.curse_add_line(msg, "TITLE"))
251		if args.network_cumul:
252		# Cumulative stats
253		if args.network_sum:
254		# Sum stats
255		msg = '{0:>14}'.format('Rx+Tx')
256		ret.append(self.curse_add_line(msg))
257		else:
258		# Rx/Tx stats
259		msg = '{0:>7}'.format('Rx')
260		ret.append(self.curse_add_line(msg))
261		msg = '{0:>7}'.format('Tx')
262		ret.append(self.curse_add_line(msg))
263		else:
264		# Bitrate stats
265		if args.network_sum:
266		# Sum stats
267		msg = '{0:>14}'.format('Rx+Tx/s')
268		ret.append(self.curse_add_line(msg))
269		else:
270		msg = '{0:>7}'.format('Rx/s')
271		ret.append(self.curse_add_line(msg))
272		msg = '{0:>7}'.format('Tx/s')
273		ret.append(self.curse_add_line(msg))
274		# Interface list (sorted by name)
275		for i in sorted(self.stats, key=operator.itemgetter(self.get_key())):
276		# Do not display interface in down state (issue #765)
277		if ('is_up' in i) and (i['is_up'] is False):
278		continue
279		# Format stats
280		# Is there an alias for the interface name ?
281		ifrealname = i['interface_name'].split(':')[0]
282		ifname = self.has_alias(i['interface_name'])
283		if ifname is None:
284		ifname = ifrealname
285		if len(ifname) > ifname_max_width:
286		# Cut interface name if it is too long
287		ifname = '_' + ifname[-ifname_max_width + 1:]
288		if args.byte:
289		# Bytes per second (for dummy)
290	View Code Duplication	if args.network_cumul:
		0 ignored issues – show Duplication introduced 2016-04-28 14:46 UTC by Report Bug Copy Issue Report Show Similar Issues like this This code seems to be duplicated in your project. Loading history...
291		rx = self.auto_unit(int(i['cumulative_rx']))
292		tx = self.auto_unit(int(i['cumulative_tx']))
293		sx = self.auto_unit(int(i['cumulative_tx']) +
294		int(i['cumulative_tx']))
295		else:
296		rx = self.auto_unit(int(i['rx'] // i['time_since_update']))
297		tx = self.auto_unit(int(i['tx'] // i['time_since_update']))
298		sx = self.auto_unit(int(i['rx'] // i['time_since_update']) +
299		int(i['tx'] // i['time_since_update']))
300		else:
301		# Bits per second (for real network administrator \| Default)
302	View Code Duplication	if args.network_cumul:
		0 ignored issues – show Duplication introduced 2016-04-28 14:46 UTC by Report Bug Copy Issue Report Show Similar Issues like this This code seems to be duplicated in your project. Loading history...
303		rx = self.auto_unit(int(i['cumulative_rx'] * 8)) + "b"
304		tx = self.auto_unit(int(i['cumulative_tx'] * 8)) + "b"
305		sx = self.auto_unit(int(i['cumulative_rx'] * 8) +
306		int(i['cumulative_tx'] * 8)) + "b"
307		else:
308		rx = self.auto_unit(int(i['rx'] // i['time_since_update'] * 8)) + "b"
309		tx = self.auto_unit(int(i['tx'] // i['time_since_update'] * 8)) + "b"
310		sx = self.auto_unit(int(i['rx'] // i['time_since_update'] * 8) +
311		int(i['tx'] // i['time_since_update'] * 8)) + "b"
312		# New line
313		ret.append(self.curse_new_line())
314		msg = '{0:{width}}'.format(ifname, width=ifname_max_width)
315		ret.append(self.curse_add_line(msg))
316		if args.network_sum:
317		msg = '{0:>14}'.format(sx)
318		ret.append(self.curse_add_line(msg))
319		else:
320		msg = '{0:>7}'.format(rx)
321		ret.append(self.curse_add_line(
322		msg, self.get_views(item=i[self.get_key()], key='rx', option='decoration')))
323		msg = '{0:>7}'.format(tx)
324		ret.append(self.curse_add_line(
325		msg, self.get_views(item=i[self.get_key()], key='tx', option='decoration')))
326
327		return ret
328

nicolargo / glances

Push — master ( 3dcd25...20576f )

glances/plugins/glances_network.py (2 issues)

Labels

Severity

Introduced By

Duplication Side-by-Side

Filter issues like