src/collecty/plugins/interface.py

   1 #!/usr/bin/python3
   2 ###############################################################################
   3 #                                                                             #
   4 # collecty - A system statistics collection daemon for IPFire                 #
   5 # Copyright (C) 2012 IPFire development team                                  #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU 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 # This program 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 General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 import os
  23
  24 from .. import util
  25 from . import base
  26
  27 from ..colours import *
  28
  29 class GraphTemplateInterfaceBase(base.GraphTemplate):
  30         @property
  31         def interface(self):
  32                 return self.object.interface
  33
  34
  35 class GraphTemplateInterfaceBits(GraphTemplateInterfaceBase):
  36         name = "interface-bits"
  37
  38         @property
  39         def rrd_graph(self):
  40                 _ = self.locale.translate
  41
  42                 return [
  43                         # Convert everything into bits.
  44                         "CDEF:bits_rx=bytes_rx,8,*",
  45                         "CDEF:bits_tx=bytes_tx,8,*",
  46
  47                         # Compute 95% lines.
  48                         "VDEF:bits_rx_95p=bits_rx,95,PERCENT",
  49                         "VDEF:bits_tx_95p=bits_tx,95,PERCENT",
  50
  51                         # Draw the received area.
  52                         "AREA:bits_rx%s:%-15s" % (lighten(COLOUR_RX, AREA_OPACITY), _("Received")),
  53                         "GPRINT:bits_rx_max:%12s\: " % _("Maximum") + _("%8.2lf %sbps"),
  54                         "GPRINT:bits_rx_min:%12s\: " % _("Minimum") + _("%8.2lf %sbps"),
  55                         "GPRINT:bits_rx_avg:%12s\: " % _("Average") + _("%8.2lf %sbps") + "\\n",
  56
  57                         # Draw the transmitted area.
  58                         "AREA:bits_tx%s:%-15s" % (lighten(COLOUR_TX, AREA_OPACITY), _("Transmitted")),
  59                         "GPRINT:bits_tx_max:%12s\: " % _("Maximum") + _("%8.2lf %sbps"),
  60                         "GPRINT:bits_tx_min:%12s\: " % _("Minimum") + _("%8.2lf %sbps"),
  61                         "GPRINT:bits_tx_avg:%12s\: " % _("Average") + _("%8.2lf %sbps") + "\\n",
  62
  63                         # Draw outlines.
  64                         "LINE1:bits_rx%s" % COLOUR_RX,
  65                         "LINE1:bits_tx%s" % COLOUR_TX,
  66
  67                         # Draw the 95% lines.
  68                         "COMMENT:--- %s ---\\n" % _("95th percentile"),
  69                         "LINE2:bits_rx_95p%s:%-15s" % (COLOUR_RX, _("Received")),
  70                         "GPRINT:bits_rx_95p:%s" % _("%8.2lf %sbps") + "\\n",
  71                         "LINE2:bits_tx_95p%s:%-15s" % (COLOUR_TX, _("Transmitted")),
  72                         "GPRINT:bits_tx_95p:%s" % _("%8.2lf %sbps") + "\\n",
  73                 ]
  74
  75         @property
  76         def graph_title(self):
  77                 _ = self.locale.translate
  78                 return _("Bandwidth usage on %s") % self.interface
  79
  80         @property
  81         def graph_vertical_label(self):
  82                 _ = self.locale.translate
  83                 return _("Bit/s")
  84
  85
  86 class GraphTemplateInterfacePackets(GraphTemplateInterfaceBase):
  87         name = "interface-packets"
  88
  89         @property
  90         def rrd_graph(self):
  91                 _ = self.locale.translate
  92
  93                 return [
  94                         # Draw the received area.
  95                         "AREA:packets_rx%s:%-15s" % (
  96                                 lighten(COLOUR_RX, AREA_OPACITY), _("Received"),
  97                         ),
  98                         "GPRINT:packets_rx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
  99                         "GPRINT:packets_rx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
 100                         "GPRINT:packets_rx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
 101
 102                         # Draw the transmitted area.
 103                         "AREA:packets_tx%s:%-15s" % (
 104                                 lighten(COLOUR_TX, AREA_OPACITY), _("Transmitted"),
 105                         ),
 106                         "GPRINT:packets_tx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
 107                         "GPRINT:packets_tx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
 108                         "GPRINT:packets_tx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
 109
 110                         # Draw outlines of the areas on top.
 111                         "LINE1:packets_rx%s" % COLOUR_RX,
 112                         "LINE1:packets_tx%s" % COLOUR_TX,
 113                 ]
 114
 115         @property
 116         def graph_title(self):
 117                 _ = self.locale.translate
 118                 return _("Transferred packets on %s") % self.interface
 119
 120         @property
 121         def graph_vertical_label(self):
 122                 _ = self.locale.translate
 123                 return _("Packets/s")
 124
 125
 126 class GraphTemplateInterfaceErrors(GraphTemplateInterfaceBase):
 127         name = "interface-errors"
 128
 129         @property
 130         def rrd_graph(self):
 131                 _ = self.locale.translate
 132
 133                 return [
 134                         # Invert the transmitted packets to create upside down graph.
 135                         "CDEF:errors_tx_inv=errors_tx,-1,*",
 136                         "CDEF:dropped_tx_inv=dropped_tx,-1,*",
 137
 138                         # Draw the receive errors.
 139                         "AREA:errors_rx%s:%-15s" % (
 140                                 lighten(COLOUR_RX, AREA_OPACITY), _("Receive errors"),
 141                         ),
 142                         "GPRINT:errors_rx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
 143                         "GPRINT:errors_rx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
 144                         "GPRINT:errors_rx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
 145                         "LINE1:errors_rx%s" % COLOUR_RX,
 146
 147                         # Draw the transmit errors.
 148                         "AREA:errors_tx_inv%s:%-15s" % (
 149                                 lighten(COLOUR_TX, AREA_OPACITY), _("Transmit errors"),
 150                         ),
 151                         "GPRINT:errors_tx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
 152                         "GPRINT:errors_tx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
 153                         "GPRINT:errors_tx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
 154                         "LINE1:errors_tx_inv%s" % COLOUR_TX,
 155
 156                         # Draw the receive drops.
 157                         "LINE2:dropped_rx%s:%-15s" % (
 158                                 lighten(AMBER, AREA_OPACITY), _("Receive drops"),
 159                         ),
 160                         "GPRINT:dropped_rx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
 161                         "GPRINT:dropped_rx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
 162                         "GPRINT:dropped_rx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
 163                         "LINE1:dropped_rx#228B22",
 164
 165                         # Draw the transmit drops.
 166                         "LINE2:dropped_tx%s:%-15s" % (
 167                                 lighten(TEAL, AREA_OPACITY), _("Transmit drops"),
 168                         ),
 169                         "GPRINT:dropped_tx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
 170                         "GPRINT:dropped_tx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
 171                         "GPRINT:dropped_tx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
 172                         "LINE1:dropped_tx%s" % TEAL,
 173
 174                         # Draw the collisions as a line.
 175                         "LINE2:collisions%s:%-15s\l" % (COLOUR_CRITICAL, _("Collisions")),
 176                 ]
 177
 178         @property
 179         def graph_title(self):
 180                 _ = self.locale.translate
 181                 return _("Errors/dropped packets on %s") % self.interface
 182
 183         @property
 184         def graph_vertical_label(self):
 185                 _ = self.locale.translate
 186                 return _("Packets/s")
 187
 188
 189 class InterfaceObject(base.Object):
 190         rrd_schema = [
 191                 "DS:bytes_rx:DERIVE:0:U",
 192                 "DS:bytes_tx:DERIVE:0:U",
 193                 "DS:collisions:DERIVE:0:U",
 194                 "DS:dropped_rx:DERIVE:0:U",
 195                 "DS:dropped_tx:DERIVE:0:U",
 196                 "DS:errors_rx:DERIVE:0:U",
 197                 "DS:errors_tx:DERIVE:0:U",
 198                 "DS:multicast:DERIVE:0:U",
 199                 "DS:packets_rx:DERIVE:0:U",
 200                 "DS:packets_tx:DERIVE:0:U",
 201         ]
 202
 203         def __repr__(self):
 204                 return "<%s %s>" % (self.__class__.__name__, self.interface)
 205
 206         def init(self, interface):
 207                 self.interface = interface
 208
 209         @property
 210         def id(self):
 211                 return self.interface
 212
 213         def collect(self):
 214                 interface_path = os.path.join("/sys/class/net", self.interface)
 215
 216                 # Check if the interface exists.
 217                 if not os.path.exists(interface_path):
 218                         self.log.debug(_("Interface %s does not exists. Cannot collect.") \
 219                                 % self.interface)
 220                         return
 221
 222                 files = (
 223                         "rx_bytes", "tx_bytes",
 224                         "collisions",
 225                         "rx_dropped", "tx_dropped",
 226                         "rx_errors", "tx_errors",
 227                         "multicast",
 228                         "rx_packets", "tx_packets",
 229                 )
 230                 ret = []
 231
 232                 for file in files:
 233                         path = os.path.join(interface_path, "statistics", file)
 234
 235                         ret.append(
 236                                 self.read_file_integer(path),
 237                         )
 238
 239                 return ret
 240
 241
 242 class InterfacePlugin(base.Plugin):
 243         name = "interface"
 244         description = "Interface Statistics Plugin"
 245
 246         templates = [
 247                 GraphTemplateInterfaceBits,
 248                 GraphTemplateInterfacePackets,
 249                 GraphTemplateInterfaceErrors,
 250         ]
 251
 252         interval = 30
 253
 254         @property
 255         def objects(self):
 256                 for interface in util.get_network_interfaces():
 257                         yield InterfaceObject(self, interface=interface)